mirror of
https://github.com/NotAShelf/nvf.git
synced 2024-11-01 19:11:15 +00:00
docs: streamline manpages
This commit is contained in:
parent
be3e7633e9
commit
ca88e67b8f
3 changed files with 29 additions and 59 deletions
|
@ -2,41 +2,19 @@
|
||||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||||
xmlns:xi="http://www.w3.org/2001/XInclude">
|
xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||||
<refmeta>
|
<refmeta>
|
||||||
<refentrytitle>neovim-flake configuration</refentrytitle>
|
<refentrytitle><filename>neovim-flake</filename></refentrytitle>
|
||||||
<manvolnum>5</manvolnum>
|
<manvolnum>5</manvolnum>
|
||||||
<refmiscinfo class="source">neovim-flake</refmiscinfo>
|
<refmiscinfo class="source">Neovim Flake</refmiscinfo>
|
||||||
<!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> -->
|
|
||||||
</refmeta>
|
</refmeta>
|
||||||
<refnamediv>
|
<refnamediv>
|
||||||
<refname>neovim configuration</refname>
|
<refname><filename>neovim-flake</filename></refname>
|
||||||
<refpurpose>neovim-flake configuration specification</refpurpose>
|
<refpurpose>Neovim Flake f - Configuration specification</refpurpose>
|
||||||
</refnamediv>
|
</refnamediv>
|
||||||
<refsection>
|
|
||||||
<title>Description</title>
|
|
||||||
<para>
|
|
||||||
Custom configuration is done with the neovim-flake.lib.neovimConfiguration function. It takes in the configuration as a module.
|
|
||||||
<programlisting>
|
|
||||||
neovim-flake.lib.neovimConfiguration {
|
|
||||||
inherit pkgs;
|
|
||||||
modules = [{config = xxx;}];
|
|
||||||
};
|
|
||||||
</programlisting>
|
|
||||||
The output of the configuration function is an attrset.
|
|
||||||
</para>
|
|
||||||
<programlisting>
|
|
||||||
{
|
|
||||||
options = "The options that were available to configure";
|
|
||||||
config = "The outputted configuration";
|
|
||||||
pkgs = "The package set used to evaluate the module";
|
|
||||||
neovim = "The built neovim package";
|
|
||||||
}
|
|
||||||
</programlisting>
|
|
||||||
</refsection>
|
|
||||||
<refsection>
|
<refsection>
|
||||||
<title>Options</title>
|
<title>Options</title>
|
||||||
<para>
|
<para>
|
||||||
You can use the following options in your neovim configuration.
|
You can use the following options in the `programs.neovim-flake` module:
|
||||||
</para>
|
</para>
|
||||||
<xi:include href="./nmd-result/neovim-flake-options.xml"/>
|
<xi:include href="./nmd-result/neovim-flake-options.xml" />
|
||||||
</refsection>
|
</refsection>
|
||||||
</refentry>
|
</refentry>
|
||||||
|
|
|
@ -1,13 +1,15 @@
|
||||||
<reference xmlns="http://docbook.org/ns/docbook"
|
<reference xmlns="http://docbook.org/ns/docbook"
|
||||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||||
xmlns:xi="http://www.w3.org/2001/XInclude">
|
xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||||
<title>neovim-flake Reference Pages</title>
|
<title>Neovim Flake - Reference Pages</title>
|
||||||
<info>
|
<info>
|
||||||
<author><personname>neovim-flake contributors</personname></author>
|
<author>
|
||||||
<copyright>
|
<personname>Gabriel Volpe</personname>
|
||||||
<year>2021–2023</year>
|
</author>
|
||||||
<holder>neovim-flake contributors</holder>
|
<copyright>
|
||||||
</copyright>
|
<year>2023</year>
|
||||||
</info>
|
<holder>NotAShelf</holder>
|
||||||
<xi:include href="man-configuration.xml" />
|
</copyright>
|
||||||
</reference>
|
</info>
|
||||||
|
<xi:include href="man-configuration.xml" />
|
||||||
|
</reference>
|
||||||
|
|
|
@ -3,23 +3,13 @@
|
||||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||||
version="5.0"
|
version="5.0"
|
||||||
xml:id="book-neovim-flake-manual">
|
xml:id="book-neovim-flake-manual">
|
||||||
<info>
|
<info>
|
||||||
<title>neovim-flake Manual</title>
|
<title>Neovim Flake by Gabriel Volpe</title>
|
||||||
</info>
|
</info>
|
||||||
<preface>
|
<xi:include href="try-it-out.xml" />
|
||||||
<title>Preface</title>
|
<xi:include href="hm-module.xml" />
|
||||||
<para>
|
<appendix xml:id="ch-options">
|
||||||
If your problem is caused by a bug in neovim-flake then it should be reported on the
|
<title>Configuration options</title>
|
||||||
<link xlink:href="https://github.com/notashelf/neovim-flake/issues">neovim-flake issue tracker</link>.
|
<xi:include href="./nmd-result/neovim-flake-options.xml" />
|
||||||
</para>
|
</appendix>
|
||||||
</preface>
|
</book>
|
||||||
<xi:include href="default-configs.xml"/>
|
|
||||||
<xi:include href="custom-configs.xml"/>
|
|
||||||
<xi:include href="languages.xml"/>
|
|
||||||
<xi:include href="plugins.xml"/>
|
|
||||||
<appendix xml:id="ch-options">
|
|
||||||
<title>Configuration Options</title>
|
|
||||||
<xi:include href="./nmd-result/neovim-flake-options.xml" />
|
|
||||||
</appendix>
|
|
||||||
<xi:include href="./release-notes/release-notes.xml" />
|
|
||||||
</book>
|
|
||||||
|
|
Loading…
Reference in a new issue