18 Commits
Author SHA1 Message Date
Matt Sturgeon c7ccb896eb docs/man: simplify using structuredAttrs
Verified the output does not change:

$ nix build .#man-docs github:nix-community/nixvim#man-docs

$ sha256sum result{,-1}/share/man/man5/nixvim.5.gz
63177f4e1bff6db2ef01dfdb31c0674342ba9d9d27fe8e3d392bf86131fbc867  result/share/man/man5/nixvim.5.gz
63177f4e1bff6db2ef01dfdb31c0674342ba9d9d27fe8e3d392bf86131fbc867  result-1/share/man/man5/nixvim.5.gz
2026-06-22 20:38:34 +00:00
ethanbodzioneyandGaétan Lepage 37e43d8003 Fix manpages name 2026-04-10 07:12:07 +00:00
saygo-pngandMatt Sturgeon 03a51dbf3d treewide: NixVim/nixvim -> Nixvim
Signed-off-by: saygo-png <saygo.mail@proton.me>
2025-12-04 23:22:21 +00:00
Axel KarjalainenandMatt Sturgeon 4c4cac6445 docs: use official names of NixOS, Home Manager and nix-darwin 2025-10-18 00:05:26 +00:00
Matt Sturgeon 4414d8aa14 docs/modules: init
Modules to represent pages in the docs
2025-09-30 16:21:23 +00:00
Gaetan LepageandGaétan Lepage 8529f1c86b treewide: format with new treefmt 2025-07-25 16:18:00 +00:00
Matt Sturgeon 0f8dc108de docs/man: move FAQ and examples before functions
Like options, function docs are large. Let's put them after the FAQ and
config-examples sections
2025-05-19 00:20:29 +01:00
Matt Sturgeon 83d3535097 docs/man: include all sections from lib-doc 2025-05-19 00:20:29 +01:00
Matt Sturgeon 0c7e2aa96b docs: user-guide/helpers.mdlib/index.md
Move the user-guide to the new lib reference docs.

Added a MDBook redirect entry.

Updated man docs.
2025-05-19 00:19:57 +01:00
Matt Sturgeon 61c44d7a7f docs/man: minor cleanup
- Move lua filter to separate file
- Use a subshell to write `nixvim-header.5`
- Use bash function to avoid repetition
2025-05-17 03:30:13 +01:00
Gaetan LepageandGaétan Lepage 25338942a7 docs/user-guide: add configuration examples 2024-05-30 21:32:42 +02:00
traxys 62f32bfc71 treewide: Reformat with nixfmt 2024-05-05 22:00:40 +02:00
Matt SturgeonandGaétan Lepage 87df94dcbd docs: Move standalone usage to modules section 2024-04-01 15:08:36 +02:00
traxysandGitHub 9cd3721adf standalone: Allow to extend a standalone derivation with a new module (#1142)
This adds the `nixvimExtend` attribute to the generated standalone
derivation, this attribute takes a module as an argument and returns a
new standalone derivation with the initial module & the extended module
merged together.
2024-02-22 08:22:21 +01:00
traxysandGitHub ad8aa72490 docs: Introduce an user guide (#1121) 2024-02-18 15:56:18 +01:00
traxysandGitHub 375453feff docs: Add a short sections on helpers (#1093) 2024-02-14 23:38:26 +01:00
Gabriel ArazasandGitHub 0b5800a2a2 docs: clean up descriptions (#1061) 2024-02-11 13:51:34 +01:00
traxysandGitHub 29225c2797 docs: Correctly generate documentation for types either a (submodule ...) (#929)
This requires pulling quite a lot of code from nixpkgs in order to
make the `either` type work correctly, the effects can be seen for
example in the documentation of `ollama.promps` and `ollama.actions`
2024-01-12 23:22:03 +01:00