[开发工具][学习笔记]: vimwiki上手指北

vim重度依赖者的福音, vimwiki 笔记工具.

如果你舍弃不下vim又贪恋emacs的org-mode, 那么, vimwiki或许是一个选择.

你需要:

• 已经安装vim且版本≥7.4
• 熟悉vim的基本配置和操作

vimwiki能做这些…

• 组织笔记和创意并快速在文档间创建链接
• 管理你的 todo-lists
• 写日记

特性

• 支持三种语法标记: vimwiki, markdown, mediawiki
• 导出到HTML
• 链接其他 wiki 页面和内部文件
• 搜索所有 wiki 页面
• 大纲笔记和任务列表, 不同的缩进
• 快速添加有序/无序列表
• 为 wiki page 添加标签, 并快速定位和跳转
• 自动表格

快速开始

按<Leader>ww来到 index page, 默认的index page地址在~/vimwiki/index.wiki (默认<Leader>为\)
复制以下文字

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

把光标移到Tasks然后按下Enter创建一个链接. 再次按下Enter打开链接文件. 编辑新的页面, 保存它, 然后按下Backspace返回index页面.

多个词, 在visual mode下选中多个词, 添加链接

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

详见:h vimwiki for the full documentation.

基本的语法

# 标题
= Header1 =
== Header2 ==
=== Header3 ===
# 加粗/斜体
*bold text*
_italic text_
# 链接
[[wiki link]]
[[wiki link|description]]
# 列表
* bullet list item 1
* bullet list item 2
    a) numbered list item 1
    b) numbered list item 2
# 代码
{{{python
def greet(s):
    print("Hello, " + s)
}}}
# 表格
| a table |  |
|---------|--|
|         |  |

详见:h vimwiki-syntax

快捷键

<Leader>ww – Open the default wiki index file
打开默认的index file
<Leader>ws – Select and open wiki index file
选择打开wiki index file
<Enter> – Follow/Create wiki link
进入/创建wiki链接
<Backspace> – Go back to parent(previous) wiki link
返回之前页面
<Tab> – Find next wiki link
到下个链接
<Shift-Tab> – Find previous wiki link
到上个链接

详见 :h vimwiki-mappings

命令(函数)

:Vimwiki2HTML – Convert current wiki page to HTML 转换为html
:VimwikiAll2HTML – Convert all your wiki pages to HTML 转换所有到html

For more, see :h vimwiki-commands
更多见: (:h vimwiki-commands)

安装

Use the Plugin-manager of your choice to install vimwiki.

Prerequisites 先决条件

确保你的vimrc配置文件中有如下内容

set nocompatible
filetype plugin on
syntax on

Installation using Vim-Plug

如果你用Vim-Plug管理vim插件
在vimrc配置文件中添加这些:

Plug 'vimwiki/vimwiki'

然后 run :PlugInstall.

如果连接github比较困难, 可以试试国内的gitee

call plug#begin('~/.vim/plugged')
Plug 'https://gitee.com/taoren9153/vimwiki.git'
call plug#end()

vim-plug

如果没有vim-plug
可以试试这两个地址 github

https://github.com/junegunn/vim-github-dashboard.git

或者gitee

https://gitee.com/taoren9153/vim-plug

Ref_1: vimwiki.github.io
Ref_2: vim帮助文档(:h vimwiki)