From a2ca49a64ce5ae645a23a95cf8a7d584b3deb39e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gabriel=20Fr=C3=B3es=20Franco?= Date: Wed, 3 Jun 2026 19:51:27 -0300 Subject: [PATCH] docs: fix README.md stale documentation and incorrect mappings - Add NuwikiSearch to commands table (was incorrectly marked as Vimwiki-only) - Add missing Vim globals: g:nuwiki_no_calendar, g:nuwiki_auto_chdir, g:nuwiki_auto_header - Fix Plain Vim manual install to use cp instead of symlink (aligns with install() helper) - Add missing insert-mode keymap to Lists keymaps table - Clean up diary frequency section line wrapping --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 383e328..23571c1 100644 --- a/README.md +++ b/README.md @@ -52,9 +52,9 @@ results. - Daily diary out of the box (`ww`, `` / ``). - Configurable cadence: set `diary_frequency = 'weekly'` (or `'monthly'` - / `'yearly'`) per wiki and the commands address `2026-W19.wiki`, - `2026-05.wiki`, `2026.wiki` instead. Navigation stays at the same - cadence as the entry under the cursor. + / `'yearly'`) per wiki and the commands address + `2026-W19.wiki` / `2026-05.wiki` / `2026.wiki` instead. Navigation + stays at the same cadence as the entry under the cursor. - Diary index page generation (`:VimwikiDiaryGenerateLinks`). ### Other @@ -127,7 +127,7 @@ call dein#add('gffranco/nuwiki', { ```sh git clone https://code.gfran.co/gffranco/nuwiki ~/.vim/pack/gffranco/start/nuwiki cd ~/.vim/pack/gffranco/start/nuwiki && cargo build --release -p nuwiki-ls -mkdir -p bin && ln -s ../target/release/nuwiki-ls bin/nuwiki-ls +mkdir -p bin && cp target/release/nuwiki-ls bin/ ``` ### Vim LSP client setup @@ -426,6 +426,9 @@ For users configuring without Lua. | `g:nuwiki_mouse_mappings` | `0` | `1` enables mouse maps | | `g:nuwiki_binary_path` | _(auto)_ | path to a prebuilt `nuwiki-ls` binary, bypassing the bundled one | | `g:nuwiki_build_from_source` | `0` | `1` builds the binary with `cargo` instead of downloading a release | +| `g:nuwiki_no_calendar` | `0` | `1` opts out of calendar-vim integration | +| `g:nuwiki_auto_chdir` | `0` | `1` `:lcd` into the wiki root when a wiki buffer becomes current | +| `g:nuwiki_auto_header` | `0` | `1` insert a level-1 header from the filename on new wiki pages | --- @@ -461,7 +464,7 @@ available on both the Neovim and plain-Vim paths. | `:NuwikiNextLink` / `:NuwikiPrevLink` | `:VimwikiNextLink` / `:VimwikiPrevLink` | Jump to the next / previous wikilink | | `:NuwikiBaddLink` | `:VimwikiBaddLink` | Add the link target under the cursor to the buffer list | | `:NuwikiNormalizeLink` | `:VimwikiNormalizeLink` | Wrap the word / visual selection under the cursor as a wikilink | -| — | `:VimwikiSearch {pat}` (`:VWS`) | `:lvimgrep` `{pat}` across the current wiki's pages (empty `{pat}` reuses the last search) | +| `:NuwikiSearch {pat}` | `:VimwikiSearch {pat}` (`:VWS`) | `:lvimgrep` `{pat}` across the current wiki's pages (empty `{pat}` reuses the last search) | | `:NuwikiVar` | `:VimwikiVar [key [val]]` | Get/set nuwiki client config | | `:NuwikiReturn` | `:VimwikiReturn` | Command form of the smart `` list/table continuation | | `:NuwikiShowVersion` | `:VimwikiShowVersion` | Print the nuwiki version + host editor | @@ -578,6 +581,7 @@ vimwiki) they fire only after `'timeoutlen'`; type a suffix such as `gln` or | Key | Action | |---|---| | `` | Continue the list with the same marker (preserves checkbox), or break out on an empty bullet | +| `` | Multiline list item continuation (no new marker) | | `` / `` | Dedent / indent the current item | | `` / `` | Cycle the marker style (`-` → `*` → `#` → `1.` → `1)` → `a)` → `A)` → `i)` → `I)`) | | `` | Toggle / add a checkbox on the current item |