mirror/nix-community.nixvim
1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-07-09 16:54:36 +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

14
plugins/statuslines/airline.nix
View file

@ -30,12 +30,14 @@ in {
sections = mkOption {
default = null;
type = with types; nullOr (submodule {
a = sectionOption;
b = sectionOption;
c = sectionOption;
x = sectionOption;
y = sectionOption;
z = sectionOption;
options = {
a = sectionOption;
b = sectionOption;
c = sectionOption;
x = sectionOption;
y = sectionOption;
z = sectionOption;
};
});
};

2
plugins/statuslines/lightline.nix
View file

@ -21,7 +21,7 @@ in {
description = ''
A list of function component definitions.
You should define the functions themselves in <para>extraConfig</para>
You should define the functions themselves in extraConfig
'';
example = ''
programs.nixvim.plugins.lightline = {