summaryrefslogtreecommitdiff
path: root/modules/programs/vim.nix
diff options
context:
space:
mode:
authorDaiderd Jordan <daiderd@gmail.com>2023-06-24 23:42:39 +0200
committerGitHub <noreply@github.com>2023-06-24 23:42:39 +0200
commitace0ef2a26bc428e768a5926eae95a63cfcf8b52 (patch)
tree60506865a377eedabf6b77e2da800775c2435d41 /modules/programs/vim.nix
parent6460468e7a3e1290f132fee4170ebeaa127f6f32 (diff)
parent9d6702cf2b81f5d0ef9d628d99e8deb45f84b454 (diff)
Merge pull request #707 from emilazy/options-markdown-migration
Migrate option documentation to Markdown
Diffstat (limited to 'modules/programs/vim.nix')
-rw-r--r--modules/programs/vim.nix10
1 files changed, 5 insertions, 5 deletions
diff --git a/modules/programs/vim.nix b/modules/programs/vim.nix
index 345532e..d51d0ac 100644
--- a/modules/programs/vim.nix
+++ b/modules/programs/vim.nix
@@ -18,14 +18,14 @@ in
programs.vim.enable = mkOption {
type = types.bool;
default = false;
- description = "Whether to configure vim.";
+ description = lib.mdDoc "Whether to configure vim.";
};
programs.vim.enableSensible = mkOption {
type = types.bool;
default = false;
example = true;
- description = "Enable sensible configuration options for vim.";
+ description = lib.mdDoc "Enable sensible configuration options for vim.";
};
programs.vim.extraKnownPlugins = mkOption {
@@ -46,14 +46,14 @@ in
};
}
'';
- description = "Custom plugin declarations to add to VAM's knownPlugins.";
+ description = lib.mdDoc "Custom plugin declarations to add to VAM's knownPlugins.";
};
programs.vim.plugins = mkOption {
type = types.listOf types.attrs;
default = [];
example = [ { names = [ "surround" "vim-nix" ]; } ];
- description = "VAM plugin dictionaries to use for vim_configurable.";
+ description = lib.mdDoc "VAM plugin dictionaries to use for vim_configurable.";
};
programs.vim.package = mkOption {
@@ -70,7 +70,7 @@ in
programs.vim.vimConfig = mkOption {
type = types.lines;
default = "";
- description = "Extra vimrcConfig to use for vim_configurable.";
+ description = lib.mdDoc "Extra vimrcConfig to use for vim_configurable.";
};
};