From c9509d5b091770b98af9027df55065b03fb9e174 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Wed, 2 Aug 2023 09:53:07 +0300 Subject: [PATCH] docs: document custom package usage --- docs/manual.xml | 1 + docs/manual/custom-package.adoc | 14 ++++++++++++++ docs/release-notes/rl-0.5.adoc | 2 ++ 3 files changed, 17 insertions(+) create mode 100644 docs/manual/custom-package.adoc diff --git a/docs/manual.xml b/docs/manual.xml index 7184dbb..b16baa1 100644 --- a/docs/manual.xml +++ b/docs/manual.xml @@ -20,6 +20,7 @@ + diff --git a/docs/manual/custom-package.adoc b/docs/manual/custom-package.adoc new file mode 100644 index 0000000..64c043c --- /dev/null +++ b/docs/manual/custom-package.adoc @@ -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. diff --git a/docs/release-notes/rl-0.5.adoc b/docs/release-notes/rl-0.5.adoc index f6416fb..5b45d11 100644 --- a/docs/release-notes/rl-0.5.adoc +++ b/docs/release-notes/rl-0.5.adoc @@ -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 <>. For best results, always use an unwrapped package.