gffranco/nuwiki
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 3 Wiki Activity

Docs #1

Merged
gffranco merged 15 commits from docs into main 2026-05-30 18:35:41 +00:00
Conversation 0 Commits 15 Files Changed 71
+57 -57
1 changed files with 57 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 8bf20b412d - Show all commits
doc/nuwiki.txt
+57 -57
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: :Vimwiki* - Vimwiki-compatible form: :Nuwiki*
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.
@@ -242,54 +242,54 @@ Only the `:Nuwiki*` form is shown in this document for brevity.
Wiki / navigation ~ Wiki / navigation ~
*:VimwikiIndex* *:NuwikiIndex*
:VimwikiIndex [{count}] :NuwikiIndex [{count}]
Open wiki N's index page (default: 1). Open wiki N's index page (default: 1).
*:VimwikiTabIndex* *:NuwikiTabIndex*
:VimwikiTabIndex [{count}] :NuwikiTabIndex [{count}]
Same, in a new tab. Same, in a new tab.
*:VimwikiUISelect* *:NuwikiUISelect*
:VimwikiUISelect :NuwikiUISelect
Pick a wiki from a list (multi-wiki only). Uses |vim.ui.select| on Pick a wiki from a list (multi-wiki only). Uses |vim.ui.select| on
Neovim, |inputlist()| on Vim. Neovim, |inputlist()| on Vim.
*:VimwikiGoto* *:NuwikiGoto*
:VimwikiGoto {page} :NuwikiGoto {page}
Open `{page}.wiki` by name. Open `{page}.wiki` by name.
*:VimwikiFollowLink* *:NuwikiFollowLink*
:VimwikiFollowLink :NuwikiFollowLink
Follow the link under the cursor. Follow the link under the cursor.
*:VimwikiBacklinks* *:NuwikiBacklinks*
:VimwikiBacklinks :NuwikiBacklinks
Show all references to the current page. Show all references to the current page.
*:VimwikiNextLink* *:NuwikiNextLink*
:VimwikiNextLink :NuwikiNextLink
*:VimwikiPrevLink* *:NuwikiPrevLink*
:VimwikiPrevLink :NuwikiPrevLink
Jump to the next / previous wikilink on the page. Jump to the next / previous wikilink on the page.
*:VimwikiBaddLink* *:NuwikiBaddLink*
:VimwikiBaddLink :NuwikiBaddLink
Add the target of the link under the cursor to the buffer list. Add the target of the link under the cursor to the buffer list.
*:VimwikiRenameFile* *:NuwikiRenameFile*
:VimwikiRenameFile :NuwikiRenameFile
Prompt for a new name; rename the current page and rewrite every Prompt for a new name; rename the current page and rewrite every
inbound link. inbound link.
*:VimwikiDeleteFile* *:NuwikiDeleteFile*
:VimwikiDeleteFile :NuwikiDeleteFile
Delete the current page and its on-disk file. Delete the current page and its on-disk file.
Diary ~ Diary ~
*:VimwikiMakeDiaryNote* *:NuwikiMakeDiaryNote*
:VimwikiMakeDiaryNote :NuwikiMakeDiaryNote
Open today's diary entry. With `diary_frequency = 'weekly'` (or Open today's diary entry. With `diary_frequency = 'weekly'` (or
`'monthly'` / `'yearly'`) this addresses this week's / this month's `'monthly'` / `'yearly'`) this addresses this week's / this month's
/ this year's entry instead. The file stems follow: / this year's entry instead. The file stems follow:
@@ -299,74 +299,74 @@ Diary ~
monthly YYYY-MM 2026-05.wiki monthly YYYY-MM 2026-05.wiki
yearly YYYY 2026.wiki yearly YYYY 2026.wiki
*:VimwikiMakeYesterdayDiaryNote* *:NuwikiMakeYesterdayDiaryNote*
:VimwikiMakeYesterdayDiaryNote :NuwikiMakeYesterdayDiaryNote
*:VimwikiMakeTomorrowDiaryNote* *:NuwikiMakeTomorrowDiaryNote*
:VimwikiMakeTomorrowDiaryNote :NuwikiMakeTomorrowDiaryNote
Step the diary back / forward by one period at the configured Step the diary back / forward by one period at the configured
cadence. cadence.
*:VimwikiDiaryIndex* *:NuwikiDiaryIndex*
:VimwikiDiaryIndex :NuwikiDiaryIndex
Open the diary index page. Open the diary index page.
*:VimwikiDiaryGenerateLinks* *:NuwikiDiaryGenerateLinks*
:VimwikiDiaryGenerateLinks :NuwikiDiaryGenerateLinks
Rebuild the diary index page from the entries currently on disk. Rebuild the diary index page from the entries currently on disk.
*:VimwikiDiaryNextDay* *:NuwikiDiaryNextDay*
:VimwikiDiaryNextDay :NuwikiDiaryNextDay
*:VimwikiDiaryPrevDay* *:NuwikiDiaryPrevDay*
:VimwikiDiaryPrevDay :NuwikiDiaryPrevDay
Walk to the next / previous indexed diary entry at the same cadence Walk to the next / previous indexed diary entry at the same cadence
as the current one. as the current one.
Page generation ~ Page generation ~
*:VimwikiTOC* *:NuwikiTOC*
:VimwikiTOC :NuwikiTOC
Generate or refresh the table of contents on the current page. Generate or refresh the table of contents on the current page.
*:VimwikiGenerateLinks* *:NuwikiGenerateLinks*
:VimwikiGenerateLinks :NuwikiGenerateLinks
Insert a flat list of every page in the wiki under the cursor. Insert a flat list of every page in the wiki under the cursor.
*:VimwikiCheckLinks* *:NuwikiCheckLinks*
:VimwikiCheckLinks :NuwikiCheckLinks
Send every broken link in the workspace to the |quickfix| list. Send every broken link in the workspace to the |quickfix| list.
Tags ~ Tags ~
*:VimwikiSearchTags* *:NuwikiSearchTags*
:VimwikiSearchTags {tag} :NuwikiSearchTags {tag}
Quickfix listing every `:tag:` occurrence. Quickfix listing every `:tag:` occurrence.
*:VimwikiGenerateTagLinks* *:NuwikiGenerateTagLinks*
:VimwikiGenerateTagLinks [tag] :NuwikiGenerateTagLinks [tag]
Insert a section linking every page that has `<tag>`. With no Insert a section linking every page that has `<tag>`. With no
argument, generates a section per tag found in the workspace. argument, generates a section per tag found in the workspace.
*:VimwikiRebuildTags* *:NuwikiRebuildTags*
:VimwikiRebuildTags :NuwikiRebuildTags
Force a full workspace re-index. Force a full workspace re-index.
HTML export ~ HTML export ~
*:Vimwiki2HTML* *:Nuwiki2HTML*
:Vimwiki2HTML :Nuwiki2HTML
Render the current page to HTML. Render the current page to HTML.
*:Vimwiki2HTMLBrowse* *:Nuwiki2HTMLBrowse*
:Vimwiki2HTMLBrowse :Nuwiki2HTMLBrowse
Render the current page and open it in the default browser. Render the current page and open it in the default browser.
*:VimwikiAll2HTML* *:NuwikiAll2HTML*
:VimwikiAll2HTML[!] :NuwikiAll2HTML[!]
Export every page in the wiki. `!` forces a full rebuild; otherwise Export every page in the wiki. `!` forces a full rebuild; otherwise
only out-of-date pages are re-rendered. only out-of-date pages are re-rendered.
*:VimwikiRss* *:NuwikiRss*
:VimwikiRss :NuwikiRss
Write `rss.xml` summarising recent diary entries. Write `rss.xml` summarising recent diary entries.
Other ~ Other ~