A very minimal wiki plugin for Neovim relying on vim-markdown, telescope.nvim and plenary.nvim.
- Binding to open
index.md - Telescope pickers for
mdfiles in a globally set wiki dir:- file search
- titles (using
yaml-block) - keywords (using
yaml-block) - outgoing
mdlinks - string grep
- custom action to insert relative link to another
mdfile as text (<C-K>) or as a link insert (<C-L>)
- simple pandoc export for single or all files to html
- open
htmlfile formdthat is currently open - create link for word under cursor or visual selection
- vim-markdown
- telescope.nvim
- telescope-file-browser.nvim (optional)
- plenary.nvim
- ripgrep
- pandoc (for optional html export)
Using vim-plug:
# Install telescope
Plug 'nvim-telescope/telescope.nvim' " needed
Plug 'nvim-telescope/telescope-file-browser.nvim' " optional
" Install plenary
Plug 'nvim-lua/plenary.nvim'
" Install markdown plugin
Plug 'plasticboy/vim-markdown'
" Install this plugin
Plug 'LarsHaalck/wiki.nvim'Default Config:
require('wiki').setup {
wiki_dir = '~/.notes',
export_dir = '~/.notes/export',
pandoc_args = {
'--mathjax',
'--standalone',
}
}Just copy the pandoc lua-filter file md-to-html.lua somewhere and add a line to pandoc args:
require('wiki').setup {
-- ...
pandoc_args = {
-- ...
'--lua-filter=<PATH_TO_DIR>/md-to-html.lua',
-- ...
}
}When translating md to html files in some output directory, relative links to images won't work anymore.
By using the following pandoc filter, relative links are translated to absolute links.
Just copy the pandoc lua-filter file img-src-translate.lua somewhere and add a line to pandoc args:
require('wiki').setup {
-- ...
pandoc_args = {
-- ...
'--lua-filter=<PATH_TO_DIR>/img-src-translate.lua',
-- ...
}
}Example:
nnoremap <silent> <leader>ww <cmd>lua require('wiki').open_index()<CR>
nnoremap <silent> <leader>wf <cmd>lua require('telescope').extensions.wiki.files()<CR>
nnoremap <silent> <leader>wt <cmd>lua require('telescope').extensions.wiki.titles()<CR>
nnoremap <silent> <leader>wk <cmd>lua require('telescope').extensions.wiki.keywords()<CR>
nnoremap <silent> <leader>wo <cmd>lua require('telescope').extensions.wiki.outgoing()<CR>
nnoremap <silent> <leader>wg <cmd>lua require('telescope').extensions.wiki.live_grep()<CR>
nnoremap <silent> <leader>wb <cmd>lua require('telescope').extensions.wiki.browser()<CR>
nnoremap <silent> <leader>wh <cmd>lua require('wiki').open_html()<CR>
nnoremap <silent> <leader>wl <cmd>lua require('wiki').create_link()<CR>
vnoremap <silent> <leader>wl <cmd>lua require('wiki').create_link()<CR>
command! WikiExportAll lua require('wiki').export_all()<CR>
command! WikiExport lua require('wiki').export()<CR>