From 7ffc295094debc3d521cecf267d736cc8562c20e Mon Sep 17 00:00:00 2001 From: "CUI Hao (Lab)" Date: Mon, 8 Oct 2018 23:12:57 +0800 Subject: [PATCH] Update Chinese readme & add links to each readme --- README-cn.md | 140 +++++++++++++++++++++++++++++++-------------------- README.md | 2 + 2 files changed, 87 insertions(+), 55 deletions(-) diff --git a/README-cn.md b/README-cn.md index d00bf95..60574ae 100644 --- a/README-cn.md +++ b/README-cn.md @@ -1,63 +1,62 @@ -一个私人的维基——vim插件 +VimWiki —— Vim 个人 Wiki 插件 ============================================================================== +[English](README.md) + ![screenshot1](doc/screenshot_1.png) -![screenshot2](doc/screenshot_2.png) +![screenshot2](doc/screenshot_2.png) * 介绍 ------------------------------------------------------------------------------ -Vimwiki是私人维基的vim插件 -- 许多有自己代码高亮的text文件。 +Vimwiki 是 Vim 中的个人 Wiki —— 一组链接起来的、有独特语法高亮的文本文件。 -通过Vimwiki，你可以: +通过 Vimwiki，你可以: * 组织笔记和想法 - * 制作代办事项表 - * 写文档 + * 管理待办事项 + * 编写文档 + * 坚持写日记 + * 将这一切导出成 HTML 网页 -一个快速的开始，通常使用`ww`(一般是`\ww`)，然后创建你的index wiki文件。 -通常，它在: +马上开始！按下 `ww`（通常是 `\ww`）进入作为目录页的 wiki 文件，这个文件默认存放在 `~/vimwiki/index.wiki`。 - ~/vimwiki/index.wiki +在该文件中输入以下示例： -在这个文件，输入如下的例子： + = 我的个人知识库 = + * 任务列表 -- _昨天_ 就该完成的事！！！ + * Gutenberg 计划 -- 好书给我力量。 + * 草稿 -- 临时记录一些东西。 - = My knowledge base = - * Tasks -- things to be done _yesterday_!!! - * Project Gutenberg -- good books are power. - * Scratchpad -- various temporary stuff. +把光标移到 `任务` 二字上，按 Enter（回车）创建链接。按下后，`任务`二字会变成 `[[任务]]` —— 这是一个 Vimwiki 链接。再次按 Enter 即可进入这个链接（打开新的 wiki 文件）。编辑这个新文件，保存，然后按 Backspace（退格）就能回到目录页。 -将你的光标放到`Tasks`（任务）上，并且按回车键去创建一个链接。一旦按下，`Task`将会 -变成`[[Tasks]]` -- 一个vimwiki的链接。再按一次回车去打开它。编辑文件，保存它， -然后按backspace来返回你的index。 +如果 Vimwiki 链接长度不止一个单词（指的是英文单词），只需在 Visual 模式选择这段文本后按 Enter 即可。用上面的 `Gutenberg 计划` 试试吧。最终结果是这样： -一个vimwiki链接可以一句话创建。只需要通过选择visual模式选择这个句子，然后按回车。 -你可以通过选择`Project Gutenberg`来尝试。结果像是这个样子： - - = My knowledge base = - * [[Tasks]] -- things to be done _yesterday_!!! - * [[Project Gutenberg]] -- good books are power. - * Scratchpad -- various temporary stuff. + = 我的个人知识库 = + * [[任务列表]] -- _昨天_ 就该完成的事！！！ + * [[Gutenberg 计划]] -- 好书给我力量。 + * 草稿 -- 临时记录一些东西。 基本标记 ------------------------------------------------------------------------------ - = Header1 = - == Header2 == - === Header3 === + = 一级标题 = + == 二级标题 == + === 三级标题 === - *bold* -- bold text - _italic_ -- italic text + *bold* -- 粗体文本 + _italic_ -- 斜体文本 + （应用于句中的汉字文本时，必须在标记前后加空格，例如：一段 *中文* 文本） - [[wiki link]] -- wiki link - [[wiki link|description]] -- wiki link with description + [[wiki link]] -- wiki 链接 + [[wiki link|description]] -- 带有描述文本的 wiki 链接 -列表: +列表： - * bullet list item 1 + * bullet list item 1（无编号列表） - bullet list item 2 - bullet list item 3 * bullet list item 4 @@ -67,13 +66,13 @@ Vimwiki是私人维基的vim插件 -- 许多有自己代码高亮的text文件 - bullet list item 8 - bullet list item 9 - 1. numbered list item 1 + 1. numbered list item 1（有编号列表） 2. numbered list item 2 a) numbered list item 3 b) numbered list item 4 -查看`:h vimwiki-syntax` +更多格式说明，请阅 `:h vimwiki-syntax` 键位绑定 @@ -81,46 +80,49 @@ Vimwiki是私人维基的vim插件 -- 许多有自己代码高亮的text文件 normal 模式: - * `ww` -- 打开默认的wiki index文件 - * `wt` -- 通过tab实现上一个功能 - * `ws` -- 选择并且打开index文件 - * `wd` -- 删除进入的wiki文件 - * `wr` -- 重命名你进入的wiki文件 - * `` -- 进入/创建 wiki 链接 - * `` -- 通过分屏模式sp，进入/创建wiki链接 - * `` -- 通过分屏模式vs，进入/创建wiki链接 - * `` -- 返回父节点 - * `` -- 寻找下一个wiki链接 - * `` -- 寻找上一个wiki链接 + * `ww` -- 打开默认的 wiki 目录文件 + * `wt` -- 在新标签（Tab）中打开 wiki 目录文件 + * `ws` -- 在多个 wiki 中选择并打开该 wiki 的目录文件 + * `wd` -- 删除当前 wiki 文件 + * `wr` -- 重命名当前 wiki 文件 + * `` -- 创建或打开 wiki 链接 + * `` -- 先上下分屏再打开 wiki 链接（若非链接则先创建） + * `` -- 先左右分屏再打开 wiki 链接（若非链接则先创建） + * `` -- 返回之前浏览的 wiki 文件 + * `` -- 跳到本文件中下一个 wiki 链接 + * `` -- 跳到本文件中上一个 wiki 链接 -查看`:h vimwiki-mappings` +更多快捷键说明，请阅 `:h vimwiki-mappings` 命令 ------------------------------------------------------------------------------ - * `:Vimwiki2HTML` -- 转换当前wiki成为html - * `:VimwikiAll2HTML` -- 转化你的全部wiki到html + * `:Vimwiki2HTML` -- 将当前 wiki 文件转换成 HTML 网页 + * `:VimwikiAll2HTML` -- 把所有 wiki 文件转换成 HTML 网页 * `:help vimwiki-commands` -- 显示全部命令 -安装细节 +安装 ============================================================================== -在安装之前，你需要做的 +准备工作 ------------------------------------------------------------------------------ -确定在`vimrc`中，你的设置是这样的。 +确保在 `vimrc` 中加入了以下设置： set nocompatible filetype plugin on syntax on -如果没有他们，Vimwiki将无法正常工作。 +没有这些设置，Vimwiki 将无法正常工作。 +通过 [Vim packages](http://vimhelp.appspot.com/repeat.txt.html#packages) 安装（Vim 7.4.1528 后） +------------------------------------------------------------------------------ + git clone https://github.com/vimwiki/vimwiki.git ~/.vim/pack/plugins/start/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 @@ -128,4 +130,32 @@ normal 模式: cd bundle git clone https://github.com/vimwiki/vimwiki.git -然后启动vim，使用`:Helptags` 然后 `:help vimwiki`来确保他已经被安装了。 +通过 [Vim-Plug](https://github.com/junegunn/vim-plug) 安装 +------------------------------------------------------------------------------ + +在 `vimrc` 中加入以下插件设置： + + Plug 'vimwiki/vimwiki', { 'branch': 'dev' } + +然后运行 `:PlugInstall`。 + +通过 [Vundle](https://github.com/VundleVim/Vundle.vim) 安装 +------------------------------------------------------------------------------ + +在 `vimrc` 中加入 `Plugin 'vimwiki/vimwiki'`，然后执行： + + vim +PluginInstall +qall + +或者下载 [zip 压缩包](https://github.com/vimwiki/vimwiki/archive/master.zip)然后解压到 `~/.vim/bundle/` 目录下。 + +安装后，启动 Vim 并执行 `:Helptags` 以及 `:help vimwiki`，检查安装是否成功。 + + +获取帮助 +============================================================================== + +遇到问题？在 Freenode 的 IRC 频道 `#vimwiki`（[网页聊天](https://webchat.freenode.net/?channels=#vimwiki)）提问，或者发送问题到[邮件列表](https://groups.google.com/forum/#!forum/vimwiki)上吧。 + + +---- +\* 前面截图中用的是 [solarized 配色方案](https://github.com/altercation/vim-colors-solarized)以及 [lightline](https://github.com/itchyny/lightline.vim) 插件。 diff --git a/README.md b/README.md index 1720e4c..a8a203a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ A Personal Wiki For Vim ============================================================================== +[中文](README-cn.md) + ![screenshot1](doc/screenshot_1.png) ![screenshot2](doc/screenshot_2.png) *