Docs #1

Merged
gffranco merged 15 commits from docs into main 2026-05-30 18:35:41 +00:00
Showing only changes of commit 93725501dc - Show all commits
+7 -7
View File
@@ -234,7 +234,7 @@ Vim-specific globals ~
All commands are available in both forms: All commands are available in both forms:
- Canonical form: :Nuwiki* - Canonical form: :Nuwiki*
- Vimwiki-compatible form: :Nuwiki* - Vimwiki-compatible form: :Vimwiki*
Every command listed below is registered buffer-logic on `.wiki` files. Every command listed below is registered buffer-logic on `.wiki` files.
Only the `:Nuwiki*` form is shown in this document for brevity. Only the `:Nuwiki*` form is shown in this document for brevity.
@@ -527,7 +527,7 @@ The `diary_frequency` per-wiki option controls the cadence:
monthly YYYY-MM e.g. `2026-05.wiki` monthly YYYY-MM e.g. `2026-05.wiki`
yearly YYYY e.g. `2026.wiki` yearly YYYY e.g. `2026.wiki`
`:VimwikiMakeDiaryNote` opens the entry for the current period at the `:NuwikiMakeDiaryNote` opens the entry for the current period at the
configured cadence; the yesterday / tomorrow commands step back and configured cadence; the yesterday / tomorrow commands step back and
forward by one period. `<C-Down>` / `<C-Up>` walk between indexed forward by one period. `<C-Down>` / `<C-Up>` walk between indexed
entries of the same flavour as the one under the cursor — so on a entries of the same flavour as the one under the cursor — so on a
@@ -535,7 +535,7 @@ weekly page, navigation stays weekly.
Index ~ Index ~
`:VimwikiDiaryGenerateLinks` rebuilds the diary index page (`diary.wiki` `:NuwikiDiaryGenerateLinks` rebuilds the diary index page (`diary.wiki`
by default) with a chronological list of every entry on disk, grouped by default) with a chronological list of every entry on disk, grouped
by year / month. The page name is set by `diary_index`; the heading is by year / month. The page name is set by `diary_index`; the heading is
set by `diary_header`. set by `diary_header`.
@@ -569,8 +569,8 @@ column moves, cell navigation, new-row insertion).
============================================================================== ==============================================================================
11. HTML EXPORT *nuwiki-html* 11. HTML EXPORT *nuwiki-html*
`:Vimwiki2HTML` renders the current page; `:Vimwiki2HTMLBrowse` opens `:Nuwiki2HTML` renders the current page; `:Nuwiki2HTMLBrowse` opens
the result in the default browser; `:VimwikiAll2HTML` exports every the result in the default browser; `:NuwikiAll2HTML` exports every
page (incremental by default; `!` forces a full rebuild). page (incremental by default; `!` forces a full rebuild).
Per-wiki knobs: Per-wiki knobs:
@@ -584,7 +584,7 @@ Per-wiki knobs:
`exclude_files` Glob patterns excluded from export. `exclude_files` Glob patterns excluded from export.
Templates may include `{title}`, `{rootpath}`, `{content}`, `{css}`, Templates may include `{title}`, `{rootpath}`, `{content}`, `{css}`,
`{date}` placeholders. RSS for the diary is written by `:VimwikiRss`. `{date}` placeholders. RSS for the diary is written by `:NuwikiRss`.
============================================================================== ==============================================================================
12. FOLDING *nuwiki-folding* 12. FOLDING *nuwiki-folding*
@@ -636,7 +636,7 @@ match vimwiki. To migrate:
Existing pages, diary entries, tags, and templates work without Existing pages, diary entries, tags, and templates work without
modification. The first workspace scan after launch may show an empty modification. The first workspace scan after launch may show an empty
`:VimwikiCheckLinks` result until the background index completes; `:NuwikiCheckLinks` result until the background index completes;
subsequent runs are instant. subsequent runs are instant.
vim:tw=78:ts=8:ft=help:norl: vim:tw=78:ts=8:ft=help:norl: