1
0
Fork 0
mirror of https://github.com/nix-community/nixvim.git synced 2025-12-19 07:21:12 +01:00

docs: format nix examples in options

This commit is contained in:
Zexin Yuan 2025-12-12 19:26:32 +08:00 committed by Gaétan Lepage
parent d52007581e
commit 297e2e0b65
17 changed files with 293 additions and 265 deletions

View file

@ -108,7 +108,6 @@ in
type = with types; listOf (maybeRaw str);
pluginDefault = { };
example = {
"<LANGUAGE1>" = [
"<WORD1>"
"<WORD2>"
@ -122,9 +121,9 @@ in
Lists of additional words that should not be counted as spelling errors.
This setting is language-specific, so use an attrs of the format
```nix
{
...
};
{
...
};
```
where <LANGUAGE> denotes the language code in `settings.language`.
@ -148,18 +147,18 @@ in
Lists of rules that should be disabled (if enabled by default by LanguageTool).
This setting is language-specific, so use an attrs of the format
```nix
{
"<LANGUAGE1>" = [
"<WORD1>"
"<WORD2>"
...
];
"<LANGUAGE2>" = [
"<WORD1>"
"<WORD2>"
];
{
"<LANGUAGE1>" = [
"<WORD1>"
"<WORD2>"
...
};
];
"<LANGUAGE2>" = [
"<WORD1>"
"<WORD2>"
];
...
};
```
where `<LANGUAGE>` denotes the language code in `settings.language` and `<RULE>` the ID of
the LanguageTool rule.
@ -184,18 +183,18 @@ in
Lists of rules that should be enabled (if disabled by default by LanguageTool).
This setting is language-specific, so use an attrs of the format
```nix
{
"<LANGUAGE1>" = [
"<WORD1>"
"<WORD2>"
...
];
"<LANGUAGE2>" = [
"<WORD1>"
"<WORD2>"
];
{
"<LANGUAGE1>" = [
"<WORD1>"
"<WORD2>"
...
};
];
"<LANGUAGE2>" = [
"<WORD1>"
"<WORD2>"
];
...
};
```
where `<LANGUAGE>` denotes the language code in `settings.language` and `<RULE>` the ID of
the LanguageTool rule.
@ -217,18 +216,18 @@ in
within a specific sentence).
This setting is language-specific, so use an attrs of the format
```nix
{
"<LANGUAGE1>" = [
"<JSON1>"
"<JSON2>"
...
];
"<LANGUAGE2>" = [
"<JSON1>"
"<JSON2>"
];
{
"<LANGUAGE1>" = [
"<JSON1>"
"<JSON2>"
...
};
];
"<LANGUAGE2>" = [
"<JSON1>"
"<JSON2>"
];
...
};
```
where `<LANGUAGE>` denotes the language code in `settings.language` and `<JSON>` is a JSON
string containing information about the rule and sentence.