raf/neovim-flake
1
0
Fork 0
mirror of https://github.com/NotAShelf/neovim-flake.git synced 2024-11-09 22:55:58 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: streamline manpages

Browse source
This commit is contained in:
NotAShelf 2023-02-06 19:16:25 +03:00
parent be3e7633e9
commit ca88e67b8f
No known key found for this signature in database
GPG key ID: 5B5C8895F28445F1
3 changed files with 29 additions and 59 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
docs/man-configuration.xml
View file

@ -2,41 +2,19 @@
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude">
<refmeta>
<refentrytitle>neovim-flake configuration</refentrytitle>
<refentrytitle><filename>neovim-flake</filename></refentrytitle>
<manvolnum>5</manvolnum>
<refmiscinfo class="source">neovim-flake</refmiscinfo>
<!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> -->
<refmiscinfo class="source">Neovim Flake</refmiscinfo>
</refmeta>
<refnamediv>
<refname>neovim configuration</refname>
<refpurpose>neovim-flake configuration specification</refpurpose>
<refname><filename>neovim-flake</filename></refname>
<refpurpose>Neovim Flake f - Configuration specification</refpurpose>
</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>
<title>Options</title>
<para>
You can use the following options in your neovim configuration.
You can use the following options in the `programs.neovim-flake` module:
</para>
<xi:include href="./nmd-result/neovim-flake-options.xml"/>
<xi:include href="./nmd-result/neovim-flake-options.xml" />
</refsection>
</refentry>
</refentry>

22
docs/man-pages.xml
View file

@ -1,13 +1,15 @@
<reference xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude">
<title>neovim-flake Reference Pages</title>
<info>
<author><personname>neovim-flake contributors</personname></author>
<copyright>
<year>2021–2023</year>
<holder>neovim-flake contributors</holder>
</copyright>
</info>
<xi:include href="man-configuration.xml" />
</reference>
<title>Neovim Flake - Reference Pages</title>
<info>
<author>
<personname>Gabriel Volpe</personname>
</author>
<copyright>
<year>2023</year>
<holder>NotAShelf</holder>
</copyright>
</info>
<xi:include href="man-configuration.xml" />
</reference>

30
docs/manual.xml
View file

@ -3,23 +3,13 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
version="5.0"
xml:id="book-neovim-flake-manual">
<info>
<title>neovim-flake Manual</title>
</info>
<preface>
<title>Preface</title>
<para>
If your problem is caused by a bug in neovim-flake then it should be reported on the
<link xlink:href="https://github.com/notashelf/neovim-flake/issues">neovim-flake issue tracker</link>.
</para>
</preface>
<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>
<info>
<title>Neovim Flake by Gabriel Volpe</title>
</info>
<xi:include href="try-it-out.xml" />
<xi:include href="hm-module.xml" />
<appendix xml:id="ch-options">
<title>Configuration options</title>
<xi:include href="./nmd-result/neovim-flake-options.xml" />
</appendix>
</book>