NotAShelf/nvf
1
0
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2024-12-02 09:27:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs/custom-plugins: better wording and edge cases in legacy-method.md

Browse source
This commit is contained in:
raf 2024-11-07 10:57:59 +03:00
parent b2600885c8
commit c382bb02eb
Signed by: NotAShelf
GPG key ID: AF26552424E53993
1 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/manual/configuring/custom-plugins/legacy-method.md
View file

@ -1,6 +1,6 @@
# Legacy Method {#sec-legacy-method} # Legacy Method {#sec-legacy-method}
Prior to version 0.5, the method of adding new plugins was adding the plugin Prior to version v0.5, the method of adding new plugins was adding the plugin
package to `vim.startPlugins` and add its configuration as a DAG under one of package to `vim.startPlugins` and add its configuration as a DAG under one of
`vim.configRC` or `vim.luaConfigRC`. Users who have not yet updated to 0.5, or `vim.configRC` or `vim.luaConfigRC`. Users who have not yet updated to 0.5, or
prefer a more hands-on approach may use the old method where the load order of prefer a more hands-on approach may use the old method where the load order of
@ -8,13 +8,14 @@ the plugins is determined by DAGs.
## Adding plugins {#sec-adding-plugins} ## Adding plugins {#sec-adding-plugins}
To add a plugin to **nvf**'s runtime, you may add it To add a plugin not available in nvf as a module to your configuration, you may
add it to [](#opt-vim.startPlugins) in order to make it available to Neovim at
runtime.
```nix ```nix
{pkgs, ...}: { {pkgs, ...}: {
# add a package from nixpkgs to startPlugins # Add a Neovim plugin from Nixpkgs to the runtime.
vim.startPlugins = [ vim.startPlugins = [pkgs.vimPlugins.aerial-nvim];
pkgs.vimPlugins.aerial-nvim ];
} }
``` ```
@ -23,7 +24,9 @@ provide configuration as a DAG using the **nvf** extended library.
```nix ```nix
{inputs, ...}: let {inputs, ...}: let
# assuming you have an input called nvf pointing at the nvf repository # This assumes you have an input called 'nvf' in your flake inputs
# and 'inputs' in your specialArgs. In the case you have passed 'nvf'
# to specialArgs, the 'inputs' prefix may be omitted.
inherit (inputs.nvf.lib.nvim.dag) entryAnywhere; inherit (inputs.nvf.lib.nvim.dag) entryAnywhere;
in { in {
vim.luaConfigRC.aerial-nvim= entryAnywhere '' vim.luaConfigRC.aerial-nvim= entryAnywhere ''