nix-community.nixvim/docs/plugins.md
Pedro Alves eef84178ab docs: Add basic documentation system based on nmd
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.
2022-01-12 01:44:51 +00:00

29 lines
703 B
Markdown

# 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";
# ...
};
```