Vimwiki 个人知识管理工具完全指南
vimwiki Personal Wiki for Vim 项目地址: https://gitcode.com/gh_mirrors/vi/vimwiki
什么是 Vimwiki?
Vimwiki 是一个基于 Vim 编辑器的个人 Wiki 系统,它允许用户创建、组织和管理个人知识库。作为一个纯文本的 Wiki 系统,Vimwiki 提供了丰富的功能来帮助用户高效地记录和整理信息。
核心功能
Vimwiki 提供了以下核心功能:
- 知识组织:通过链接和层级结构组织笔记和想法
- 任务管理:支持待办事项列表管理
- 文档编写:提供丰富的文本格式化选项
- 日记功能:内置日记系统,可按日期记录
- 导出能力:可将 Wiki 内容导出为 HTML 格式
快速入门
安装与基本配置
在使用 Vimwiki 前,确保你的 Vim 配置中包含以下基本设置:
set nocompatible
filetype plugin on
syntax on
这些设置是 Vimwiki 正常运行的基础。
创建第一个 Wiki 页面
- 打开 Vim 编辑器
- 输入
\ww
(默认 Leader 键为\
) - 这将创建或打开你的 Wiki 索引文件(默认位于
~/vimwiki/index.wiki
)
基本编辑示例
在索引文件中添加以下内容:
= 我的知识库 =
* [[任务]] -- 需要尽快完成的事情!
* [[项目文档]] -- 重要项目相关资料
* [[临时笔记]] -- 各种临时性内容
- 将光标移动到"任务"上并按回车,Vimwiki 会自动创建链接并打开新页面
- 在新页面中添加内容后,按退格键返回索引页
键盘映射详解
Vimwiki 提供了丰富的键盘快捷键来提高编辑效率,这些快捷键分为全局映射和局部映射两类。
全局映射
全局映射在所有 Vim 会话中都可用:
| 快捷键 | 功能描述 | |--------|----------| | \ww
| 打开当前 Wiki 的索引文件 | | \wt
| 在新标签页中打开 Wiki 索引 | | \ws
| 列出并选择可用 Wiki | | \wi
| 打开日记索引文件 | | \w\w
| 打开今天的日记页面 |
局部映射
局部映射仅在 Wiki 文件(文件类型为 vimwiki)中可用:
| 快捷键 | 功能描述 | |--------|----------| | \wh
| 将当前 Wiki 页面转换为 HTML | | 回车
| 跟随/创建 Wiki 链接 | | Shift+回车
| 分屏并跟随链接 | | Ctrl+回车
| 垂直分屏并跟随链接 | | 退格键
| 返回之前访问的 Wiki 页面 | | Tab
| 查找页面中的下一个链接 | | Shift+Tab
| 查找页面中的上一个链接 |
Wiki 语法指南
Vimwiki 支持丰富的文本格式化语法:
标题
= 一级标题 =
== 二级标题 ==
=== 三级标题 ===
列表
- 无序列表使用
*
或-
- 有序列表使用
1.
或a)
- 任务列表使用
* [ ]
未完成和* [X]
已完成
链接
- 内部链接:
[[页面名称]]
- 外部链接:
[[https://example.com|描述文字]]
- 图片链接:
{{图片路径}}
表格
| 姓名 | 年龄 | 职业 |
|------|------|------|
| 张三 | 30 | 工程师 |
| 李四 | 25 | 设计师 |
高级功能
多 Wiki 管理
Vimwiki 支持管理多个独立的 Wiki,可以在 vimrc 中配置:
let g:vimwiki_list = [{'path': '~/wiki/work/', 'syntax': 'markdown'},
\ {'path': '~/wiki/personal/'}]
日记系统
Vimwiki 提供了强大的日记功能:
\w\w
- 创建或打开今天的日记\w\y
- 打开昨天的日记\w\m
- 打开明天的日记
日记文件默认按日期命名(如 2023-11-15.wiki
),并自动组织在 diary 目录中。
自定义配置
Vimwiki 提供了丰富的配置选项,可以通过 vimrc 文件进行个性化设置:
" 设置 Wiki 文件扩展名
let g:vimwiki_ext = '.wiki'
" 禁用驼峰式单词自动链接
let g:vimwiki_camel_case = 0
" 设置 HTML 导出选项
let g:vimwiki_html_header_numbering = 2
实用技巧
- 快速创建链接:在可视模式下选择文本后按回车,自动创建链接
- 任务管理:使用
\tl
切换任务项的完成状态 - 表格对齐:使用
\tr
重新对齐表格 - 代码块:使用三个反引号创建代码块
- 标签系统:使用
:tag
命令快速查找带标签的内容
常见问题解决
- 快捷键冲突:可以通过重新映射解决,如
:nmap <Leader>wn <Plug>VimwikiGoto
- 中文支持:确保 Vim 编译时包含多字节支持
- 文件同步:Wiki 文件是纯文本,可使用任何同步工具备份
Vimwiki 作为一个轻量级但功能强大的知识管理工具,完美结合了 Vim 的高效编辑能力和 Wiki 的知识组织能力,是程序员、作家和知识工作者的理想选择。通过熟练掌握其各种功能,你可以建立一个完全符合个人需求的知识管理系统。
vimwiki Personal Wiki for Vim 项目地址: https://gitcode.com/gh_mirrors/vi/vimwiki
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考