vimwiki /vimwiki

Personal Wiki for Vim

★ 9,521⑂ 650👁 108⑃ 354● 1,133▤ 12
Vim ScriptNOASSERTIONCreated 2012-11-15vimwiki.github.io/
Download: v2024.01.24v2024.01.24 ↓2024.01.242024-01-25
+1
Daily
9,521
stars
650
forks
108
watchers
354
prs
1,133
issues
12
releases

README

!VimWiki: A Personal Wiki For Vim

中文

- Intro
- Screenshots
- Installation
    - Prerequisites
    - VIM Packages
    - Pathogen
    - Vim-Plug
    - Vundle
    - Lazy

- Basic Markup
    - Lists
- Key Bindings
- Commands
- Changing Wiki Syntax
- Getting Help
- Helping VimWiki
- Wiki
- License

----

 Introduction

VimWiki is a personal wiki for Vim -- a number of linked text files that have
their own syntax highlighting. See the VimWiki Wiki
for an example website built with VimWiki!

If you are interested in contributing see this section.

With VimWiki, you can:

- Organize notes and ideas
- Manage to-do lists
- Write documentation
- Maintain a diary
- Export everything to HTML

To do a quick start, press ww (default is \ww) to go to your index
wiki file. By default, it is located in ~/vimwiki/index.wiki. See
:h vimwiki_list for registering a different path/wiki.

Feed it with the following example:

text
= 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
index.

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:

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


 Screenshots

!Lists View
!Entries View
!Todos View
!Wiki View

 Installation

VimWiki has been tested on Vim = 7.3. It may work on older versions but
will not be officially supported.  It is known to work on NeoVim, although
it is likely to have
NeoVim-specific bugs.

 Prerequisites

Make sure you have these settings in your vimrc file:

vim
set nocompatible
filetype plugin on
syntax on


Without them, VimWiki will not work properly.

 Installation using Vim packages (since Vim 7.4.1528)

sh

git clone https://github.com/vimwiki/vimwiki.git ~/.vim/pack/plugins/start/vimwiki

 to generate documentation i.e. ':h vimwiki'
vim -c 'helptags ~/.vim/pack/plugins/start/vimwiki/doc' -c quit



Notes:

- See :h helptags for issues with installing the documentation.
- For general information on vim packages see :h packages.

 Installation using Pathogen

sh

cd ~/.vim
mkdir bundle
cd bundle
git clone https://github.com/vimwiki/vimwiki.git



 Installation using Vim-Plug

Add the following to the plugin-configuration in your vimrc:

vim

Plug 'vimwiki/vimwiki'



Then run :PlugInstall.

 Installation using Vundle

Add Plugin 'vimwiki/vimwiki' to your vimrc file and run:

sh

vim +PluginInstall +qall



 Installation using Lazy

Add repository within require('lazy').setup call in your vimrc (or for plugins f

Top issues

Latest release

v2024.01.24 v2024.01.24 2024-01-25
2022.01.24

A minor documentation release.

 New

 Docs: describe undocumented key mappings by @qadzek in https://github.com/vimwiki/vimwiki/pull/1389
 README.md: Tidy, remove pointers to defunct Matrix channel and Google Group, add wikis.world Mastodon account.

 New Contributors

 @qadzek made their first contribution in https://github.com/vimwiki/vimwiki/pull/1389

Full Changelog: https://github.com/vimwiki/vimwiki/compare/v2024.01.22...v2024.01.24

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON