diff --git a/docs/man-configuration.xml b/docs/man-configuration.xml index 72b61447..c39a7293 100644 --- a/docs/man-configuration.xml +++ b/docs/man-configuration.xml @@ -2,19 +2,41 @@ xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> - neovim-flake + neovim-flake configuration 5 - Neovim Flake + neovim-flake + - neovim-flake - Neovim Flake f - Configuration specification + neovim configuration + neovim-flake configuration specification + + Description + + Custom configuration is done with the neovim-flake.lib.neovimConfiguration function. It takes in the configuration as a module. + + neovim-flake.lib.neovimConfiguration { + inherit pkgs; + modules = [{config = xxx;}]; + }; + + The output of the configuration function is an attrset. + + + { + 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"; + } + + Options - You can use the following options in the `programs.neovim-flake` module: + You can use the following options in your neovim configuration. - + - + \ No newline at end of file diff --git a/docs/man-pages.xml b/docs/man-pages.xml index 001d5175..a89a8e8b 100644 --- a/docs/man-pages.xml +++ b/docs/man-pages.xml @@ -1,15 +1,13 @@ - Neovim Flake - Reference Pages - - - Gabriel Volpe - - - 2023 - NotAShelf - - - - + neovim-flake Reference Pages + + neovim-flake contributors + + 2021–2023 + neovim-flake contributors + + + + \ No newline at end of file diff --git a/docs/manual.xml b/docs/manual.xml index 235c953f..57ec8ac6 100644 --- a/docs/manual.xml +++ b/docs/manual.xml @@ -3,13 +3,23 @@ xmlns:xi="http://www.w3.org/2001/XInclude" version="5.0" xml:id="book-neovim-flake-manual"> - - Neovim Flake by Gabriel Volpe - - - - - Configuration options - - - + + neovim-flake Manual + + + Preface + + If your problem is caused by a bug in neovim-flake then it should be reported on the + neovim-flake issue tracker. + + + + + + + + Configuration Options + + + + \ No newline at end of file