About this project
VimWiki is a personal wiki plugin for Vim that turns plain text files into a linked knowledge base with its own syntax highlighting. It is designed for organizing notes and ideas, managing to-do lists, writing documentation, and maintaining a diary, with the ability to export everything to HTML.
The plugin works with Vim 7.3 and above and is known to work on NeoVim, though NeoVim-specific bugs may exist. Installation is supported through Vim's native package system, Pathogen, Vim-Plug, Vundle, Lazy.nvim, or manual download.
VimWiki provides a simple markup syntax for headers, bold and italic text, wiki links, bullet and numbered lists, and todo lists with completion states. Wiki links are created by placing the cursor on text and pressing Enter, which wraps the text in double brackets. Multi-word links can be created by visually selecting the words first.
Navigation is handled through key bindings: pressing Enter follows or creates a wiki link, Backspace returns to the parent page, Tab and Shift-Tab cycle through links, and Shift-Enter or Ctrl-Enter open links in split windows. The default index file is located at ~/vimwiki/index.wiki and can be opened with the Leader-ww shortcut.
VimWiki ships with three syntax modes: the native VimWiki syntax (best supported), Markdown, and MediaWiki. Only the native syntax includes a built-in HTML converter; Markdown and MediaWiki users can configure external converters. The plugin can be configured to treat all files of a given extension as wiki pages or restricted to specific paths.
Commands include Vimwiki2HTML for converting the current page and VimwikiAll2HTML for converting all wiki pages. Full documentation is available via :help vimwiki.
The project is licensed under the MIT License and welcomes contributions through GitHub issues and the IRC channel on Libera Chat.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.