写作总览
这一页列全了 Pamphlet 认识的每一条语法。 左边的菜单和这张表是一一对应的:菜单上有的,这里就有;这里没有的,就是不支持。
源文档是标准的 .md,直接丢上 GitHub 仍然能读。
文本格式
句子内部的东西。
段落与列表
自己占一块的东西。
交互组件
Pamphlet 在标准 Markdown 之上加的五种,统称容器指令。写法只有一条规则::::name[指令标题]{属性}。
属性的取值:default 和 open 都不带值;effect 取 fade-up(缺省)/ fade-in / slide-left / slide-right。
class 与 id 写了不报错,但产物里不会输出——值被静默丢弃。
图表
两种写法都行:Pamphlet 自己的结构化写法(:::flow 这一路,先列声明再列关系),或者 ```mermaid 围栏。两种都在编译时画成 SVG 内联进产物,读者那边不下载绘图库、也不联网。
自有写法在 GitHub 上不渲染,围栏写法会——要哪一种看你把源文档发到哪里。
两种写法各有各的页:下表第二列点进去是自有写法那一页,第三列点进去是同一种图的 Mermaid 围栏写法。
前十三种由 Mermaid 画(要先装一次),自有写法会被翻译成它的图源;后四种 Mermaid 画不了,由 Pamphlet 自己算布局、自己出 SVG,编译时不需要浏览器。其余七个引擎各自是一个包,用到哪个装哪个(没装就报 DIAG-301 并且整次构建失败)——它们各有一页:d2 · Graphviz · MathJax · Vega-Lite · WaveDrom · bytefield-svg · PlantUML,共同的取舍和装法写在其余七个引擎。
图片单独一页:图片与资源。
整篇文档的设置
不写在正文里,写在文档最开头那对 --- 之间。
完整说明见 frontmatter 参考。
不支持的
还能写 HTML
源文档里的 HTML 原样通过,不做任何过滤——这既是逃生出口,也是唯一能盖掉主题系统的地方。见裸 HTML。