add some docs

This commit is contained in:
Pedro Alves 2021-01-05 16:24:40 +00:00
parent 0586bed5ad
commit bfa329a456
2 changed files with 31 additions and 3 deletions

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

View file

@ -1,4 +1,4 @@
{...}:
{ pkgs, ... }:
{
programs.nixvim = {
# This just enables NixVim.
@ -18,8 +18,7 @@
leader = ",";
# We can create maps for every mode!
# There is .normal, .insert, .visual and .operator
# These are aliased to .n, .i, .v and .o
# There is .normal, .insert, .visual, .operator, etc!
# We can also set options:
options = {