docs(config): drop client-side keys and refresh per-wiki reference
Remove nested_syntaxes, maxhi and diary_start_week_day from the config reference (block, tables and key lists) since the server no longer consumes them, and note that language-tagged code fences are highlighted automatically with no nested_syntaxes key. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
@@ -25,7 +25,9 @@ results.
|
|||||||
|
|
||||||
- Goto-definition (follow wikilinks), backlinks, hover preview,
|
- Goto-definition (follow wikilinks), backlinks, hover preview,
|
||||||
completion on `[[`, document outline, workspace symbol search.
|
completion on `[[`, document outline, workspace symbol search.
|
||||||
- Semantic-token highlighting (no syntax-file fallback needed).
|
- Semantic-token highlighting (no syntax-file fallback needed). Code fences
|
||||||
|
tagged with a language (`{{{python … }}}`) get that language's syntax
|
||||||
|
automatically — no `nested_syntaxes` config needed.
|
||||||
- Broken-link diagnostics and an orphan-page finder.
|
- Broken-link diagnostics and an orphan-page finder.
|
||||||
- Folding: server-driven `foldingRange` by default, regex fallback when
|
- Folding: server-driven `foldingRange` by default, regex fallback when
|
||||||
the server isn't ready.
|
the server isn't ready.
|
||||||
@@ -217,10 +219,6 @@ require('nuwiki').setup({
|
|||||||
-- Checkbox progression characters: " .oOX" by default.
|
-- Checkbox progression characters: " .oOX" by default.
|
||||||
listsyms = ' .oOX',
|
listsyms = ' .oOX',
|
||||||
listsyms_propagate = true,
|
listsyms_propagate = true,
|
||||||
-- Inline highlighting: 6 heading levels by default.
|
|
||||||
maxhi = 1,
|
|
||||||
-- Embed other syntaxes inside `{{{lang …}}}` fences.
|
|
||||||
nested_syntaxes = {},
|
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
@@ -305,16 +303,13 @@ Each is a boolean. All default to `true` except `mouse`.
|
|||||||
| `diary_rel_path` | string | `'diary'` | path relative to `root` |
|
| `diary_rel_path` | string | `'diary'` | path relative to `root` |
|
||||||
| `diary_index` | string | `'diary'` | diary index page stem |
|
| `diary_index` | string | `'diary'` | diary index page stem |
|
||||||
| `diary_frequency` | string | `'daily'` | `'daily'` \| `'weekly'` \| `'monthly'` \| `'yearly'` |
|
| `diary_frequency` | string | `'daily'` | `'daily'` \| `'weekly'` \| `'monthly'` \| `'yearly'` |
|
||||||
| `diary_start_week_day` | string | `'monday'` | weekday name |
|
| `diary_caption_level` | int | `1` | `1`–`6` (level of the index caption) |
|
||||||
| `diary_caption_level` | int | `1` | `0`–`6` |
|
|
||||||
| `diary_sort` | string | `'desc'` | `'desc'` \| `'asc'` |
|
| `diary_sort` | string | `'desc'` | `'desc'` \| `'asc'` |
|
||||||
| `diary_header` | string | `'Diary'` | any heading text |
|
| `diary_header` | string | `'Diary'` | any heading text |
|
||||||
| `maxhi` | int (bool) | `1` | `0` \| `1` |
|
|
||||||
| `listsyms` | string | `' .oOX'` | checkbox progression chars |
|
| `listsyms` | string | `' .oOX'` | checkbox progression chars |
|
||||||
| `listsyms_propagate` | bool | `true` | `true` \| `false` |
|
| `listsyms_propagate` | bool | `true` | `true` \| `false` |
|
||||||
| `list_margin` | int | `-1` | `-1` (auto) or `≥ 0` |
|
| `list_margin` | int | `-1` | `-1` (auto) or `≥ 0` |
|
||||||
| `links_space_char` | string | `' '` | char that replaces spaces in synthesised link paths |
|
| `links_space_char` | string | `' '` | char that replaces spaces in synthesised link paths |
|
||||||
| `nested_syntaxes` | table | `{}` | `{ ['fence-lang'] = 'vim-syntax', … }` |
|
|
||||||
| `auto_toc` | bool | `false` | `true` \| `false` |
|
| `auto_toc` | bool | `false` | `true` \| `false` |
|
||||||
|
|
||||||
#### HTML export keys (per-wiki)
|
#### HTML export keys (per-wiki)
|
||||||
|
|||||||
+2
-2
@@ -236,9 +236,9 @@ require('nuwiki').setup({
|
|||||||
```
|
```
|
||||||
|
|
||||||
Per-wiki keys include `index`, `diary_rel_path`/`diary_index`/
|
Per-wiki keys include `index`, `diary_rel_path`/`diary_index`/
|
||||||
`diary_frequency`/`diary_start_week_day`/`diary_sort`/`diary_caption_level`/
|
`diary_frequency`/`diary_sort`/`diary_caption_level`/
|
||||||
`diary_header`, `listsyms`/`listsyms_propagate`/`list_margin`,
|
`diary_header`, `listsyms`/`listsyms_propagate`/`list_margin`,
|
||||||
`links_space_char`, `nested_syntaxes`, `auto_toc`, `maxhi`, and an `html`
|
`links_space_char`, `auto_toc`, and an `html`
|
||||||
table (`html_path`, `template_path`/`template_default`/`template_ext`/
|
table (`html_path`, `template_path`/`template_default`/`template_ext`/
|
||||||
`template_date_format`, `css_name`, `auto_export`,
|
`template_date_format`, `css_name`, `auto_export`,
|
||||||
`html_filename_parameterization`, `exclude_files`, `color_dic`).
|
`html_filename_parameterization`, `exclude_files`, `color_dic`).
|
||||||
|
|||||||
+3
-4
@@ -122,7 +122,6 @@ default): >
|
|||||||
template_default = 'default',
|
template_default = 'default',
|
||||||
css_name = 'style.css',
|
css_name = 'style.css',
|
||||||
auto_export = false,
|
auto_export = false,
|
||||||
nested_syntaxes = { python = 'python' },
|
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
})
|
})
|
||||||
@@ -196,11 +195,11 @@ match upstream vimwiki.
|
|||||||
`exclude_files` List of glob patterns excluded from export.
|
`exclude_files` List of glob patterns excluded from export.
|
||||||
`listsyms` `' .oOX'` — checkbox progression characters.
|
`listsyms` `' .oOX'` — checkbox progression characters.
|
||||||
`listsyms_propagate` `true`
|
`listsyms_propagate` `true`
|
||||||
`maxhi` `1` — inline heading-level highlighting count.
|
|
||||||
`nested_syntaxes` `{}` — embed other syntaxes inside
|
|
||||||
`{{{lang …}}}` fenced blocks.
|
|
||||||
`links_space_char` `' '`
|
`links_space_char` `' '`
|
||||||
|
|
||||||
|
Code fences tagged with a language (`{{{python …}}}`) are highlighted with
|
||||||
|
that language's syntax automatically — there is no `nested_syntaxes` key.
|
||||||
|
|
||||||
Vim-specific globals ~
|
Vim-specific globals ~
|
||||||
|
|
||||||
*g:nuwiki_no_default_mappings*
|
*g:nuwiki_no_default_mappings*
|
||||||
|
|||||||
@@ -21,13 +21,12 @@ M.defaults = {
|
|||||||
-- `doc/nuwiki.txt`):
|
-- `doc/nuwiki.txt`):
|
||||||
-- name, root, file_extension, syntax, index
|
-- name, root, file_extension, syntax, index
|
||||||
-- diary_rel_path, diary_index, diary_frequency,
|
-- diary_rel_path, diary_index, diary_frequency,
|
||||||
-- diary_start_week_day, diary_caption_level, diary_sort,
|
-- diary_caption_level, diary_sort, diary_header
|
||||||
-- diary_header
|
|
||||||
-- html_path, template_path, template_default, template_ext,
|
-- html_path, template_path, template_default, template_ext,
|
||||||
-- template_date_format, css_name, auto_export, auto_toc,
|
-- template_date_format, css_name, auto_export, auto_toc,
|
||||||
-- html_filename_parameterization, exclude_files, color_dic
|
-- html_filename_parameterization, exclude_files, color_dic
|
||||||
-- maxhi, listsyms, listsyms_propagate, list_margin,
|
-- listsyms, listsyms_propagate, list_margin,
|
||||||
-- links_space_char, nested_syntaxes
|
-- links_space_char
|
||||||
wikis = nil,
|
wikis = nil,
|
||||||
|
|
||||||
-- Per-buffer glue. Each subgroup mirrors vimwiki's
|
-- Per-buffer glue. Each subgroup mirrors vimwiki's
|
||||||
|
|||||||
Reference in New Issue
Block a user