From d22c81ea4f49ce073cd64a3db276f1b75b97da36 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gabriel=20Fr=C3=B3es=20Franco?= Date: Sat, 30 May 2026 23:12:14 -0300 Subject: [PATCH] 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 --- README.md | 13 ++++--------- development/SPEC.md | 4 ++-- doc/nuwiki.txt | 7 +++---- lua/nuwiki/config.lua | 7 +++---- 4 files changed, 12 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index e860a62..04c8e8b 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,9 @@ results. - Goto-definition (follow wikilinks), backlinks, hover preview, 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. - Folding: server-driven `foldingRange` by default, regex fallback when the server isn't ready. @@ -217,10 +219,6 @@ require('nuwiki').setup({ -- Checkbox progression characters: " .oOX" by default. listsyms = ' .oOX', 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_index` | string | `'diary'` | diary index page stem | | `diary_frequency` | string | `'daily'` | `'daily'` \| `'weekly'` \| `'monthly'` \| `'yearly'` | -| `diary_start_week_day` | string | `'monday'` | weekday name | -| `diary_caption_level` | int | `1` | `0`–`6` | +| `diary_caption_level` | int | `1` | `1`–`6` (level of the index caption) | | `diary_sort` | string | `'desc'` | `'desc'` \| `'asc'` | | `diary_header` | string | `'Diary'` | any heading text | -| `maxhi` | int (bool) | `1` | `0` \| `1` | | `listsyms` | string | `' .oOX'` | checkbox progression chars | | `listsyms_propagate` | bool | `true` | `true` \| `false` | | `list_margin` | int | `-1` | `-1` (auto) or `≥ 0` | | `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` | #### HTML export keys (per-wiki) diff --git a/development/SPEC.md b/development/SPEC.md index 15f52cc..f398e0c 100644 --- a/development/SPEC.md +++ b/development/SPEC.md @@ -236,9 +236,9 @@ require('nuwiki').setup({ ``` 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`, -`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`/ `template_date_format`, `css_name`, `auto_export`, `html_filename_parameterization`, `exclude_files`, `color_dic`). diff --git a/doc/nuwiki.txt b/doc/nuwiki.txt index 5c267c6..47435ad 100644 --- a/doc/nuwiki.txt +++ b/doc/nuwiki.txt @@ -122,7 +122,6 @@ default): > template_default = 'default', css_name = 'style.css', auto_export = false, - nested_syntaxes = { python = 'python' }, }, }, }) @@ -196,11 +195,11 @@ match upstream vimwiki. `exclude_files` List of glob patterns excluded from export. `listsyms` `' .oOX'` — checkbox progression characters. `listsyms_propagate` `true` -`maxhi` `1` — inline heading-level highlighting count. -`nested_syntaxes` `{}` — embed other syntaxes inside - `{{{lang …}}}` fenced blocks. `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 ~ *g:nuwiki_no_default_mappings* diff --git a/lua/nuwiki/config.lua b/lua/nuwiki/config.lua index 73b201d..0da64f4 100644 --- a/lua/nuwiki/config.lua +++ b/lua/nuwiki/config.lua @@ -21,13 +21,12 @@ M.defaults = { -- `doc/nuwiki.txt`): -- name, root, file_extension, syntax, index -- diary_rel_path, diary_index, diary_frequency, - -- diary_start_week_day, diary_caption_level, diary_sort, - -- diary_header + -- diary_caption_level, diary_sort, diary_header -- html_path, template_path, template_default, template_ext, -- template_date_format, css_name, auto_export, auto_toc, -- html_filename_parameterization, exclude_files, color_dic - -- maxhi, listsyms, listsyms_propagate, list_margin, - -- links_space_char, nested_syntaxes + -- listsyms, listsyms_propagate, list_margin, + -- links_space_char wikis = nil, -- Per-buffer glue. Each subgroup mirrors vimwiki's