VimWiki Colorize 功能指南:不离开 Vim 就能让 Wiki 文本变色的完整教程
【免费下载链接】vimwikiPersonal Wiki for Vim项目地址: https://gitcode.com/GitHub_Trending/vi/vimwiki
VimWiki 是运行在 Vim 里的个人 Wiki 工具,它的Colorize 功能可以让你不离开 Vim直接给 Wiki 文字变色:输入一条命令或按一下快捷键,选中文字就会被套上彩色,生成的 HTML 色标既在编辑器里显示颜色,导出 HTML 时依然保留,内置 15 种颜色、还能自定义色板。
快速上手:两种最快捷的 VimWiki Colorize 操作步骤
在任意.wiki文件中,Colorize 有两种触发方式:
| 操作 | 效果 |
|---|---|
普通模式按\wc(即<Leader>wc) | 对光标所在行上色,弹出菜单让你选颜色 |
先用V进入行可视模式选中多行,再按\wc | 对选中的文字上色 |
命令模式输入:VimwikiColorize 颜色名 | 对指定行范围上色,命令支持颜色名自动补全 |
比如想给当前行加上黄色,只需把光标移到该行,按\wc,在弹出的列表里选择yellow即可。执行后该行文本会被自动包进一个 HTML 标签:
<span style="color:#d79921;">这一行现在显示为黄色</span>💡
<Leader>默认是\键,如果你改过mapleader,请按自己的前缀输入。映射定义见 ftplugin/vimwiki.vim。
内置 15 种颜色一览:文字色、背景色怎么挑
VimWiki 的默认色板由color_dic变量定义,共 15 个颜色键,按「文字变色」和「背景变色」分成两组,方便快速记忆:
| 类别 | 颜色键 | 说明 |
|---|---|---|
| 默认 | default | 橙色背景(#d79921) |
| 文字色 | red/green/yellow/blue/purple/orange/gray | 只改文字颜色 |
| 背景色 | bred/bgreen/byellow/bblue/bpurple/borange/bgray | 只改背景色(b 前缀 = background) |
命名规律很好记:带b前缀的是背景色,不带的是文字色。例如red是红字,bred是红底。
上色原理:为什么导出 HTML 后颜色还在?
这是 VimWiki Colorize 最关键的一点:颜色是写进纯文本源文件里的,不是 Vim 的临时高亮。
它的运作分两步:
- 加标签:
vimwiki#base#colorize()函数根据你选的颜色,在文字前后插入<span style="...">...</span>标签(源码见 autoload/vimwiki/base.vim); - 认标签:语法高亮文件读取
color_tag_template模板来识别这些标签,于是编辑器内立刻显示对应颜色(识别逻辑见 syntax/vimwiki.vim)。
所以颜色是「所见即所得」的:Vim 里看到什么样,:Vimwiki2HTML导出的网页就是什么样。
自定义颜色与模板:三个进阶技巧
- 加新颜色:在
vimrc里扩展 Wiki 的color_dic变量,加入自己的键值对(如'pink': ['#cc55aa', '']),新颜色会立刻出现在\wc菜单和:VimwikiColorize的补全列表里; - 改标签格式:若你的模板需要调整,可修改
color_tag_template(颜色选项的默认值定义在 autoload/vimwiki/vars.vim); - 查看当前配置:随时用
:VimwikiVar color_dic查看当前 Wiki 的颜色配置。
适合用 Colorize 的场景
- 📌重点标注:给笔记里最重要的结论打上醒目底色,一眼看到
- 🎨知识图谱配色:按主题给不同章节的标题固定用色,形成视觉分区
- 📅日记与任务:紧急事项红底、已完成事项灰字(可配合 todo 列表 使用)
相关文件资料
- 功能说明文档:doc/vimwiki.txt(搜索
*vimwiki_<Leader>wc*和*:VimwikiColorize*两节) - 上色核心实现:autoload/vimwiki/base.vim
- 颜色与模板默认值:autoload/vimwiki/vars.vim
- 快捷键映射:ftplugin/vimwiki.vim
- 颜色标签语法识别:syntax/vimwiki.vim
掌握 VimWiki Colorize 后,你的 Wiki 文本无论编辑还是导出都自带色彩,笔记的重点再也不会淹没在大段文字里。
【免费下载链接】vimwikiPersonal Wiki for Vim项目地址: https://gitcode.com/GitHub_Trending/vi/vimwiki
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考