Vim script
Clone or download
habamax and vim-scripts Version 2.1
    * Concealing of links can be turned off - set |g:vimwiki_url_maxsave| to 0.
      The option g:vimwiki_url_mingain was removed
    * |g:vimwiki_folding| also accepts value 'list'; with 'expr' both sections
      and code blocks folded, g:vimwiki_fold_lists option was removed
    * Issue 261: Syntax folding is back. |g:vimwiki_folding| values are
      changed to '', 'expr', 'syntax'.
    * Issue 372: Ignore case in g:vimwiki_valid_html_tags
    * Issue 374: Make autowriteall local to vimwiki. It is not 100% local
    * Issue 384: Custom_wiki2html script now receives templating arguments
    * Issue 393: Custom_wiki2html script path can contain tilde character
    * Issue 392: Custom_wiki2html arguments are quoted, e.g names with spaces
    * Various small bug fixes.
Latest commit cb5c38a Apr 14, 2013
Failed to load latest commit information.
autoload/vimwiki Version 2.1 Apr 26, 2013
doc Version 2.1 Apr 26, 2013
ftplugin Version 2.1 Apr 26, 2013
plugin Version 2.1 Apr 26, 2013
syntax Version 2.1 Apr 26, 2013
README Version 2.0.stu Jun 9, 2012


This is a mirror of

A Personal Wiki For Vim Plugin
Screenshots are available on 
There are also zipped vimwiki files there in case you do not like vimball archives.

Make sure you have these settings in your vimrc file: 

set nocompatible
filetype plugin on
syntax on

Without them Vimwiki will not work properly.

Vimwiki is a personal wiki for Vim -- a number of linked text files that have
their own syntax highlighting.

With vimwiki you can:
    - organize notes and ideas;
    - manage todo-lists;
    - write documentation.

To do a quick start press <Leader>ww (this is usually \ww) to go to your index
wiki file.  By default it is located in: 

Feed it with the following example:

= My knowledge base =
    * Tasks -- things to be done _yesterday_!!!
    * Project Gutenberg -- good books are power.
    * Scratchpad -- various temporary stuff.

Place your cursor on 'Tasks' and press Enter to create a link.  Once pressed,
'Tasks' will become '[[Tasks]]' -- a vimwiki link.  Press Enter again to
open it.  Edit the file, save it, and then press Backspace to jump back to your

A vimwiki link can be constructed from more than one word.  Just visually
select the words to be linked and press Enter.  Try it with 'Project
Gutenberg'.  The result should look something like:

= My knowledge base =
    * [[Tasks]] -- things to be done _yesterday_!!!
    * [[Project Gutenberg]] -- good books are power.
    * Scratchpad -- various temporary stuff.

For the various options see :h vimwiki-options.

Basic Markup
see :h vimwiki-syntax

*bold* -- bold 
_italic_ -- italic 

[[wiki link]] -- link with spaces
[[wiki link|description]] -- link with description

* bullet list item 1
    - bullet list item 2
    - bullet list item 3
        * bullet list item 4
        * bullet list item 5
* bullet list item 6
* bullet list item 7
    - bullet list item 8
    - bullet list item 9

# numbered list item 1
# numbered list item 2
    # numbered list item 3
    # numbered list item 4

= Header1 =
== Header2 ==
=== Header3 ===

Key bindings
see :h vimwiki-mappings

normal mode: 
<Leader>ww -- Open default wiki index file.
<Leader>wt -- Open default wiki index file in a new tab.
<Leader>ws -- Select and open wiki index file.
<Leader>wd -- Delete wiki file you are in.
<Leader>wr -- Rename wiki file you are in.
<Enter> -- Folow/Create wiki link
<Shift-Enter> -- Split and folow/create wiki link
<Ctrl-Enter> -- Vertical split and folow/create wiki link
<Backspace> -- Go back to parent(previous) wiki link
<Tab> -- Find next wiki link
<Shift-Tab> -- Find previous wiki link

:Vimwiki2HTML -- Convert current wiki link to HTML
:VimwikiAll2HTML -- Convert all your wiki links to HTML