Repository files navigation

中文

• Intro
• Screenshots
• Installation
  • Prerequisites
  • VIM Packages
  • Pathogen
  • Vim-Plug
  • Vundle
• Basic Markup
  • Lists
• Key Bindings
• Commands
• Changing Wiki Syntax
• Getting Help
• Helping VimWiki
• Wiki
• License

VimWiki is a personal wiki for Vim -- a number of linked text files that havetheir own syntax highlighting. See theVimWiki Wikifor an example website built with VimWiki!

If you are interested in contributing seethis 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<Leader>ww (default is\ww) to go to your indexwiki 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:

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

Place your cursor onTasks and press Enter to create a link. Once pressed,Tasks will become[[Tasks]] -- a VimWiki link. Press Enter again toopen it. Edit the file, save it, and then press Backspace to jump back to yourindex.

A VimWiki link can be constructed from more than one word. Just visuallyselect the words to be linked and press Enter. Try it, withProject 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.

VimWiki has been tested onVim >= 7.3. It may work on older versions butwill not be officially supported. It is known to work on NeoVim, althoughit is likely to haveNeoVim-specific bugs.

Make sure you have these settings in your vimrc file:

setnocompatiblefiletypepluginonsyntaxon

Without them, VimWiki will not work properly.

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.

cd~/.vimmkdir bundlecd bundlegit clone https://github.com/vimwiki/vimwiki.git

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

Plug'vimwiki/vimwiki'

Then run:PlugInstall.

AddPlugin 'vimwiki/vimwiki' to your vimrc file and run:

vim +PluginInstall +qall

Download thezip archiveand extract it in~/.vim/bundle/

Then launch Vim, run:Helptags and then:help vimwiki to verify it wasinstalled.

= Header1 === Header2 ===== Header3 ===*bold* -- bold text_italic_ -- italic text[[wiki link]] -- wiki link[[wiki link|description]] -- wiki 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 91. numbered list item 12. numbered list item 2    a) numbered list item 3    b) numbered list item 4

For other syntax elements, see:h vimwiki-syntax

  - [.] Partially completed item with sub-tasks    - [X] Completed sub-task    - [ ] Incomplete sub-task    - [ ] Other incomplete sub-task  - [ ] Incomplete item

Note: your terminal may prevent capturing some of the default bindingslisted below. See:h vimwiki-local-mappings for suggestions for alternativebindings if you encounter a problem.

• <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> -- Follow/Create wiki link.
• <Shift-Enter> -- Split and follow/create wiki link.
• <Ctrl-Enter> -- Vertical split and follow/create wiki link.
• <Backspace> -- Go back to parent(previous) wiki link.
• <Tab> -- Find next wiki link.
• <Shift-Tab> -- Find previous wiki link.

Refer to the complete documentation at:h vimwiki-mappings to see manymore bindings.

• :Vimwiki2HTML -- Convert current wiki link to HTML.
• :VimwikiAll2HTML -- Convert all your wiki links to HTML.
• :help vimwiki-commands -- List all commands.
• :help vimwiki -- General vimwiki help docs.

VimWiki currently ships with 3 syntaxes: VimWiki (default), Markdown(markdown), and MediaWiki (media). Of these, the native VimWiki syntax isbest supported, followed by Markdown. No promises are made for MediaWiki.

NOTE: Only the default syntax ships with a built-in HTML converter. ForMarkdown or MediaWiki see:h vimwiki-option-custom_wiki2html. Some examplesand 3rd party tools are availablehere.

If you would prefer to use either Markdown or MediaWiki syntaxes, set thefollowing option in your.vimrc:

letg:vimwiki_list= [{'path':'~/vimwiki/',\'syntax':'markdown','ext':'md'}]

This option will treat all markdown files in your system as part of vimwiki(checkset filetype?). Add

letg:vimwiki_global_ext=0

to your.vimrc to restrict Vimwiki's operation to only those paths listed ing:vimwiki_list. Other markdown files wouldn't be treated as wiki pages.Seeg:vimwiki_global_ext.

if you want to turn off support for other extension(for example, disablingaccidently creating new wiki and link for normal markdown files), set thefollowing option in your.vimrc before packadd vimwiki:

letg:vimwiki_ext2syntax= {}

Seeg:vimiki_ext2syntax

GitHub issues are the primarymethod for raising bug reports or feature requests.

Additional resources:

• The IRC channel #vimwiki onirc.libera.chat is the "official" discussion and support channel
  • Connect via webchat
• @vimwiki@wikis.world on the Fediverse

VimWiki has a lot of users but only very few recurring developers or peoplehelping the community. Your help is therefore appreciated. Everyone can help!See#625 for information on howyou can help.

Also, take a look atCONTRIBUTING.mdanddesign_notes.md

MIT License

Copyright (c) 2008-2010 Maxim Kim2013-2017 Daniel Schemala

Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THESOFTWARE.