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 <S-CR> insert-mode keymap to Lists keymaps table - Clean up diary frequency section line wrapping
This commit is contained in:
@@ -52,9 +52,9 @@ results.
|
|||||||
|
|
||||||
- Daily diary out of the box (`<Leader>w<Leader>w`, `<C-Down>` / `<C-Up>`).
|
- Daily diary out of the box (`<Leader>w<Leader>w`, `<C-Down>` / `<C-Up>`).
|
||||||
- Configurable cadence: set `diary_frequency = 'weekly'` (or `'monthly'`
|
- Configurable cadence: set `diary_frequency = 'weekly'` (or `'monthly'`
|
||||||
/ `'yearly'`) per wiki and the commands address `2026-W19.wiki`,
|
/ `'yearly'`) per wiki and the commands address
|
||||||
`2026-05.wiki`, `2026.wiki` instead. Navigation stays at the same
|
`2026-W19.wiki` / `2026-05.wiki` / `2026.wiki` instead. Navigation
|
||||||
cadence as the entry under the cursor.
|
stays at the same cadence as the entry under the cursor.
|
||||||
- Diary index page generation (`:VimwikiDiaryGenerateLinks`).
|
- Diary index page generation (`:VimwikiDiaryGenerateLinks`).
|
||||||
|
|
||||||
### Other
|
### Other
|
||||||
@@ -127,7 +127,7 @@ call dein#add('gffranco/nuwiki', {
|
|||||||
```sh
|
```sh
|
||||||
git clone https://code.gfran.co/gffranco/nuwiki ~/.vim/pack/gffranco/start/nuwiki
|
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
|
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
|
### Vim LSP client setup
|
||||||
@@ -426,6 +426,9 @@ For users configuring without Lua.
|
|||||||
| `g:nuwiki_mouse_mappings` | `0` | `1` enables mouse maps |
|
| `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_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_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 |
|
| `:NuwikiNextLink` / `:NuwikiPrevLink` | `:VimwikiNextLink` / `:VimwikiPrevLink` | Jump to the next / previous wikilink |
|
||||||
| `:NuwikiBaddLink` | `:VimwikiBaddLink` | Add the link target under the cursor to the buffer list |
|
| `: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 |
|
| `: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 |
|
| `:NuwikiVar` | `:VimwikiVar [key [val]]` | Get/set nuwiki client config |
|
||||||
| `:NuwikiReturn` | `:VimwikiReturn` | Command form of the smart `<CR>` list/table continuation |
|
| `:NuwikiReturn` | `:VimwikiReturn` | Command form of the smart `<CR>` list/table continuation |
|
||||||
| `:NuwikiShowVersion` | `:VimwikiShowVersion` | Print the nuwiki version + host editor |
|
| `: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 |
|
| Key | Action |
|
||||||
|---|---|
|
|---|---|
|
||||||
| `<CR>` | Continue the list with the same marker (preserves checkbox), or break out on an empty bullet |
|
| `<CR>` | Continue the list with the same marker (preserves checkbox), or break out on an empty bullet |
|
||||||
|
| `<S-CR>` | Multiline list item continuation (no new marker) |
|
||||||
| `<C-D>` / `<C-T>` | Dedent / indent the current item |
|
| `<C-D>` / `<C-T>` | Dedent / indent the current item |
|
||||||
| `<C-L><C-J>` / `<C-L><C-K>` | Cycle the marker style (`-` → `*` → `#` → `1.` → `1)` → `a)` → `A)` → `i)` → `I)`) |
|
| `<C-L><C-J>` / `<C-L><C-K>` | Cycle the marker style (`-` → `*` → `#` → `1.` → `1)` → `a)` → `A)` → `i)` → `I)`) |
|
||||||
| `<C-L><C-M>` | Toggle / add a checkbox on the current item |
|
| `<C-L><C-M>` | Toggle / add a checkbox on the current item |
|
||||||
|
|||||||
Reference in New Issue
Block a user