mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-06-21 00:25:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs/contributing: fix hyperlink issues

Browse source
This commit is contained in:
rottenfishbone 2024-12-25 16:37:13 -07:00
parent ca3c7e29a8
commit 25c1352464
No known key found for this signature in database
GPG key ID: C72DC6F02AF04BC9
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -42,7 +42,7 @@ To add a new plugin you need to do the following.
- _vim plugins_: They are configured through **global variables** (`g:plugin_foo_option` in vimscript and `vim.g.plugin_foo_option` in lua).\
For those, you should use the `lib.nixvim.plugins.mkVimPlugin`.\
-> See [this plugin](plugins/utils/direnv.nix) for an example.
-> See [this plugin](plugins/by-name/direnv/default.nix) for an example.
- _neovim plugins_: They are configured through a `setup` function (`require('plugin').setup({opts})`).\
For those, you should use the `lib.nixvim.plugins.mkNeovimPlugin`.\
-> See the [template](plugins/TEMPLATE.nix).
@ -108,11 +108,13 @@ mkNeovimPlugin {
}
```
Here's an example plugin: [lsp_lines.nvim](https://github.com/nix-community/nixvim/commit/8815180c625e9766b2cb3126756b97e994998228)
This example defines a Neovim plugin named `example-plugin` with specified maintainers, URL, description, settings options, and additional configuration. `package` will be 'example-plugin'
thanks to package referring to the `name` attribute.
See the [template](plugins/TEMPLATE.nix) for a starting point.
Here's a simple plugin using `mkNeovimPlugin` for reference: [lsp_lines.nvim](plugins/by-name/lsp-lines/default.nix).
#### `mkVimPlugin`
The `mkVimPlugin` function provides a standardized way to create a `Vim` plugin.