Commit graph

9 commits

Author SHA1 Message Date
traxys
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
wolbyte
6efbb5353c docs: terminate build on shell-script error 2023-09-09 17:51:52 +02:00
wolbyte
26b202828f docs: remove whitespaces from filepaths if any 2023-08-30 15:36:44 +02:00
wolbyte
1cc77f4252 docs: ignore option aliases 2023-08-24 13:30:35 +02:00
Wolbyte
ecd593386f
docs: New documentation using mdbook (#471)
* docs: mdbook init

* Separate sub-options into their section

* docs: enable fold

* docs: merge core options into a single section

* doc generation: fix submodules index pages

* docs: add contributing section

* docs: rename 'core' group to 'Neovim Options'

docs: removed the index pages of empty sections

docs: remove obsolete 'mergeFunctionResults' function

* docs: use nix syntax highlighting

* docs: point to the new repo url

* docs: use recursive generation
docs: split submodules into subsections

* docs: fix contributing separator
docs: fix missing submodules docs
2023-08-07 11:48:01 +02:00
Pedro Alves
dd9ec124a2 docs: fix documentation generation 2022-12-29 17:34:54 +00:00
Pedro Alves
4ddd3969e5
nixvim: support standalone nixvim
This represents a major rearchitecture for nixvim, so I'm leaving this up to track the progress for now, and to serve as a reference for any breaking changes during transition.

The main change is, of course, being able to use nixvim standalone. To do this, you should use the new build function, which takes in two arguments: the system architecture (e.g. x86_64-linux) and the configuration. For the new configuration, do not use the programs.nixvim. prefix.

For module development, the main change is that you should no longer prefix your modules with programs.nixvim..
2022-09-18 11:19:23 +01:00
Pedro Alves
929659b7a1 airline: complete documentation 2022-01-12 12:42:12 +00:00
Pedro Alves
eef84178ab docs: Add basic documentation system based on nmd
You can now run `nix build '.#docs'` to build HTML documentation
documenting every single option on nixvim! Fortunately, thanks to
the 'description' field, most options are already documented, but
there are still a fair few that need documenting.

I will be taking care of those in the next few days. When those are
done, I will find a way to automatically rebuild documentation on every
repo push, and also add a PR hook requiring documentation.

Additionally, I will try to find a way to have per-page plugin docs.
2022-01-12 01:44:51 +00:00