PreviewMD 渲染什么,又是谁在渲染
下面每一个渲染器都打包在应用内部。绘制文稿时不会去下载任何东西,不联系任何 CDN,也没有使用数据离开设备——这就是快速查看能即时出现、而这一切在飞机上也照样管用的原因。
这一页就是由同一套引擎渲染的。切换到顶部的源码,即可看到页面上任何一个示例背后的 Markdown。
这些模块
| 模块 | 版本 | 作用 |
|---|---|---|
| markdown-it | 14.1.0 | 解析器:CommonMark,外加下面这些 GitHub 扩展 |
| KaTeX | 0.16.22 | 数学公式,排版出来而不是画出来 |
| Mermaid | 11.16.1 | 由文本绘制的图表 |
| highlight.js | 11.11.1 | 语法高亮,近两百种语言 |
| @vscode/markdown-it-katex | 1.1.2 | 在文本里找出 $…$ 和 $$…$$ 并交给 KaTeX |
| markdown-it-task-lists | 2.1.0 | - [x] 复选框 |
| markdown-it-footnote | 4.0.0 | 脚注及其返回链接 |
| markdown-it-emoji | 2.0.2 | :shortcodes: |
| markdown-it-front-matter | 0.2.4 | YAML 前置数据,隐藏而不是打印出来 |
| jsdiff + diff2html | — | 差异视图及其词级高亮 |
| github-markdown-css | — | 页面样式,浅色与深色 |
每一个都带着自己的许可声明,在应用里的帮助 ▸ 致谢中原样列出。
数学公式
KaTeX 会排版公式,所以它们可以缩放、可以选中、可以作为文本复制,而不是以一张模糊的图片出现。行内公式写在单个美元符号之间——轨道上任意一点的速度为 ——独占一行的公式写在双美元符号之间:
矩阵、求和与对齐方程同样可行:
图表
标记为 mermaid 的代码块会变成一张图。文本始终是事实来源:改一行,图就跟着变,而文件仍是你的版本控制可以对比的文本文件。
graph LR
A[书写] --> B[预览]
B --> C{看着对吗?}
C -- 是 --> D[导出]
C -- 否 --> A
时序图,适合任何有来有回的过程:
sequenceDiagram
participant F as 访达
participant Q as 快速查看
participant P as PreviewMD
F->>Q: 在 README.md 上按空格键
Q->>P: 渲染这个文件
P-->>Q: 渲染好的页面
Q-->>F: 显示出来,没启动应用
还有比例,用表格的话就得你自己做算术了:
pie showData
title README 由什么组成
"正文" : 55
"代码块" : 30
"表格" : 10
"图表" : 5
状态图、类图、甘特图以及 Mermaid 的其余本领,渲染方式都一样。
代码
围栏代码块由 highlight.js 高亮,它认得近两百种语言。语言写在起始围栏后面:
struct Entry: Comparable {
let clock: UInt64
let device: UUID
static func < (a: Entry, b: Entry) -> Bool {
// 相同时以设备 id 决胜,这样各处得到的顺序都一致。
(a.clock, a.device.uuidString) < (b.clock, b.device.uuidString)
}
}
def hohmann(r1: float, r2: float, mu: float = 3.986e14) -> float:
"""圆轨道之间转移所需的总 delta-v。"""
first = (mu / r1) ** 0.5 * ((2 * r2 / (r1 + r2)) ** 0.5 - 1)
second = (mu / r2) ** 0.5 * (1 - (2 * r1 / (r1 + r2)) ** 0.5)
return first + second
没有标语言的代码块会保留为等宽纯文本,而 inline code 根本不需要语言。
GitHub 的那些扩展
GitHub 给 Markdown 添了什么,README 也就因此假定有什么:
- 任务列表,复选框会被画出来
- 包括那些还没完成的
删除线,用于不再适用的内容- 脚注[1],带编号并链接回原处
- 自动链接:https://previewmd.xfanta.com 会自己变成链接
- 用简码写的表情:🚀 ✨ ✅
Note
提示框是 GitHub 自己的约定,并不属于任何 Markdown 规范——就是一段首行写明种类的引用块。
Warning
一共五种:Note、Tip、Important、Warning 和 Caution。
它们落在文档末尾,并带一个箭头回到你刚读到的地方。 ↩︎
那些不太张扬的
前置数据。 文件最开头、两行 --- 之间的 YAML 块是给静态站点生成器用的元数据——不是你打算读的东西。它会被解析并隐藏,而不是作为一张乱码表格打印出来。
图片。 文稿引用的本地图片会显示出来,从文稿所在的文件夹加载。不会通过网络去取任何东西,所以路径坏了的文稿会直接说明,而不是一直卡着。
表格。 普通的 GFM 竖线表格,对齐方式取自分隔行里的冒号。过宽的表格会滚动,而不是把页面撑破。
在你的 Mac 上读到这一切
PreviewMD 会在快速查看中、在它自己的窗口里、以及在导出的 HTML 和 PDF 中渲染这一页上的全部内容——Mac、iPad 和 iPhone 上都有,免费。
速查表列出了每一个标记及其结果,而什么是 Markdown讲的是这个格式从哪儿来。