aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authormoxie <moxie@3kgcat.fi>2026-03-15 23:56:23 +0200
committermoxie <moxie@3kgcat.fi>2026-03-15 23:58:12 +0200
commit2e831e569296acc3f90f83a1b8c5dd79c0631175 (patch)
treec6aaaa3716fc7ce0b9fdce52a02dbc8725ccdb7f /doc
parentc7a268de6279f4aef74e5d410c8cb084b55f8bc8 (diff)
chore: update readme/doc
Diffstat (limited to 'doc')
-rw-r--r--doc/muwiki.txt16
1 files changed, 14 insertions, 2 deletions
diff --git a/doc/muwiki.txt b/doc/muwiki.txt
index e4d06de..c22acb1 100644
--- a/doc/muwiki.txt
+++ b/doc/muwiki.txt
@@ -73,6 +73,14 @@ dirs List of wiki directories.
index_file Name of the index file for each wiki.
Default: 'index.md'
+ *muwiki-opt-text_extensions*
+text_extensions List of file extensions that open directly in Neovim
+ for file:// links. Files with matching extensions
+ bypass xdg-open and open in a Neovim buffer.
+ Extensions can be specified with or without leading
+ dot (e.g., 'txt' or '.txt').
+ Default: {}
+
Example Configuration~
>
local muwiki = require('muwiki')
@@ -83,6 +91,9 @@ Example Configuration~
{ name = 'work', path = '~/work/wiki' },
},
index_file = 'index.md',
+ -- Open these file types directly in Neovim (bypass xdg-open)
+ -- Note: Even binary files like PNG can be opened in Neovim
+ text_extensions = { 'txt', 'md', 'png' },
})
<
@@ -120,8 +131,9 @@ muwiki.setup({opts}) *muwiki.setup()*
muwiki.open_link() *muwiki.open_link()*
Open the link under cursor.
- Wiki links: open in Neovim buffer
- - Web links: open with xdg-open
- - File links: open with xdg-open
+ - Web links (http/https): open with xdg-open
+ - File links (file://): open with xdg-open, unless the file extension
+ matches |muwiki-opt-text_extensions|, in which case opens in Neovim
muwiki.next_link() *muwiki.next_link()*
Jump to the next markdown link in the buffer.