y0rune/vimwiki
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
34 Commits 1 Branch 8 Tags 6 MiB
MediaWiki 61.5%
Vim script 36.9%
Shell 0.8%
CSS 0.7%
04c149bb0c
Go to file
Maxim Kim 04c149bb0c Version 0.9.7 
* NEW: Default checkbox symbols are changed to [ ], [.], [o], [O], [X].
  You can change them using |g:vimwiki-listsyms| variable.
* NEW: Color group names are renamed from wikiBold, wikiItalic, etc to
  VimwikiBold, VimwikiItalic, etc.
* NEW: Open external links in a browser. There are default browsers
  defined in |g:vimwiki_browsers| list. You can also redefine
  |VimwikiWeblinkHandler| function to open weblinks in other programs.
* NEW: Issue 25: Toggle the states of multiple TODO list items at a time
  (in VISUAL and in VISUAL LINE modes)
* NEW: Issue 26: Highlight code snippets in vimwiki's pre. See
  |vimwiki-option-nested_syntaxes|. Thanks kriomant.
* NEW: Issue 27: Automatic garbage deletion from html directory.
* NEW: Save all open vimwiki buffers before export to html.
* NEW: Issue 29: Custom :Search command.
* NEW: Header text objects are now expandable in VISUAL mode. Tap 'vah' to
  select a header. Tap again 'ah' to expand selection further. Thanks
  Andy Wokula.
* FIX: Folding settings are reset to vim defaults in a new tab (think of
  \wt) so you cannot hide things in folds.
* FIX: https links in form of [https://hello.world.com] are not exported
  into html. Thanks Saurabh Sarpal for the patch.
0001-01-01 00:00:00 +00:00
README Version 0.1: Initial upload 0001-01-01 00:00:00 +00:00
vimwiki_0_9_7.vba Version 0.9.7 0001-01-01 00:00:00 +00:00

README 

This is a mirror of http://www.vim.org/scripts/script.php?script_id=2226

A Personal Wiki For Vim Plugin
==============================================================================
Screenshots are available on http://code.google.com/p/vimwiki/ 
There are also zipped vimwiki files there in case you do not like vimball archives.

Vimwiki quick reference card http://habamax.ru/myvim/data/vimwikiqrc.pdf by J.A.J. Pater.
Thx Gager Jacob for the update.


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.


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

Feed it with the following example:

= My knowledge base =
    * MyUrgentTasks -- things to be done _yesterday_!!!
    * ProjectGutenberg -- good books are power.
    * ScratchPad -- various temporary stuff.


Notice that ProjectGutenberg, MyUrgentTasks and ScratchPad highlighted as
errors. These are links in CamelCase form that do not exists yet. (CamelCase
form -- capitalized word connected with other capitalized words)

Place cursor on ProjectGutenberg and press <Enter>. Now you are in
ProjectGutenberg. Edit and save it, then press Backspace to return to parent
wiki page. You should see the difference now -- ProjectGutenberg is
highlighted as a link.


For the various options see :h vimwiki-options.


Basic Markup
==============================================================================
see :h vimwiki-syntax

*bold* -- bold 
_italic_ -- italic 
WikiWord -- link to WikiWord 
[[wiki link]] -- link with spaces
[[wiki link][description]] -- link with description
[[wiki link|description]] -- 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

# 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


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