查看器中的 Markdown 与 HTML
在 .md 或 .html 文件上按 F3,它会以排版后的样子出现,而不是源码:标题、列表、表格、链接、任务列表,以及按语言着色的代码块。写成 ```mermaid 块的图会被绘制出来,写在美元符号之间的数学式会被排版。
这是一个插件。本页所述的一切都来自 Markdown and HTML,可以在配置 ▸ 插件…中关闭;关闭后有什么变化见下文。
排版视图出现在哪里¶
- 查看器(F3)。 排版后的页面。视图弹出菜单仍提供文本、代码和十六进制,因此源码只差一次点击,插件的名称也在该列表中。
- Quick View(Ctrl+Q)与侧栏的信息页显示同一份渲染结果,因此同一文件的预览和完整视图从不彼此矛盾。
- 画廊显示 Markdown 文件开头的小图,而不是通用的文档图标。
- Quick Look(Cmd+Y) 是 macOS 自己的预览,不受影响——那个面板属于系统,任何插件都无法在其中绘制。
符号大纲¶
在查看器中按符号即可获得文档的标题,按写法层层嵌套;点击其中一个即可跳到页面中的相应位置。它在排版视图和源码中都有效,两者对标题所在位置的判断一致。
图与数学式¶
语言为 mermaid 的代码块会变成图;$…$ 与 $$…$$ 会变成排版后的数学式。两者都由插件内附带的引擎在你的 Mac 上绘制——不下载任何东西,文档的任何部分都不会被发送到别处。代码块或行内代码中的美元符号仍然是美元符号。
既无图也无公式的文档不会加载任何引擎,因此一份普通的 README 不会有额外开销。无法解析的图会在原来块的位置显示错误,并在下方保留该块的原文,而不是消失。
两者可以在配置 ▸ 设置 ▸ Markdown 中分别关闭;那里也能看到正在使用哪个版本、来自何处。
你自己的版本¶
如果需要更新或不同的 Mermaid、KaTeX 构建,把它放进Engine Folder…按钮打开的文件夹,就会用它代替随附的那份。文件名为 mermaid.min.js、katex.min.js、katex.min.css 和 auto-render.min.js。永远不会替你从互联网获取任何东西。
生成 PDF¶
把光标放在 .md 或 .html 文件上,命令 ▸ 导出为 PDF…(面板右键菜单中也有同一项)会把该文档以自身的名称写成 PDF,放在它旁边。它只在普通文件夹中提供——在压缩包内或已挂载的驱动器上,既没有磁盘上的文件可读,也没有可写入的旁边位置。标记多个文档,它们会被逐个导出。
这个 PDF 就是您按 F3 看到的那一页:相同的样式表、相同的着色代码、相同的图表与公式。默认按 A4 排版(Letter 是一项设置),分页落在段落、列表项和表格行之间,而不会从一行文字中间切开,并且没有哪一页会缺少其小节开头的标题。若文档中有超出文字栏宽度的内容——列数很多的表格、一行很长且无法断开的文字——会整体缩小以适应,而不是在边缘被切掉,这与浏览器自身的打印做法一致。
在插件的设置页面,PDF 之下:
- 纸张 — A4 或 US Letter。
- 替换同名的现有 PDF — 默认关闭,因此第二次导出会以
Name 2.pdf写在第一个旁边,而不是覆盖它。 - 在面板中显示新的 PDF — 把面板移到刚写好的文件上。关闭时您会收到一条简短消息,这样导出就不会悄无声息。
对格式化视图来说过大的文档(见限制)同样无法导出;消息会指出是哪一个。
排版页面不会做的事¶
排版页面是刻意隔离的,因为 Markdown 文件是来自别处的内容:
- 它不通过网络加载任何东西。 地址以
http开头的图片会故意保持空白:获取它会让那台服务器知道你何时打开了文件、来自哪个地址。与文档同放在磁盘上的图片则正常显示。 - 文档自带的脚本和 HTML 从不运行。 写在 Markdown 文件里的 HTML 会以文本显示,
.html文件在脚本关闭的状态下显示。
关闭它¶
在配置 ▸ 插件…中关闭该插件,.md 和 .html 文件就会以文本打开。大纲仍然可用,语法着色仍然可用,其他一切不变——只是不再提供排版视图。若只在插件的设置页关闭排版视图,效果相同。
限制¶
- 超过大小上限(默认 8 MB,见设置页)的文件会改以文本打开。把非常大的生成文档变成排版页面很慢,而文本查看器可以立即打开它。
- 排版页面不能编辑。请用 F4,或在文本视图中使用格式化、编码和跳转,它们作用于源码而非渲染后的页面。