diff --git a/doc/plugins.md b/doc/plugins.md new file mode 100644 index 00000000..954ca512 --- /dev/null +++ b/doc/plugins.md @@ -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"; + + # ... +}; +``` diff --git a/example.nix b/example.nix index 0b451061..19c96491 100644 --- a/example.nix +++ b/example.nix @@ -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 = {