NotAShelf/nvf
2
1
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2025-11-10 07:25:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs/hacking: add section on adding plugins

Browse source
This commit is contained in:
Ching Pei Yang 2023-10-01 13:26:23 +02:00
commit 33779cd97e
1 changed files with 35 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

35
docs/manual/hacking.adoc
View file

@ -357,3 +357,38 @@ in {
If you have come across a plugin that has an API that doesn't seem to easily allow custom keybindings, If you have come across a plugin that has an API that doesn't seem to easily allow custom keybindings,
don't be scared to implement a draft PR. We'll help you get it done. don't be scared to implement a draft PR. We'll help you get it done.
==== ====
=== Adding Plugins
To add a new neovim plugin, first add the source url in the inputs section of `flake.nix`
[source,nix]
----
{
inputs = {
# ...
neodev-nvim = {
url = "github:folke/neodev.nvim";
flake = false;
};
};
}
----
Then add the name of the plugin into the `availablePlugins` variable in `lib/types/plugins.nix`:
[source,nix]
----
# ...
availablePlugins = [
# ...
"neodev-nvim"
];
----
You can now reference this plugin using its string name:
[source,nix]
----
config.vim.startPlugins = ["neodev-nvim"];
----