nix-community.nixvim/docs/manual.xml

<book xmlns="http://docbook.org/ns/docbook"
  xmlns:xlink="http://www.w3.org/1999/xlink"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  version="5.0"
  xml:id="book-home-manager-manual">
  <info>
    <title>NixVim Manual</title>
  </info>
  <preface>
    <title>Preface</title>
    <para>
      This manual is meant to serve as the ultimate reference for how to use and install NixVim.
    </para>
    <para>
      If you have any issues, questions, or plugin suggestions please open an issue on the
      <link xlink:href="https://github.com/pta2002/nixvim">NixVim GitHub</link>
    </para>
  </preface>
  <appendix xml:id="ch-options">
    <title>Configuration Options</title>
    <xi:include href="./nmd-result/nixvim-options.xml" />
  </appendix>
</book>
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-10 19:50:13 +00:00			`<book xmlns="http://docbook.org/ns/docbook"`
			`xmlns:xlink="http://www.w3.org/1999/xlink"`
			`xmlns:xi="http://www.w3.org/2001/XInclude"`
			`version="5.0"`
			`xml:id="book-home-manager-manual">`
			`<info>`
			`<title>NixVim Manual</title>`
			`</info>`
			`<preface>`
			`<title>Preface</title>`
			`<para>`
			`This manual is meant to serve as the ultimate reference for how to use and install NixVim.`
			`</para>`
			`<para>`
			`If you have any issues, questions, or plugin suggestions please open an issue on the`
			`<link xlink:href="https://github.com/pta2002/nixvim">NixVim GitHub</link>`
			`</para>`
			`</preface>`
			`<appendix xml:id="ch-options">`
			`<title>Configuration Options</title>`
			`<xi:include href="./nmd-result/nixvim-options.xml" />`
			`</appendix>`
			`</book>`