NotAShelf/nvf
1
0
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2024-11-22 21:30:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: fix build failures

Browse source
This commit is contained in:
raf 2023-10-01 16:58:05 +03:00
parent f432a364f1
commit c223d49274
No known key found for this signature in database
GPG key ID: 02D1DD3FA08B6B29
3 changed files with 20 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/man-configuration.xml
View file

@ -14,26 +14,31 @@
<refsection> <refsection>
<title>Description</title> <title>Description</title>
<para> <para>
Custom configuration is done with the neovim-flake.lib.neovimConfiguration if home-manager module is not in use. Custom configuration is done with the neovim-flake.lib.neovimConfiguration if home-manager module is not in use.
It takes in the configuration as a module. It takes in the configuration as a module.
<programlisting> <programlisting>
neovim-flake.lib.neovimConfiguration { neovim-flake.lib.neovimConfiguration {
inherit pkgs; inherit pkgs;
modules = [{config = xxx;}]; modules = [{config = xxx;}];
}; };
</programlisting> </programlisting>
The output of the configuration function is an attrset. The output of the configuration function is an attrset.
</para> </para>
<programlisting> <para>
In case of the home-manager module, all options will be available under programs.neovim-flake once the module has
been imported from the flake inputs.
<programlisting>
{ {
options = "The options that were available to configure"; options = "The options that were available to configure";
config = "The outputted configuration"; config = "The outputted configuration";
pkgs = "The package set used to evaluate the module"; pkgs = "The package set used to evaluate the module";
neovim = "The built neovim package"; neovim = "The built neovim package";
} }
</programlisting> </programlisting>
In case of the home-manager module, all options will be available under programs.neovim-flake once the module has </para>
been imported from the flake inputs.
</refsection> </refsection>
<refsection> <refsection>
<title>Options</title> <title>Options</title>

10
docs/manual.xml
View file

@ -7,12 +7,12 @@
<title>neovim-flake Manual</title> <title>neovim-flake Manual</title>
</info> </info>
<preface> <preface>
<title>Preface</title> <title>Preface</title>
<para> <para>
If you believe your problem is caused by a bug in neovim-flake then please consider reporting it over If you believe your problem is caused by a bug in neovim-flake then please consider reporting it over
<link xlink:href="https://github.com/notashelf/neovim-flake/issues">the neovim-flake issue tracker</link>. <link xlink:href="tps://github.com/notashelf/neovim-flake/issues">the neovim-flake issue tracker</link>.
Bugfixes, feature additions and upstream changes are welcome over Bugfixes, feature additions and upstream changes are welcome over
<link xlink:href="https://github.com/notashelf/neovim-flake/pulls">the neovim-flake pull requests tab</link>. <link xlink:href="https://github.com/notashelf/neovim-flake/pulls">the neovim-flake pull requests tab</link>.
</para> </para>
</preface> </preface>
<xi:include href="manual/try-it-out.xml"/> <xi:include href="manual/try-it-out.xml"/>

8
docs/release-notes/rl-0.5.adoc
View file

@ -31,17 +31,17 @@ https://github.com/yavko[yavko]:
https://github.com/FrothyMarrow[frothymarrow]: https://github.com/FrothyMarrow[frothymarrow]:
* Renamed `vim.visuals.cursorWordline` to <<opt-vim.visuals.cursorline>>. * Renamed `vim.visuals.cursorWordline` to <<opt-vim.visuals.cursorline.enable>>.
* Added <<opt-vim.visuals.cursorline.lineNumbersOnly>> to display cursorline only in the presence of line numbers. * Added <<opt-vim.visuals.cursorline.lineNumbersOnly>> to display cursorline only in the presence of line numbers.
https://github.com/notashelf[notashelf]: https://github.com/notashelf[notashelf]:
* Added GitHub Copilot to completion sources. * Added GitHub Copilot to nvim-cmp completion sources.
* Added <<opt-vim.ui.borders>> for global and individual plugin border configuration. * Added <<opt-vim.ui.borders.enable>> for global and individual plugin border configuration.
* LSP integrated breadcrumbs with <<opt-vim.ui.breadcrumbs>> through nvim-navic * LSP integrated breadcrumbs with <<opt-vim.ui.breadcrumbs.enable>> through nvim-navic
* LSP navigation helper with nvim-navbuddy, depends on nvim-navic (automatically enabled) * LSP navigation helper with nvim-navbuddy, depends on nvim-navic (automatically enabled)