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

docs: Add basic documentation system based on nmd

Browse source 
You can now run `nix build '.#docs'` to build HTML documentation
documenting every single option on nixvim! Fortunately, thanks to
the 'description' field, most options are already documented, but
there are still a fair few that need documenting.

I will be taking care of those in the next few days. When those are
done, I will find a way to automatically rebuild documentation on every
repo push, and also add a PR hook requiring documentation.

Additionally, I will try to find a way to have per-page plugin docs.
This commit is contained in:
Pedro Alves 2022-01-10 19:50:13 +00:00
parent 69cf1b6204
commit eef84178ab
42 changed files with 184 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

29
docs/plugins.md Normal file
View file

@ -0,0 +1,29 @@
# List of plugins for NixVim
## Colorschemes
### Gruvbox
Just set `enable` to use the colorscheme.
```nix
programs.nixvim.colorscheme.gruvbox.enable = true;
```
## Status lines
### Lightline
Lightline is a small and customizable status line for vim. It can be enabled
with `programs.nixvim.plugins.lightline.enable`, and it will try to use the
colorscheme set by the user. If you want to manually override this, set
`programs.nixvim.plugins.lightline.colorscheme` to the name of the colorscheme
to use.
```nix
programs.nixvim.plugins.lightline = {
enable = true; # Enable this plugin
# This can be set to null to reset. Defaults to global colorscheme
colorscheme = "wombat";
# ...
};
```