语法索引
怎么读
集成使用自己加语法
先看本页表格,确认语法是否支持;写文档时遵守站内语法手册。
看 扩展语法。
GFM
| 类别 | 示例 |
|---|---|
| 标题 | ATX / Setext |
| 强调 | 斜体、粗体、删除线 |
| 链接 / 图 | 行内、引用式 |
| 列表 | 无序、有序、任务列表 |
| 引用 / 代码 / 表格 / 分隔线 | 标准 GFM |
| Autolink | 尖括号 URL |
Penna 行内
| 语法 | 写法 |
|---|---|
| Frontmatter 变量 | [[title]] |
| 高亮 | ==text== |
| Emoji | :smile:(GitHub 英文短码) |
| HTML 属性 | **b**{.cls} |
| 徽章 | [新]{.tip} |
| 剧透 | !! text !! |
| 数学 / 上下标 | $…$ · H~2~O · 2^10^ |
| 注释 / 脚注 | %% … %% · [^1] |
Penna 块级
| 语法 | 写法 |
|---|---|
| Alert | > [!NOTE] |
| 扩展任务 | - [/] - [>] - [!] … |
| 容器 | ::: tip · ::: center |
| 折叠 | ::: collapse + @item |
| Tabs / Steps | ::: tabs + @tab · ::: steps + 1. |
| Timeline | ::: timeline + - [时间:类型] 标题 |
| 列布局 | ::: cols + @col |
| 增强代码 | title= · 行高亮 · :collapsed-lines |
| Mermaid / ECharts | 对应围栏语言 |
| 媒体 | !video !audio !iframe |
| 卡片 / 网格 | ::: card · :::: card-grid |
| 字段文档 | ::: field · :::: field-group |
容易写错
| 写法 | 实际结果 |
|---|---|
H~~2~~O | 删除线,不是下标 |
:赞: | 原样输出;短码只有英文名 |
::: tabs 标题 | 退化成普通容器 |
::: steps 标题 | 同上 |
- [2025-01-01] | 时间轴节点被丢弃;标题必填 |
link=https://x | 卡片属性值必须双引号 |
card-grid cols="5" | 上限 3 |
Tip
正确写法全文见 MCP 资源 wiki://docs/syntax,可整篇喂给模型。
本文已加密,请输入访问密码