diff options
author | Matthieu Coudron <mcoudron@hotmail.com> | 2022-09-02 00:53:55 +0200 |
---|---|---|
committer | Matthieu Coudron <mcoudron@hotmail.com> | 2022-09-11 20:33:01 +0200 |
commit | 800323c0c069f38976ea73907bf1561d13f037b4 (patch) | |
tree | 0b660a83094f54516426588613dc2b387700e66c /doc | |
parent | 39442404769e526f9bbb99e0cd82e79db83fc37c (diff) |
doc(vim): take into account plug non-support
Apply suggestions from code review Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/languages-frameworks/vim.section.md | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/languages-frameworks/vim.section.md b/doc/languages-frameworks/vim.section.md index 121df6ad784ca..087e593086f00 100644 --- a/doc/languages-frameworks/vim.section.md +++ b/doc/languages-frameworks/vim.section.md @@ -8,7 +8,7 @@ Loading can be deferred; see examples. At the moment we support two different methods for managing plugins: - Vim packages (*recommended*) -- vim-plug +- vim-plug (vim only) ## Custom configuration {#custom-configuration} @@ -196,7 +196,7 @@ vim_configurable.customize { } ``` -Note: this is not possible anymore for neovim. +Note: this is not possible anymore for Neovim. ## Adding new plugins to nixpkgs {#adding-new-plugins-to-nixpkgs} @@ -215,7 +215,7 @@ Sometimes plugins require an override that must be changed when the plugin is up To add a new plugin, run `./update.py --add "[owner]/[name]"`. **NOTE**: This script automatically commits to your git repository. Be sure to check out a fresh branch before running. -Finally, there are some plugins that are also packaged in nodePackages because they have Javascript-related build steps, such as running webpack. Those plugins are not listed in `vim-plugin-names` or managed by `update.py` at all, and are included separately in `overrides.nix`. Currently, all these plugins are related to the `coc.nvim` ecosystem of the Language Server Protocol integration with vim/neovim. +Finally, there are some plugins that are also packaged in nodePackages because they have Javascript-related build steps, such as running webpack. Those plugins are not listed in `vim-plugin-names` or managed by `update.py` at all, and are included separately in `overrides.nix`. Currently, all these plugins are related to the `coc.nvim` ecosystem of the Language Server Protocol integration with Vim/Neovim. ## Updating plugins in nixpkgs {#updating-plugins-in-nixpkgs} @@ -235,16 +235,20 @@ Alternatively, set the number of processes to a lower count to avoid rate-limiti 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: + +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 {}) |