y0rune/vimwiki
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Some cosmetic changes to the readme

Browse Source
This commit is contained in:
EinfachToll 2015-11-17 15:58:01 +01:00
parent 2c0e6ebfd9
commit 82c435c1e4
2 changed files with 115 additions and 106 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
README-cn.md
View File

@ -1,36 +1,21 @@
一个私人的维基——vim插件 一个私人的维基——vim插件
============================================================================== ==============================================================================
这是http://www.vim.org/scripts/script.php?script_id=2226 的一个镜像。 ![screenshot1](doc/screenshot_1.png)
![screenshot2](doc/screenshot_2.png)
在http://code.google.com/p/vimwiki/ 有部分截图文件。
如果你不喜欢vimball，你也可以在那里找到zip的打包文件。
在安装之前，你需要做的
==============================================================================
确定在`vimrc`中，你的设置是这样的。
set nocompatible
filetype plugin on
syntax on
如果没有他们，Vimwiki将无法正常工作。
介绍 介绍
============================================================================== ------------------------------------------------------------------------------
Vimwiki是私人维基的vim插件 -- 许多有自己代码高亮的text文件。 Vimwiki是私人维基的vim插件 -- 许多有自己代码高亮的text文件。
通过vimwiki，你可以: 通过Vimwiki，你可以:
* 组织笔记和想法 * 组织笔记和想法
* 制作代办事项表 * 制作代办事项表
* 写文档 * 写文档
一个快速的开始，通常使用`<Leader>ww`(一般是'\ww')，然后创建你的index wiki文件。 一个快速的开始，通常使用`<Leader>ww`(一般是`\ww`)，然后创建你的index wiki文件。
通常，它在: 通常，它在:
~/vimwiki/index.wiki ~/vimwiki/index.wiki
@ -42,30 +27,33 @@ Vimwiki是私人维基的vim插件 -- 许多有自己代码高亮的text文件
* Project Gutenberg -- good books are power. * Project Gutenberg -- good books are power.
* Scratchpad -- various temporary stuff. * Scratchpad -- various temporary stuff.
将你的光标放到'Tasks'（任务）上，并且按回车键去创建一个链接。一旦按下，'Task'将会 将你的光标放到`Tasks`（任务）上，并且按回车键去创建一个链接。一旦按下，`Task`将会
变成'[[Tasks]]' -- 一个vimwiki的链接。再按一次回车去打开它。编辑文件，保存它， 变成`[[Tasks]]` -- 一个vimwiki的链接。再按一次回车去打开它。编辑文件，保存它，
然后按backspace来返回你的index。 然后按backspace来返回你的index。
一个vimwiki链接可以一句话创建。只需要通过选择visual模式选择这个句子，然后按回车。 一个vimwiki链接可以一句话创建。只需要通过选择visual模式选择这个句子，然后按回车。
你可以通过选择'Project Gutenberg'来尝试。结果像是这个样子： 你可以通过选择`Project Gutenberg`来尝试。结果像是这个样子：
= My knowledge base = = My knowledge base =
* [[Tasks]] -- things to be done _yesterday_!!! * [[Tasks]] -- things to be done _yesterday_!!!
* [[Project Gutenberg]] -- good books are power. * [[Project Gutenberg]] -- good books are power.
* Scratchpad -- various temporary stuff. * Scratchpad -- various temporary stuff.
更多的选项，请用`:h vimwiki-options`来查看。
基本标记 基本标记
============================================================================== ------------------------------------------------------------------------------
查看`:h vimwiki-syntax`
*bold* -- bold = Header1 =
_italic_ -- italic == Header2 ==
=== Header3 ===
*bold* -- bold text
_italic_ -- italic text
[[wiki link]] -- wiki link
[[wiki link|description]] -- wiki link with description
[[wiki link]] -- link with spaces
[[wiki link|description]] -- link with description
列表: 列表:
@ -84,14 +72,12 @@ Vimwiki是私人维基的vim插件 -- 许多有自己代码高亮的text文件
a) numbered list item 3 a) numbered list item 3
b) numbered list item 4 b) numbered list item 4
= Header1 =
== Header2 == 查看`:h vimwiki-syntax`
=== Header3 ===
键位绑定 键位绑定
============================================================================== ------------------------------------------------------------------------------
查看`:h vimwiki-mappings`
normal 模式: normal 模式:
@ -107,22 +93,39 @@ normal 模式:
* `<Tab>` -- 寻找下一个wiki链接 * `<Tab>` -- 寻找下一个wiki链接
* `<Shift-Tab>` -- 寻找上一个wiki链接 * `<Shift-Tab>` -- 寻找上一个wiki链接
查看`:h vimwiki-mappings`
命令 命令
============================================================================== ------------------------------------------------------------------------------
* `:Vimwiki2HTML` -- 转换当前wiki成为html * `:Vimwiki2HTML` -- 转换当前wiki成为html
* `:VimwikiAll2HTML` -- 转化你的全部wiki到html * `:VimwikiAll2HTML` -- 转化你的全部wiki到html
* `:help vimwiki-commands` -- 显示全部命令 * `:help vimwiki-commands` -- 显示全部命令
安装细节 安装细节
============================================================================== ==============================================================================
在安装之前，你需要做的
------------------------------------------------------------------------------
确定在`vimrc`中，你的设置是这样的。
set nocompatible
filetype plugin on
syntax on
如果没有他们，Vimwiki将无法正常工作。
使用 pathogen (译者注：一个插件) (http://www.vim.org/scripts/script.php?script_id=2332 ) 使用 pathogen (译者注：一个插件) (http://www.vim.org/scripts/script.php?script_id=2332 )
------------------------------------------------------------------------------
cd ~/.vim cd ~/.vim
mkdir bundle mkdir bundle
cd bundle cd bundle
git clone git://github.com/vim-scripts/vimwiki.git git clone https://github.com/vimwiki/vimwiki.git
然后启动vim，使用`:Helptags` 然后 `:help vimwiki`来确保他已经被安装了。 然后启动vim，使用`:Helptags` 然后 `:help vimwiki`来确保他已经被安装了。

102
README.md
View File

@ -1,38 +1,25 @@
A Personal Wiki For Vim Plugin A Personal Wiki For Vim
============================================================================== ==============================================================================
This is a mirror of http://www.vim.org/scripts/script.php?script_id=2226 ![screenshot1](doc/screenshot_1.png)
![screenshot2](doc/screenshot_2.png)
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.
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 Intro
============================================================================== ------------------------------------------------------------------------------
Vimwiki is a personal wiki for Vim -- a number of linked text files that have Vimwiki is a personal wiki for Vim -- a number of linked text files that have
their own syntax highlighting. their own syntax highlighting.
With vimwiki you can: With Vimwiki you can:
* organize notes and ideas; * organize notes and ideas
* manage todo-lists; * manage todo-lists
* write documentation. * 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 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`.
~/vimwiki/index.wiki
Feed it with the following example: Feed it with the following example:
@ -41,32 +28,35 @@ Feed it with the following example:
* Project Gutenberg -- good books are power. * Project Gutenberg -- good books are power.
* Scratchpad -- various temporary stuff. * Scratchpad -- various temporary stuff.
Place your cursor on 'Tasks' and press Enter to create a link. Once pressed, 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 `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 open it. Edit the file, save it, and then press Backspace to jump back to your
index. index.
A vimwiki link can be constructed from more than one word. Just visually 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 select the words to be linked and press Enter. Try it with `Project Gutenberg`.
Gutenberg'. The result should look something like: The result should look something like:
= My knowledge base = = My knowledge base =
* [[Tasks]] -- things to be done _yesterday_!!! * [[Tasks]] -- things to be done _yesterday_!!!
* [[Project Gutenberg]] -- good books are power. * [[Project Gutenberg]] -- good books are power.
* Scratchpad -- various temporary stuff. * Scratchpad -- various temporary stuff.
For the various options see `:h vimwiki-options`.
Basic Markup Basic Markup
============================================================================== ------------------------------------------------------------------------------
see `:h vimwiki-syntax`
*bold* -- bold = Header1 =
_italic_ -- italic == Header2 ==
=== Header3 ===
*bold* -- bold text
_italic_ -- italic text
[[wiki link]] -- wiki link
[[wiki link|description]] -- wiki link with description
[[wiki link]] -- link with spaces
[[wiki link|description]] -- link with description
Lists: Lists:
@ -85,14 +75,12 @@ Lists:
a) numbered list item 3 a) numbered list item 3
b) numbered list item 4 b) numbered list item 4
= Header1 =
== Header2 == For other syntax elements, see `:h vimwiki-syntax`
=== Header3 ===
Key bindings Key bindings
============================================================================== ------------------------------------------------------------------------------
see `:h vimwiki-mappings`
normal mode: normal mode:
@ -108,22 +96,40 @@ normal mode:
* `<Tab>` -- Find next wiki link * `<Tab>` -- Find next wiki link
* `<Shift-Tab>` -- Find previous wiki link * `<Shift-Tab>` -- Find previous wiki link
For more keys, see `:h vimwiki-mappings`
Commands Commands
============================================================================== ------------------------------------------------------------------------------
* `:Vimwiki2HTML` -- Convert current wiki link to HTML * `:Vimwiki2HTML` -- Convert current wiki link to HTML
* `:VimwikiAll2HTML` -- Convert all your wiki links to HTML * `:VimwikiAll2HTML` -- Convert all your wiki links to HTML
* `:help vimwiki-commands` -- list all commands * `:help vimwiki-commands` -- list all commands
Install details
Installation
============================================================================== ==============================================================================
Using pathogen (http://www.vim.org/scripts/script.php?script_id=2332 ) 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 [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332)
------------------------------------------------------------------------------
cd ~/.vim cd ~/.vim
mkdir bundle mkdir bundle
cd bundle cd bundle
git clone git://github.com/vim-scripts/vimwiki.git git clone https://github.com/vimwiki/vimwiki.git
Then launch vim, run `:Helptags` and then `:help vimwiki` to verify it was installed. Or download the [zip archive](https://github.com/vimwiki/vimwiki/archive/master.zip) and extract it in `~/.vim/bundle/`
Then launch Vim, run `:Helptags` and then `:help vimwiki` to verify it was installed.