NotAShelf/nvf
1
0
Fork 0
mirror of https://github.com/NotAShelf/nvf.git synced 2024-11-26 15:06:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

fix doc errors

Browse source
This commit is contained in:
raf 2024-10-21 18:42:27 +03:00
parent 8a0e8df411
commit 94e6f49b78
Signed by: NotAShelf
GPG key ID: AF26552424E53993
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
modules/neovim/init/spellcheck.nix
View file

@ -5,7 +5,7 @@
...
}: let
inherit (lib.modules) mkIf mkRenamedOptionModule;
inherit (lib.options) mkOption mkEnableOption literalExpression literalMarkdown;
inherit (lib.options) mkOption mkEnableOption literalExpression literalMD;
inherit (lib.strings) concatStringsSep;
inherit (lib.attrsets) mapAttrsToList;
inherit (lib.types) listOf str attrsOf;
@ -37,8 +37,8 @@ in {
extraSpellFiles = mkOption {
type = attrsOf (listOf str);
default = {"en.utf-8" = ["nvf" "word_you_want_to_add"];};
example = literalExpression {"en.utf-8" = ["nvf" "word_you_want_to_add"];};
description = literalMarkdown ''
example = literalExpression ''{"en.utf-8" = ["nvf" "word_you_want_to_add"];}'';
description = ''
Additional words to be used for spellchecking. The names of each key
will be used as the language code for the spell file. E.g:
@ -51,13 +51,13 @@ in {
after all spell directories provided by plugins and those placed in
{file}`$XDG_CONFIG_HOME/nvf/spell`.
:::warning
::: {.warning}
The attribute keys must be in `"<name>.<encoding>"` format for Neovim to
compile your spellfiles without mangling the resulting file names. Please
make sure that you enter the correct value, as nvf does not do any kind of
internal checking. Please see `:help mkspell` for more details.
# Example
Example:
```nix
# "en" is the name, and "utf-8" is the encoding. For most use cases, utf-8