A wiki plugin for Vim
This is a Vim and neovim plugin for writing and maintaining a personal wiki. The plugin was initially based on vimwiki, but it is written mostly from scratch and is based on a more "do one thing and do it well" philosophy.
This README file contains basic information on how to get started, as well as a list of available features. For more details, please read the full documentation.
Note: wiki.vim
is not a filetype plugin. It is designed to be used with
filetype plugins, e.g. dedicated Markdown plugins. Users are adviced to
read :help wiki-intro-plugins
for a list of plugins that work well with
wiki.vim
.
Note: wiki.vim
requires Vim 9.1 or Neovim 0.9.5.
If you use vim-plug, then add the
following line to your vimrc
file:
Plug 'lervag/wiki.vim'
Or use some other plugin manager:
This outlines the basic steps to get started:
Create a wiki directory where the wiki files should be stored, for instance
~/wiki
.
Add the following to your vimrc
file:
let g:wiki_root = '~/wiki'
Now you can open the index file (by default index.wiki
) with <leader>ww
and start to add your notes as desired.
Please also read the Guide
section in the documentation.
g:wiki_root
)
WikiIndex
to open the indexWikiJournal
to open the journalWikiPages
to select from list of all pagesWikiTags
to select from list of tagsWikiToc
)WikiTocGenerate
)WikiLinkIncomingToggle
)iu au
Link URLit at
Link text<c-j>
and <c-k>
:WikiExport
command for exporting to e.g. pdf
with pandoc
Without vimwiki, this plugin would never
have existed. So my thanks go to the smart people that developed and maintains
vimwiki
, both for the inspiration and for the ideas.
Feel free to consider any of the many available alternatives. There are likely many more, but these are the ones I'm aware of: