docs: Allow to add an url in the online documentation (#1139)

* plugin/committia: Use correct maintainers import

* plugins/neocord: Remove redyf as the entry is not in the list

* docs: Allow to add an URL to the plugin
This commit is contained in:
traxys 2024-02-20 21:20:59 +01:00 committed by GitHub
parent 9d30e87455
commit 82a24d0d42
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 88 additions and 6 deletions

View file

@ -17,6 +17,47 @@
../modules
nixpkgsMaintainersList
nixvimExtraArgsModule
({lib, ...}:
with lib; {
# Attribute may contain the following fields:
# - name: Name of the module
# - kind: Either colorschemes or plugins
# - url: Url for the plugin
#
# [kind name] will identify the plugin
#
# We need to use an attrs instead of a submodule to handle the merge.
options.meta.nixvimInfo = mkOption {
type =
(types.nullOr types.attrs)
// {
# This will create an attrset of the form:
# {
# "path"."to"."plugin" = { "<name>" = <info>; };
# }
#
# Where <info> is an attrset of the form:
# {file = "path"; url = null or "<URL>";}
merge = _: defs:
lib.foldl' (acc: def:
lib.recursiveUpdate acc {
"${def.value.kind}"."${def.value.name}" = {
inherit (def.value) url;
inherit (def) file;
};
}) {
plugins = {};
colorschemes = {};
}
defs;
};
internal = true;
default = null;
description = ''
Nixvim related information on the module
'';
};
})
];
};