KuaiJiSublime 笔记查阅插件
KuaiJi 是一个可以帮助你快速查阅笔记的 Sublime Text 3 插件。 当笔记文件内容太多太杂时,查阅笔记会是一件非常麻烦的事情。
本插件可以让你方便地在笔记的不同段落之间跳转,还支持用不同的颜色和字体样式化显示标题、批注等特殊内容,让阅读更方便。
下载和安装
-
下载:
点击 标签 英文下为 tag 链接;
在新打开的标签列表窗口中,点击最上面的标签条目右侧的 下载 英文为 Download 链接;
在弹出的验证窗口中完成验证就会自动开始下载了。 -
安装:
解压下载的ZIP文件,你会得到一个名为 KuaiJi 的文件夹;
将 KuaiJi 文件夹中的 .git 文件夹、LICENSE、README.md 以及 README.en.md 文件删除;
将 KuaiJi 文件夹中的 test.kj 文件移动到桌面;
在 Sublime Text 3 中通过菜单 Preferences => Browse Packages 打开 Packages 目录;
把 KuaiJi 文件夹复制到 Packages 目录下就可以了。 -
在我的另一个仓库 Sublime Text 3下载 中有 Sublime Text 3 安装包和 Package Control 插件可供下载;官方下载实在是太慢了。
文件内查找标题并跳转
本插件通过正则表达式
识别 标题,在一个快捷面板中列出当前文档中所有的 标题。当用户选中某个 标题 时,文档会自动跳转到该 标题 所在位置。
用法
- 在 Sublime Text 3 中打开刚刚从 KuaiJi 文件夹移动到桌面的 test.kj 文件;
- 通过菜单 我的插件 => 查找标题 或快捷键 Alt+M 调用快记插件;
- 此时你会看到一个快捷面板中列出了
test.kj
文件中所有的 标题,非顶级的 标题 下还会有一行小字标出它所属的上级 标题;随便点击一个 标题 条目,文档就会自动跳转到该 标题 所在位置。
命令
查找标题的命令: kuaiji_find
也就是驼峰模式下的: KuaijiFind
自定义样式
Sublime Text 3的文本样式由 Syntax文件: .sublime-syntax文件 配置;
每一个 Syntax文件 通过其内容中设置的 对象扩展名 与一类文件绑定;
比如本插件默认的 KuaiJi.sublime-syntax 就是和扩展名为 .kj 的一类文件绑定的。
用法
新建 Syntax文件
点击菜单 我的插件 => 新建Syntax;
会打开一个 Syntax模板文件 ,并弹出文件名输入面板;
输入文件名并回车,模板文件名会变为输入的文件名,并弹出 对象扩展名 输入面板;
输入 对象扩展名 并回车,文件中对应的位置会自动插入 对象扩展名 ; 接下来只要按Ctrl+S
快捷键保存,一个全新的 Syntax文件 就创建完成了。
编辑 Syntax文件
点击菜单 我的插件 => 编辑Syntax;
会弹出文件选择快捷面板,列出所有可用的 Syntax文件;
点击列表中想要打开的文件,会打开该文件并弹出名词输入面板;
输入你想添加的名词并回车,文件中对应的位置会自动插入你输入的新名词;
记得多个名词中间用|
分隔开;
最后按Ctrl+S
快捷键保存,Syntax文件 编辑就完成了。
打开与你刚刚编辑的 Syntax文件 绑定的文件,在文件中输入刚刚添加的新名词;
新名词会用特殊的字体和颜色显示。
命令
新建 Syntax文件: kuaiji_new_syntax
也就是驼峰模式下的: KuaijiNewsyntax
编辑 Syntax文件: kuaiji_edit_syntax
也就是驼峰模式下的: KuaijiEditSyntax
标题识别
快记 采用分级 标题,标题 独占一行,以1至无数多个英文小数点开始,以英文冒号结尾。
顶级 标题 为:.标题:
,二级 标题 为:..标题:
,以此类推,前面带几个小数点就代表是几级标题。
所有标题都会用显眼的颜色高亮显示,并且可以通过 用法 中介绍的方法快速跳转。
样式化内容
为了让笔记内容看起来更有条理,本插件定义了一些简单的样式化文本语法:
-
:小标题:
独占一行,以英文冒号开头,以英文冒号结尾;
采用该格式的文本会高亮显示,以便于识别,但是无法快速跳转。
注意,冒号是英文半角的:
:简介:
此处省略数百字
:详解:
此处省略数千字
-表头:
独占一行,以减号开头,以英文冒号结尾。表头 除本身会高亮显示外,还标志着其后所跟连续非空行为列表。
列表条目:
表头 后所跟的连续非空行中,以一或两个英文冒号结尾的最短文本,有多种样式。例如:
-表头:
objects:: 条目样式一
aaaaa: 条目样式二
bbbbb:
sep:: 条目样式三
aaaaa: 条目样式四
bbbbb:
>>>
aaa: 列表中以独占一行的'>>>'开头,
bbb: 以独占占一行的'<<<'结尾的内容,
ccc: 为列表中代码块,可以屏蔽列表条目的样式:
<<<
aaa:
bbb:
ccc:
列表以空行结束
aaa:
bbb:
ccc:
Sublime Text 3下载
https://gitee.com/ChehgAnXu/sublime-text-3-download
打开页面后有详细的下载安装教程,这里就不赘述了。