raf/neovim-flake
1
0
Fork 0
mirror of https://github.com/NotAShelf/neovim-flake.git synced 2024-12-19 08:39:50 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: document custom package usage

Browse source
This commit is contained in:
NotAShelf 2023-08-02 09:53:07 +03:00
parent fcaed357f4
commit c9509d5b09
No known key found for this signature in database
GPG key ID: 02D1DD3FA08B6B29
3 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/manual.xml
View file

@ -20,6 +20,7 @@
<xi:include href="manual/default-configs.xml"/> <xi:include href="manual/default-configs.xml"/>
<xi:include href="manual/custom-configs.xml"/> <xi:include href="manual/custom-configs.xml"/>
<xi:include href="manual/custom-plugins.xml"/> <xi:include href="manual/custom-plugins.xml"/>
<xi:include href="manual/custom-package.xml"/>
<xi:include href="manual/home-manager.xml"/> <xi:include href="manual/home-manager.xml"/>
<xi:include href="manual/languages.xml"/> <xi:include href="manual/languages.xml"/>
<appendix xml:id="ch-options"> <appendix xml:id="ch-options">

14
docs/manual/custom-package.adoc Normal file
View file

@ -0,0 +1,14 @@
[[ch-custom-package]]
== Custom Neovim Package
As of v0.5, you may now specify the neovim package that will be wrapped with your configuration. This is done with the `vim.package` option.
[source,nix]
----
{inputs, pkgs, ...}: {
# using the neovim-nightly overlay
config.vim.package = inputs.neovim-overlay.packages.${pkgs.system}.neovim;
}
----
The neovim-nightly-overlay always exposes an unwrapped package. If using a different source, you are highly recommended to get an "unwrapped" version of the neovim package,similar to `neovim-unwrapped` in nixpkgs.

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

@ -41,3 +41,5 @@ https://github.com/notashelf[notashelf]:
* Added lsp_lines plugin for showing diagnostic messages * Added lsp_lines plugin for showing diagnostic messages
* Added a configuration option for choosing the leader key * Added a configuration option for choosing the leader key
* The package used for neovim is now customizable by the user, using <<opt-vim.package>>. For best results, always use an unwrapped package.