vimwiki/README.md at 0678df38e9df7f2c768fa92789bc1772e51f875c

y0rune/vimwiki

Fork 0

AresMegaGlobal b1c009c1df

VimWiki2HTML -> lowercase 'w' in readme

2019-05-15 23:08:46 -04:00

6.9 KiB

Raw Blame History

中文

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

Intro

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 to-do lists
Write documentation
Maintain a diary
Export everything to HTML

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 ~/vimwiki/index.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 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:


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

Screenshots

Installation

Prerequisites

Make sure you have these settings in your vimrc file:


set nocompatible
filetype plugin on
syntax on

Without them VimWiki will not work properly.

Installation using Vim packages (since Vim 7.4.1528)


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

Installation using Pathogen


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:


Plug 'vimwiki/vimwiki'

Then run :PlugInstall.

Installation using Vundle

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


vim +PluginInstall +qall

Or download the zip archive and extract it in ~/.vim/bundle/

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

Basic Markup

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


*bold* -- bold text
_italic_ -- italic text

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

Lists:

* 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

1. numbered list item 1
2. numbered list item 2
    a) numbered list item 3
    b) numbered list item 4

For other syntax elements, see :h vimwiki-syntax

Key bindings

Normal mode

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

Basic key bindings

<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

Advanced key bindings

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

Commands

: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

Changing Wiki Syntax

VimWiki currently ships with 3 syntaxes: VimWiki (default), Markdown (markdown), and MediaWiki (media)

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


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

Getting help

Have a question? Visit the IRC channel #vimwiki on Freenode (webchat, also synced to Matrix/Riot: #freenode_#vimwiki:matrix.org) or post to the mailing list.

Helping VimWiki

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

License

MIT License

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

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

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 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 THE SOFTWARE.

6.9 KiB Raw Blame History