Version 2.0.stu
This release is partly incompatible with 1.2. You should delete previous version of vimwiki before install. = Summary = * Quick page-link creation. * Redesign of link syntaxes (!) * No more CamelCase links. Check the ways to convert them http://goo.gl/15ctX * No more [[link][desc]] links. * No more [http://link description] links. * No more plain image links. Use transclusions. * No more image links identified by extension. Use transclusions. * Interwiki links. * Link schemes. * Transclusions. * Normalize link command. * Improved diary organization and generation. * List manipulation. * Markdown support. * Mathjax support. * Improved handling of special characters and punctuation in filenames and urls. * Back links command: list links referring to the current page. * Highlighting nonexisted links are off by default. * Table syntax change. Row separator uses | instead of +. * Fold multilined list items. * Custom wiki to HTML converters. * Conceal long weblinks. * Option to disable table mappings. For detailed information see issues list on http://code.google.com/p/vimwiki/issues/list
This commit is contained in:
39
README
39
README
@ -5,8 +5,6 @@ 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://vimwiki.googlecode.com/hg/misc/Vimwiki1.1.1QR.pdf.
|
||||
|
||||
|
||||
Prerequisites
|
||||
==============================================================================
|
||||
@ -24,31 +22,35 @@ 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
|
||||
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:
|
||||
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.
|
||||
* 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.
|
||||
|
||||
Notice that !ProjectGutenberg, !MyUrgentTasks and !ScratchPad curly underlined.
|
||||
These are links in CamelCase form that do not exists yet. (CamelCase
|
||||
form -- capitalized word connected with other capitalized words)
|
||||
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:
|
||||
|
||||
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.
|
||||
= 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.
|
||||
@ -60,9 +62,8 @@ 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:
|
||||
|
Reference in New Issue
Block a user