mirror of
https://github.com/nix-community/nixvim.git
synced 2025-08-04 01:55:11 +02:00
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.
This commit is contained in:
parent
69cf1b6204
commit
eef84178ab
42 changed files with 184 additions and 51 deletions
11
docs/man-pages.xml
Normal file
11
docs/man-pages.xml
Normal file
|
@ -0,0 +1,11 @@
|
|||
<reference xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<title>NixVim Reference Pages</title>
|
||||
<info>
|
||||
<author><personname>NixVim contributors</personname></author>
|
||||
<copyright><year>2021-2022</year><holder>NixVim contributors</holder>
|
||||
</copyright>
|
||||
</info>
|
||||
<xi:include href="man-nixvim.xml" />
|
||||
</reference>
|
Loading…
Add table
Add a link
Reference in a new issue