about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorMatthieu Coudron <mcoudron@hotmail.com>2021-06-12 01:08:24 +0200
committerMatthieu Coudron <mcoudron@hotmail.com>2022-09-11 18:11:16 +0200
commit584bc20aa051dedba29d6e7732cab2aacbf8bdcc (patch)
treedc17f3c4676593bc42468220b8019d08ca75ea33 /doc
parenta7fb06c2da708e39169059a797ba7c0cb8433256 (diff)
doc: present how to create a vim-plugin overlay
it is possible to maintain an out of tree list of neovim plugins with this method

Update doc/languages-frameworks/vim.section.md

Co-authored-by: Sandro <sandro.jaeckel@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/languages-frameworks/vim.section.md23
1 files changed, 18 insertions, 5 deletions
diff --git a/doc/languages-frameworks/vim.section.md b/doc/languages-frameworks/vim.section.md
index ec0e603891557..9062fb7d361b7 100644
--- a/doc/languages-frameworks/vim.section.md
+++ b/doc/languages-frameworks/vim.section.md
@@ -243,10 +243,23 @@ Alternatively, set the number of processes to a lower count to avoid rate-limiti
 ./pkgs/applications/editors/vim/plugins/update.py --proc 1
 ```
 
-## Important repositories {#important-repositories}
+## How to maintain an out-of-tree overlay of vim plugins ?
 
-- [vim-pi](https://bitbucket.org/vimcommunity/vim-pi) is a plugin repository
-  from VAM plugin manager meant to be used by others as well used by
+You can use the updater script to generate basic packages out of a custom vim
+plugin list:
+```
+pkgs/applications/editors/vim/plugins/update.py -i vim-plugin-names -o generated.nix --no-commit
+```
+with the contents of "vim-plugin-names" being for example:
+```
+repo,branch,alias
+pwntester/octo.nvim,,
+```
+
+You can then reference the generated vim plugins via:
+```nix
+myVimPlugins = pkgs.vimPlugins.extend (
+  (pkgs.callPackage generated.nix {})
+);
+```
 
-- [vim2nix](https://github.com/MarcWeber/vim-addon-vim2nix) which generates the
-  .nix code