mirror of
https://github.com/NotAShelf/nvf.git
synced 2024-11-01 11:01:15 +00:00
docs: document custom package usage
This commit is contained in:
parent
fcaed357f4
commit
c9509d5b09
3 changed files with 17 additions and 0 deletions
|
@ -20,6 +20,7 @@
|
|||
<xi:include href="manual/default-configs.xml"/>
|
||||
<xi:include href="manual/custom-configs.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/languages.xml"/>
|
||||
<appendix xml:id="ch-options">
|
||||
|
|
14
docs/manual/custom-package.adoc
Normal file
14
docs/manual/custom-package.adoc
Normal 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.
|
|
@ -41,3 +41,5 @@ https://github.com/notashelf[notashelf]:
|
|||
* Added lsp_lines plugin for showing diagnostic messages
|
||||
|
||||
* 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.
|
||||
|
|
Loading…
Reference in a new issue