打赏°内容导航继续上次的阅读导航中心逐章导航插图导航长图片与双题注示例文库导航脚注导航快捷操作导航导航历史°内容助手复制内容插图全屏显示表格阅读模式试试点击表格的任意单元格,或让鼠标光标在以下表格行间进行移动换行版式画中画°演示辅助激光笔聚光灯段落漫游Mermaid 图表元素高亮正文宽度适配°出版辅助标记不发布的内容社交分享链接地图长内容自动折叠自定义欢迎页内容链接失效与规范检查链接内容识别链接内容转换图片懒加载模式字数与阅读时长°外观模板主题预置的模板主题定制模板主题字体风格Dark ModeGray Mode°不杂项插件预置选项插件调校参数快捷键操作延伸内容章节标题内容注意事项图片地址扩展应用说明基于色轮的配色方案
感谢打赏支持 VLOOK™ 的客官(部分名单)/ Thanks for donate VLOOK™ (partial donors)
*Z、*川、l*n、*朽、*杰、A*C、W*l、*山、*星、*丽、一*秋、*军、*鹏、李*6、*无、H*t、*二、f*y、*宇、*琛、*辉、*秋、*笑、*豫、l*a、*心、整*9、*国、*拉、*龙、*应、*销、*哦、E*y、……
若喜欢 VLOOK™ 的话,可以贡献一杯咖啡
Gn
I like VLOOK™, I donate a cup of coffee
Se
Markdown 粉Q
「一般发布的静态 HTML 文档,都无法记住上次阅读的位置~」
VLOOKA
T2 VLOOK™ 对导出的每一个静态 HTML ,都可以快速定位到上次阅读的位置。
适用范围 •••
编辑时
× 不适用Gy导出 HTML
✓ 适用Gn
打开之前阅读过的 HTML 文档后,会在右上角侧显示「继续上次的阅读」的按钮,点击回到上次阅读的位置;
稍后该入口会自动隐藏,可通过右上角的 导航历史按钮继续上次的阅读(快捷键 H)。
Markdown 粉Q
「文档涉及的内容多了之后,只有目录大纲的话无法快速定位和展示文档的关键资源、内容」
VLOOKA
T2 VLOOK™ 对导出的 HTML 除对目录大纲增强外,还支持丰富多样的文档资源的索引和管理。
适用范围 •••
编辑时
× 不适用Gy导出 HTML
✓ 适用Gn
通过工具栏左侧的的 导航中心按钮收起/打开导航中心(快捷键 N )
分级展示目录大纲、多种类型的「文库」入口
文档内容的分类索引,支持:插图、表格、代码块、公式、多媒体
以上内容均支持关键字搜索,并支持分词条件搜索(不同关键字之间以空格分隔)
Important
基于 Typora 生成的目录大纲,请在文档中「VLOOK™ 的封面」后添加目录标记 [TOC]
;
若文档无目录大纲和分类索引时,导航中心会默认收起。
Markdown 粉Q
「除了大纲外,希望可以按章节顺序一章一章进行浏览。」
VLOOKA
T2 由 VLOOK™ 接管后,会自动扩展提供「逐章导航栏」,正如你现在看到顶部的导航栏那样。
适用范围 •••
编辑时
× 不适用Gy导出 HTML
✓ 适用Gn
当滚动至文档正文区后,会自动在顶部显示逐章导航条,在封面时会自动收起隐藏,支持对 1~5 级章节进行逐章浏览。
逐章导航快捷键
逐章导航的快捷键 | 功能(逐章导航模式激活后生效) |
---|---|
◀ 或 , | 前一个章节 |
▶ 或 . | 后一个章节 |
Markdown 粉Q
「希望能按图索骥,快速浏览文档中的所有插图,以及快速定位到文档中对应的位置。」
VLOOKA
T2 文档中的所有图片、Mermaid1 图表都支持快速浏览,一键跳转到对应位置。
适用范围 •••
编辑时
× 不适用Gy导出 HTML
✓ 适用Gn
鼠标点击插图即可全屏显示,所有插图可支持通过在插图浏览器中打开,并进行前/后插图的导航;
在插图浏览器中可点击插图直接定位到文档中对应的位置。
支持的插图类型:
浏览器支持的所有图片(如:jpg / png / gif / bmp 等)
脚本化图表(如:Mermaid1)
插图导航快捷键
插图导航快捷键 | 功能(打开插图导航后生效) |
---|---|
◀ 或 , | 前一张插图 |
▶ 或 . | 后一张插图 |
Markdown 粉Q
「同一类话题或项目有很多 Markdown 文档,希望发布 HTML 后还能方便统一进行组织和访问。」
VLOOKA
T2 为每个文档配置专属的「文库」内容,这样就可以随时一键直达你的「文档宇宙」中任意文档了。
适用范围 •••
编辑时
× 不适用Gy导出 HTML
✓ 适用Gn
文档中配置了「文库」,或在文档中含有文库链接时,在工具栏、目录大纲下方都会显示「文库」入口
,也支持直接通过快捷键 L 打开;
指定的文库文件默认是会在当前文档的「文库弹窗」中显示;
文档中有脚注内容,在文库中也会自动生成查看所有脚注内容的入口。
首先先确认已按《安装与使用》中的 Step 3•配置导出选项 完成了「元标签」的安装;
然后在文档的 YAML Front Matter 区域内添加 vlook-doc-lib
配置项及对应的内容,根据需要选择以下任意一种方式进行使用(可混用):
tab
文库配置方式一(最简化用法)
1vlook-doc-lib 文库.html
文库配置方式二(添加标题、搜索关键字)
xxxxxxxxxx
11vlook-doc-lib 你的文库标题 (文库.html "支持在导航中心搜索的关键字")
若文档需要配置多个文库,可以参考以下分段的配置方式:
xxxxxxxxxx
41vlook-doc-lib
2 文库1.html
3"支持在导航中心搜索的关键字") 以文库方式打开 (文库2.html
4 在新标签中打开 (文库3.html)
如何在新标签页、或当前标签页打开文库链接?
以上
target
的取值与 HTML 标准一致,可以是_blank
_self
_parent
_top
,或自定义的标识;
若希望文库指定的链接在新标签中打开,可以在地址后添加
target
及对应的值;若希望页面在当标签页面中打开,可以用
target=_self
,参考示例如下:xxxxxxxxxx
31# 示例-1:文库.html?target=_blank
2# 示例-2:文库.html?target=_self
3# 示例-3:文库.html?target=mydoc
如何让文本链接能在「文库弹窗」中打开?
只须设置文本链接是添加 URL 参数
target=vdl
即可,示例如下:xxxxxxxxxx
21[点击这里打开默认文库](?target=vdl)
2[点击这里打开指定文库2](文库2.html?target=vdl)
更多示例效果,详见:链接内容识别
Note
指定的文库链接与当前文档相同,则不会添加,有利于更灵活地对多个文档的文库清单进行统一的模板化管理;
更多关于通过 YAML Front Matter 设置插件预置选项的说明,详见 插件预置选项
在技术、学术或论文类文档中,脚注的使用非常多。主要用于在页面底部对正文中的相关内容加以补充解释、注明参考文献出处、给出额外说明等。
VLOOK™ 可以直接在当前页面位置弹层的方式进行显示,避免在文档中来回跳转,也支持在 导航中心 的 文库列表 中直接跳转查看所有脚注。
适用范围 •••
编辑时
× 不适用Gy导出 HTML
✓ 适用Gn
点击本段后的角标可以查看对应的脚注内容2
默认的操作项是导航历史
可通过在 YAML 中添加 vlook-quick-action
预置选项添加自定义的快捷操作项。
快捷操作导航配置分为「操作项图标」和「操作项链接」,并以英文分号 ;
进行分隔
操作项图标格式与 Markdown 图片语法一致,如:
,其中:
图标大小建议为 20 × 20
像素
图标标题可选。作为鼠标在操作项上悬停时显示的提示
操作项链接格式与 Markdown 超链接语法一致,如:[备注说明](URL)
,其中:
备注说明可选。作为鼠标在操作项上悬停时显示提示的补充说明
URL 如果是图片地址并希望鼠标悬停时直接显示,可以在 URL 后添加参数 ?target=qv
配置举例如下:
xxxxxxxxxx
41---
2# 在 YAML 中配置快捷操作项
3vlook-quick-action ! 图标标题 (my-icon.svg); 备注说明 (xxx.png?target=qv)
4---
需要配置多个快捷操作项时,可参考以下的分段配置方式:
xxxxxxxxxx
71---
2# 在 YAML 中配置多个快捷操作项
3vlook-quick-action
4 ! 标题1 (my-icon1.svg); 备注1 (url-1.html?target=view)
5 ! 标题2 (my-icon2.png); 备注2 (url-2.html)
6 ! 标题3 (my-icon3.png); 备注3 (url-3.html)
7---
适用范围 •••
编辑时
× 不适用Gy导出 HTML
✓ 适用Gn
自动记录当前文档内所有的跳转的历史,包括「导航中心」「逐章导航」「插图导航」「链接失效记录」等跳转的位置;
可随时通过右上角的 导航历史按钮快速回跳(快捷键 H )
适用范围 •••
编辑时
× 不适用Gy导出 HTML
✓ 适用Gn
针对不同形式的内容,提供自适应的快捷辅助功能。目前支持的内容形式包括:表格、插图、标签、刮刮卡、代码与代码块、公式、面包屑
Note
其中,鼠标悬停在以上所支持的内容上就会激活显示匹配的内容助手选项。
复制「多级标签」
点击不同分段的内容,即复制其自身及右侧的内容,如:分类内容1
内容2
复制「单级标签、代码」
点击即复制其内容,如:这是标签
这是代码
复制「代码块」
一键复制全部代码块的所有内容
复制「图片」
复制图片的地址,找张插图试试 ❯
支持通过内容助手对插图(图片、Mermaid 图片)一键全屏显示,并可进行前/后浏览翻阅,点这里试试看 ❯
Markdown 粉Q
「表格行、列很多时,希望能快速显示任意单元格相关的行、列都有哪些?」
VLOOKA
T2 无须高大上的设备或方式,VLOOK™ 激活后开箱即用~
鼠标悬停在表格后,通过右上角内容助手上的
按钮打开、关闭;
鼠标点击表格上的任意单元格后,会自动聚焦当前单元格及所在的行和列(类似于十字光标);
支持通过方向键( ▲ ▼ ◀ ▶ )进行移动,对于 表格行分组折叠 的单元格,还可通过 Enter ⏎ 进行展开和收起;
点击文档空白位置,或按下 ESC 临时取消显示。
列 A | 列 B | 列 C | 列 D |
---|---|---|---|
第一行 | 左对齐(长内容) | 居中对齐 | 右对齐(长内容) |
第二行(长内容) | 左对齐 | 居中对齐(长内容) | 右对齐 |
Markdown 粉Q
「在实际文档中会有各种「表格、代码块」,希望在阅读时可以根据需要指定不同换行、不行换行版式便于更好阅读浏览」
VLOOKA
T2 安排!VLOOK™ 激活后开箱即用~
鼠标悬停在「表格、代码块」后,通过右上角内容助手上的
手工切换为「自动换行」或「不换行」
Note
VLOOK™ 会根据根据表格内容和屏幕宽度,自动适配认换行版式,具体详见 这里 ❯❯
Markdown 粉Q
「希望插图、表格、代码块、公式也能像视频那样,可以设置为「画中画」的浮动显示模式,方便在文档相关内容间对比」
VLOOKA
T2 这个可以有,VLOOK™ 激活后开箱即用~
鼠标悬停在插图、表格、代码块、公式后,通过右上角内容助手上的
按钮一键开启;
开启后默认缩小为 75% 大小进行显示,也可通过缩放按钮调整为原始大小进行显示。
快去文档中的任意插图、表格、代码块、公式上试试吧~
适用范围 •••
编辑时
× 不适用Gy导出 HTML
✓ 适用Gn
Markdown 粉Q
「在进行文档评审或演示时,可以通过 激光笔 来让观众注意力精确跟随演讲者指向的内容。」
VLOOKA
T2 无须高大上的设备或方式,VLOOK™ 激活后开箱即用~
通过工具栏上的
按钮打开「聚光灯」(快捷键 P)。
Markdown 粉Q
「在进行文档评审或演示时,可以通过 聚光灯 来让观众聚焦于文档的特定区域和内容。」
VLOOKA
T2 无须高大上的设备或方式,VLOOK™ 激活后开箱即用~
通过工具栏上的
按钮打开、关闭(快捷键 S );
打开聚光灯后,可支持按通过 ⇧ Shift 键调节聚光灯的大小。
Markdown 粉Q
「希望在进行文档评审或演示时,按段落一段一段地突出,进行聚焦式浏览。」
VLOOKA
T2 点击工具栏上的段落漫游按钮 (或快捷键)就可以进入「段落漫游」模式了(致敬 vim)。
适用范围 •••
编辑时
× 不适用Gy导出 HTML
✓ 适用Gn
段落漫游快捷键致敬 vim
快捷键 | 功能 |
---|---|
J | 跳到下一个段落 |
K | 跳到上一个段落 |
⌘ command / ⌃ Ctrl | 配合以上快捷键,可跳转 5 个段落 |
⇧ shift | 配合以上快捷键,可跳转 10 个段落 |
支持通过鼠标悬停的方式,对 Mermaid 图表中的关键元素(节点、子图、文本等)高亮显示,方便在演示场景下更聚焦说明的内容,点这里去找个 Mermaid 的图表试试 ❯
为保障阅读体验,默认情况下正文区域会与自动适应浏览器窗口的宽度,当宽度过大时进行提供:
自动控制正文区域宽度为固定的宽度
支持点击右侧的箭头区域进行切换不同的宽度
Note
在 Typora 编辑时,以下情况下也会自动适配 Typora 的窗口宽度:
不显示左边的侧边栏(大纲/文件)
⇧ Shift + Cmd / Control + L
启用专注模式(Focus Mode)
F8
启用打字机模式(Typewriter Mode)
F9
适用范围 •••
编辑时
× 不适用Gy导出 HTML
✓ 适用Gn
Markdown 粉Q
「在进行文档发布时,有些内容还未完成,或暂时不想显示,怎么优雅地处理?」
VLOOKA
T2 Markdown 的「删除线」和「标题」一拍即合,优雅地轻松驾驭文档发布的内容范围~
通过 Markdown 的「删除线」格式标记哪些内容暂不发布,支持以下内容:
指定的章节
1 级 ~ 6级章节标题,包括其下的子章节。
标记方式:只需将章节标题内容设置为删除线格式即可
指定的引用块
标记方式:只需将引用块的小标题、折叠标题内容设置为删除线格式即可
指定的表格列
指定的 1 列或多列
标记方式:参考 表格列格式,将列头设置为删除线格式即可
不发布的带加粗小标题的引用块这是不发布的带加粗小标题的引用块
不发布的带高亮小标题的引用块这是不发布的带加粗小标题的引用块
不发布的折叠引用块这是不发布的折叠引用块
VLOOK™ 支持 Open Graph Protocol(是一个网络协议,用于在网页元数据中丰富内容的表示,尤其是在社交媒体上分享时),在分享时 VLOOK™ 会自动根据文档中预设的 OGP 标签内容生成网页分享到社交平台时的外观和描述。
适用范围 •••
编辑时
× 不适用Gy导出 HTML
✓ 适用Gn
Important
OGP 的标签与 VLOOK™ 的插件调校参数一样,都是通过文档中的 YAML Front Matter 来指定;
由于 OGP 的标签都含有冒号 :
,所以在 YAML Front Matter 中指定时须用英文的双引号进行包裹,如: "og:image": https://xxxxx.png
。
目前 VLOOK™ 导出配置已内置常见的 OGP 标签(详见下表),未在预置范围的标签可以自行在导出配置中添加。
支持以下常见的 Open Graph 标签
OGP 标签 | YAML 中的名称 | 说明 |
---|---|---|
og:title | "og:title" | 网页的标题,这是分享时显示的主要标题 |
og:type | "og:type" | 网页类型,如网站、视频、文章等 |
og:image | "og:image" | 与网页相关联的图像,这是分享时显示的主要图片 |
og:url | "og:url" | 网页的规范链接 |
其他常用标签 | == | == |
> og:description | "og:description" | 网页的简短描述,这通常在分享时显示 |
> og:site_name | "og:site_name" | 网站的名称 |
> og:locale | "og:locale" | 网页内容的区域设置或语言 |
> og:video | "og:video" | 如果网页包含视频,这是视频的链接 |
> og:audio | "og:audio" | 如果网页包含音频内容,这是音频的链接 |
在 YAML Front Matter 的应用举例
xxxxxxxxxx
61---
2"og:title": 这里是分享的标题
3"og:image": 这里是分享的相关联的图像 URL
4"og:url": 这里是点击分享引导进入的目标 URL
5"og:description": 这里是分享的简短描述
6---
tab
Note
更多关于通过 YAML Front Matter 设置插件预置选项的说明,详见 插件预置选项
Tip
若需要验证发布到网络的 HTML 的 OGP 配置内容,除直接分享到社交工具外,也可通过 Meta for Developers 的 Sharing Debugger 工具进行预览
外链清单及锚点数量
支持在当前文档中直接查看所有的外部链接清单,以及引用了这些链接的锚点数量(即链接中以
#
开头的内容)
外链锚点有效性检查
当维护的文档越来越多后,会存在未及时更新文档中外链锚点的情况,通过链接地图可快速对外链的锚点进行有效性检查
注意
外部链接的文档也需要由 VLOOK™ 插件生成
Tip
点击文档的右下角的 图标查看链接地图(快捷键 M ),并在链接地图中点击带有锚点条目后的「检查锚点」进行有效性检查
VLOOK™ 会自动对文档中的长插图、长表格、长代码进行自动折叠,节省文档的屏幕显示空间~
Important
在引用块、引用块折叠内的图片、Mermaid 图表、表格、代码块等均不在长内容自动折叠范围内。
Markdown 粉Q
「应用了 VLOOK™ 插件的文档在加载处理过程中会显示欢迎页,提示插件加载过程。但我希望能修改默认的欢迎信息。」
VLOOKA
T2 完成加载处理后会自动关闭并显示文档,若希望自定义欢迎页的显示行为也可以支持。
通过「插件预置选项」 vlook-welcome
来指定,在文档的 YAML Front Matter 区域添加以下内容:
自定义欢迎页内容示例
xxxxxxxxxx
31---
2vlook-welcome 在这里添加欢迎页的自定义内容,可包括 HTML 标记,如:<strong>欢迎页信息</strong>
3---
Note
更多关于通过 YAML Front Matter 设置插件预置选项的说明,详见 插件预置选项
图片源失效
自动识别无法加载的图片,并进行提示,示例:
Rd
音频、视频源失效
Rd
页内链接(锚点)不存在
自动检查当前页的页内跳转锚点,是否存在无效的情况,例如这条无效的页内链接
如何对外链锚点进行检查?详见链接地图 ❯❯
Rd
存在重复的章节标题
为避免无法跳转到该章节处
(可通过插件预置选项
vlook-header-dup
指定允许可重复的标题)Ye
链接锚点规范检查与修正
检查文字链接的锚点是否使用了标点符号,并进行自动修正处理
Gy
Warning
存在需要关注或处理建议的异常结果时,会在文档的右下角显示 图标提示,点击可查看具体的异常信息;
VLOOK™ 对图片、多媒体资源采用「懒加载」模式,具体资源地址异常情况需要页面滚动到对应位置后才会触发检查。
VLOOK™ 主题会自动识别文档中的超链接内容类型,显示不同的鼠标光标(鼠标光标样式同样适配 Light / Dark Mode)
VLOOK™ 文库专属链接
打开默认文库(有多个文库是指第 1 个文库)
以文库方式打开指定文件:Document Library (En)
T1!
识别主流超链接资源
Gy!
高风险资源
Rd!
自动转换 md 链接
在 Typora 支持在编辑时指定为任意 md 文档(或带锚点的 md 文件),方便在多文档维护时随时跳转,但导出 HTML 后不会自动转为 html,这对不适用于基于 HTML 发布的场景。
默认支持将文档中的
*.md
链接转换为html
,也可以指定为任意的扩展名。若希望关闭该自动转换,或指定转换的扩展名,可通过「插件调校参数」
xmd
进行调整。Bu!
外部链接强制在新标签打开
为提高文档阅读与交互体验,对于外链(如:http、https等),自动强制设置为在新标签页中打开。
Vn!
Markdown 粉Q
「对于文档中图片数量较多时,导出 HTML 后默认都为立即加载,影响文档打开速度和导致不必要的网络资源占用。」
VLOOKA
T2 支持对文档中的图片资源启用延时加载,只有在页面滚动到图片所在位置才会显示。
如何开启延时加载?
零操作!只需要使用 VLOOK™ 内置的主题 或 定制主题,正常配置并导出为 HTML 后即可具备该特性!
在文档右下角显示当前文档的字数统计(区分拉丁、中日韩字数),以及阅读时长的参考。
Markdown 粉Q
「你的 Markdown 文档能一键换肤吗?!」
VLOOKA
T2 内置了多套原创、独具气质的模板主题,能满足多种应用场景需要,完全超越你对 Markdown 主题的印象!
适用范围 •••
编辑时
✓ 适用Gn导出 HTML
✓ 适用Gn
主题会应用到 Typora 的应用程序 UI,以及文档内各类可编辑的元素,尽可能达到从整体到细节的视觉一致性!
VLOOK™ 内置的 6 套免费主题(点击预览效果)~
Bu
Ye
Gy
Og
Cy
Vn
若你使用在线版本插件,可通过「插件调校参数」 theme
来动态指定任意 VLOOK 主题。
目前现已开放主题的「定制服务」,以下为部分定制案例参考
Markdown 粉Q
「模板主题让文档颜值倍增,而字体则是文档气质担当!」
VLOOKA
T2 提供了五套独特个性的字体风格,可根据个人喜好进行选用。
适用范围 •••
编辑时
✓ 适用Gn导出 HTML
✓ 适用Gn
通过右下角状态栏上的 按钮进行选择(快捷键 A )
也支持通过「定制主题」进行预置指定
Gy
Gy
Gy
Gy
Gy
Gy
tab
Note
设置后同域名下所有文档都会应用,可通过「插件调校参数」 font
来强制指定当前文档使用的字体风格;
除「书香里、公文风、活力派」,都会强制对「数字、标点符号」使用等宽字体,以使得内容更易于识别。
Markdown 粉Q
「希望 Markdown 的文档能适配系统的深色模式,保持良好、一致的体验~」
VLOOKA
T2 所有 VLOOK™ 的主题都会自动根据浏览器或系统的 Dark Mode(深色模式)的设置进行自动适配。
适用范围 •••
编辑时
✓ 适用Gn导出 HTML
✓ 适用Gn
可通过右下角状态栏上的 /
/
按钮进行手动切换(快捷键 D )
Note
Tip
如果你的图片在 Dark Mode 下显得不够和谐,可以尝试选择让 图片适配 Dark Mode 。
Markdown 粉Q
「希望在国家公祭日,或其它指定的日期进行浏览时,能自动变为灰色显示~」
VLOOKA
T2 在 VLOOK™ 中可以轻松支持任意一个或多个在指定日期时以灰色显示。
适用范围 •••
编辑时
× 不适用Gy导出 HTML
✓ 适用Gn
通过「插件预置选项」 vlook-gray-mode
来指定启用 Gray Mode 的日期,该内容在文档的 YAML Front Matter 区域进行添加
增补以 Gray Mode 显示的日期
xxxxxxxxxx
51---
2vlook-gray-mode 月-日 标题@语言代码
3# 示例:
4# 12-13:国家公祭日@zh;04-05:清明节@zh,ko
5---
月
表示月份,日
表示日期。如:12-13
或04-05
标题
可选,对该日期的说明。如:国家公祭日
语言代码
可选,该日期适用的语言,如适用多种语言可写在一起,以英文逗号分隔如:中文
zh
、中文和韩文zh,ko
、英语en
若指定多个日期,每个日期间以英文分号
;
进行分隔如果需要临时恢复当前文档正常显示,可以通过状态栏上的
按钮进行操作
tab
Important
VLOOK™ 面向中文语言用户内置了在「中国国家公祭日、清明节」时启用 Gray Mode 的设定
Note
更多关于通过 YAML Front Matter 设置插件预置选项的说明,详见 插件预置选项
通过 YAML Front Matter 对 VLOOK™ 预置选项进行设置:
首先,为文档添加 YAML 内容(菜单:Typora ▸ 段落 ▸ YAML Front Matter);
然后对指定预置选项进行设置,格式举例如下:
通过 YAML 设置 VLOOK™ 插件预置选项
xxxxxxxxxx
61---
2<插件预置选项 1> <选项内容 1>
3<插件预置选项 2> <选项内容 2>
4...
5<插件预置选项 n> <选项内容 n>
6---
插件预置选项 | []预置到 定制主题 | 简介 | 内容取值及说明 |
---|---|---|---|
YAML 标准选项 | YAML Front Matter 的标准选项 | ||
> title | 标题 | ||
> author | 作者 | ||
> keywords | 关键字 | ||
vlook-header-autonum | Y | 标题自动编号的格式、前缀、后缀等内容 | 详见:标题自动编号 所有分级的章节都不进行自动编号,可通过定制主题关闭该特性 |
vlook-header-dup | 指定允许重复的章节标题内容 | • 在对文档章节标题查重时指定的内容 • 支持正则表达式 (以字面量方式进行定义,如 /pattern/flags )多个内容间以英文分号 ; 进行分隔 | |
vlook-doc-lib | 启用并指定当前文档的文库 URL | 支持指定多个,详见:文库导航 | |
vlook-gray-mode | 设置启用 Gray Mode 的日期 | 详见:Gray Mode | |
vlook-image-host | 默认图床地址 | 目前主要针对 Safari 打开本地 HTML 的文件,且指定图片剪影时使用 如: https://xxx.abc.com/images | |
vlook-welcome | 自定义文档在加载时欢迎页信息 | 详见:自定义欢迎页内容 | |
vlook-query | Y | 预置 VLOOK™ 规范的插件调校参数 | 详见以下章节:插件调校参数 |
通过 VLOOK™ 的「插件调校参数」可以对插件功能或文档的样式、交互方式进行开关和调整,支持以下方式进行调校(若同时存在则以 URL 参数指定的为优先):
方式一:通过文档的 URL 参数(即 Query)指定
方式二:通过 Markdown 文档的 YAML Front Matter 来指定
方式三:通过「定制主题」进行预置
tab
方式一:通过 URL 参数指定插件调校参数
x1我的文档.html?参数1=取值&参数2=取值...&参数n=取值
2(多个参数间用「&」进行分隔)
3
4举例:我的文档.html?ws=none&tag=t1
方式二:通过 YAML 指定插件调校参数
xxxxxxxxxx
51---
2vlook-query 参数1=取值&参数2=取值...&参数n=取值
3# 多个参数间用「&」进行分隔
4# 举例:ws=none&tag=t1
5---
VLOOK™ 插件调校参数说明
调校参数 | 说明 | 默认值 | 取值及说明 |
---|---|---|---|
排版 | |||
> badge | 调整 多级标签 未指定色号时默认使用的色号 | T1 | 色号 - 对应的预置色号,详见这里 |
> coating | 调整 刮刮卡 未指定色号时默认使用的色号 | Gy | 色号 - 对应的预置色号,详见这里 |
> quote | 调整普通的「引用块」默认自动转换为指定色号的 引用块着色 | off | off - 关闭,不自动转换色号 - 对应的预置色号,详见这里 |
> tag | 调整 标签 未指定色号时默认使用的色号 | T2 | 对应的预置色号,详见这里 |
题注 | |||
> capauto | 是否启用为索引对象(插图/表格/代码块/公式/多媒体等)自动生成题注及编号 | on | off - 不开启on - 开启 |
> capgroup | 题注的自动编号是否按所属章节进行分组编号 | on | off - 不开启on - 开启 |
> caphide | 隐藏指定的内容类型的题注 若有多个类型时,可用英文加号「+」进行分隔 | off | off - 全不隐藏指定类型隐藏: figure - 插图table - 插图codeblock - 代码块formula - 公式audio - 音频video - 视频 |
> captab | 在页签组中,题注编号(如:表 1-2)是否在页签上显示 | off | off - 不显示on - 显示 |
外观 | |||
> cs | 指定使用固定的颜色方案 | auto | light - 强制显示为 Light Modedark - 强制显示为 Dark Modeauto - 自动跟随系统配置 |
> effect | 调整文档的动效级别 | 2 | 0 - 关闭1 - 标准2 - 增强(毛玻璃等) |
> fillw | 指定正文宽度适配可显示宽度的默认状态 | off | off - 关闭on - 开启 |
> font | 强制指定使用的字体风格 指定该参数后则忽略 VLOOK 主题配套的字体风格 | theme | theme 使用主题配套local - 系统默认book - 书香里albb - 活力派gov - 公文风sans - 小清新serif - 文艺范 |
> gray | 临时关闭 Gray Mode | on | off - 关闭 |
> radius | 强制使用指定的圆角样式,忽略 VLOOK 主题自带的样式 | none - 不使用圆角small - 使用小号圆角big - 使用大号圆角 | |
> sb | 指定状态栏的默认显示方式 | show | hide - 隐藏show - 显示 |
交互 | |||
> fold | 控制使用长内容自动折叠的内容范围 若有多个内容时,可用英文加号「+」进行分隔 | on | off - 全不开启on - 全开启指定范围开启: table - 表格figure - 插图codeblock - 代码块list - 列表 (未实现) |
> tr | 指定表格阅读模式(十字光标)默认开关 | off | off - 不开启on - 开启 |
> ws | 指定文档的「欢迎页」显示模式 | auto | auto - 页面加载完成后自动关闭欢迎页wait - 文档和插件加载完成后,手动关闭欢迎页off - 不显示欢迎页1~60 - 指定延时等待的秒数 |
发布 | |||
> unpub | 对 标记为不发布内容 进行处理的开关 | on | off - 不开启on - 开启 |
> xmd | 指定将扩展名为「*.md」的链接转换为指定的新扩展名 (默认对全局生效,也支持在文本链接中单独指定) | html | off - 关闭,不转换{扩展名} - 指定的扩展名,如 php htm 等 |
导航中心 | |||
> nav | 指定导航中心初始的运行模式 | auto | auto - 在封面时自动收起、在正文时自动展开hide - 默认收起 |
> toc | 指定目录大纲初始自动折叠的层级 | 1 | 0 - 不折叠,全部展开1~5 - 折叠指定的层级 |
> vdl | 控制文库功能的开关 | on | off - 不开启on - 开启 |
调试 | |||
> reset | 强制重置浏览器存储的 VLOOK 相关数据 | true |
VLOOK™ 的功能和特性支持快捷键操作,效率再上一个台阶。
快捷键操作汇总
分类 | 功能 | 快捷键 |
---|---|---|
常用 | 开启、关闭 Dark Mode | D |
: | 显示、隐藏「导航中心」面板 | N |
: | 搜索导航中心的内容 | / |
: | 打开「文库」,或显示入口 | L |
: | 打开「链接地图」 | M |
: | 打开「导航历史」 | H |
页签组 | 切换显示下一个页签内容 | tab |
: | 切换显示上一个页签内容 | ⇧ Shift + tab |
表格阅读模式 | 移动当前聚焦单元格 | ▲ ▼ ◀ ▶ |
: | 展开/收起 表格行分组 | Enter ⏎ |
字体风格 | 选择字体风格 | A |
: | 退出「字体风格」选择 | ESC |
逐章导航 | 前一个章节 | ◀ 或 , |
: | 后一个章节 | ▶ 或 . |
段落漫游 | 打开「段落漫游」 | J 或 K |
: | 跳到下一个段落 | J |
: | 跳到上一个段落 | K |
: | 配合以上快捷键,可跳转 5 个段落 | ⌘ command / ⌃ Ctrl |
: | 配合以上快捷键,可跳转 10 个段落 | ⇧ shift |
: | 退出「段落漫游」模式 | ESC |
插图导航 | 显示「插图导航」 | I |
: | 前一张插图 | ◀ 或 , |
: | 后一张插图 | ▶ 或 . |
: | 退出「插图导航」模式 | ESC |
聚光灯 | 打开「聚光灯」 | S |
: | 调节聚光灯的大小 | ⇧ Shift |
: | 退出「聚光灯」模式 | ESC |
激光笔 | 打开「激活笔」 | P |
: | 退出「激光笔」模式 | ESC |
标题内容原则上不要带有标点符号(如: ,
、
?
_
等)
如果必须保留,在设置文字链接跳转至该标题时忽略这些标点符号
如标题内容为「标题、标题?」,则文字链接跳转应写成: 标题标题
标题内容原则上不要带有空格,如果有请替换为连字符 -
tab
图片地址无 Query 参数时
先在 URL 后添加英文问号
?
后,再添加需要的 URL Query 参数;当图片地址已有 Query 参数时,多个参数间用英文特殊符号
&
进行分隔。示例-1:

示例-2:

Important
若图片地址中含有锚点内容,如
xxx.png#icon
,URL Query 参数须在锚点前添加。
图片地址锚点
图片地址支持添加锚点「#魔法」实现快速图片排版,目前支持通过锚点排版的特性详见:°图片
当需要同时应用以上多个排版,可添加多个锚点,如:
#card#fixmax
配色示例 | 说明 |
---|---|
![]() | 单色方案 由一个颜色的暗/中/明色调组成(如:暗绿、绿、粉绿) 单色搭配上并没有形成颜色的层次,但形成了明暗的层次。 这种搭配在设计中应用时,出来的效果永远不错,其重要性也可见一斑。 |
![]() | 类比色方案 色轮上某个颜色的相邻的颜色(如:橙黄色、黄色、橙色) 类比色都拥有共同的三原色颜色(在上图中,是黄色及红色)。 这种颜色搭配产生了一种令人悦目、低对比度的和谐美感。 类比色非常丰富,在设计时应用这种搭配同样让你轻易产生不错的视觉效果。 |
![]() | 补色方案 色轮上直线相对的两种颜色(如:红、绿) 补色形成强列的对比效果,传达出活力、能量、兴奋等意义。 补色要达到最佳的效果,最好是其中一种面积比较小,另一种比较大。 比如在一个蓝色的区域里搭配橙色的小圆点。 |
![]() | 分裂补色方案 色轮上某颜色(如:红色)及其补色的类比色(如:绿、青) 这种颜色搭配既具有类比色的低对比度的美感,又具有补色的力量感。 形成了一种既和谐又有重点的颜色关系。 如在上面三种颜色中,红色就显得更加突出。 |
![]() | 二次色方案 二次色容易构成协调的搭配(如:绿、橙、紫) 任意两个二次色之间都拥有一种共同的颜色,所以它们轻易能够形成协调的搭配。 如果三种二次色同时使用,则显得很舒适、吸引,具有丰富的色调,以及深度和广度。 |
![]() | 原色方案 三原色同时使用是比较少 红黄搭配较受欢迎。从快餐店到加油站,我们都可以看见这两种颜色同时在一起。 蓝红搭配也很常见,但只有当两者的区域是分离时,才会显得吸引人。 注意:如果是紧邻在一起,则会产生冲突感,需进行分离。 |