↑ ↓ to pick a post, enter to open it

    keys

    /
    search
    t
    light / dark
    ← →
    newer / older
    ?
    these keys

    ← article

    Markdown 格式示例

    · 7 min · #示例 #Markdown

    contents
    1. 二级标题示例
    2. 三级标题示例
    3. Setext 风格的二级标题
    4. 段落、换行与转义
    5. 行内文字
    6. 链接与引用式链接
    7. 引用
    8. 列表与任务
    9. 无序列表与嵌套
    10. 有序列表与多段内容
    11. 任务列表
    12. 代码块与高亮
    13. 表格
    14. 图片
    15. 分隔线
    16. 脚注
    17. 公式
    18. HTML 补充与 Typst 片段

    这是一篇可以直接照着写的格式样本,也是一张排版检查表。它覆盖本站已经启用的 Markdown 基础语法、GFM 扩展和公式,最后补充少量 HTML 写法。另一篇 Typst 格式示例 使用相同的内容做对照,还展示网格和图片排版。

    源文件在 src/content/article/markdown-guide/index.md。文章开头的 frontmatter 负责标题、日期、描述和标签;它是站点元数据,不会原样显示在正文里。

    ---
    title: 我的文章
    description: 一句话介绍内容
    pubDate: 2026-10-28
    updatedDate: 2026-10-28
    tags: [随笔, 示例]
    draft: false
    ---

    一级标题示例

    标题可以从一级写到六级。实际写文章时,页面顶部已经有文章标题,正文通常从 ## 开始;这里把六级都排出来,方便检查样式。

    二级标题示例

    二级标题用来划分主要章节。

    三级标题示例

    三级标题适合展开一个章节。

    四级标题示例

    四级标题用来放更细的说明。

    五级标题示例

    第五级仍然是一个真正的标题元素。

    六级标题示例

    这是最后一级。标题层级表达内容关系,不只是控制字号。

    Setext 风格的二级标题

    二级标题也可以在下一行写一排 -;换成一排 = 就是一级标题。下方是对应的源码:

    一级标题
    ========
    
    二级标题
    --------

    段落、换行与转义

    这是第一段。中英文可以写在一起:今天给小鸟准备了 12 颗种子,下午再观察它们的活动。普通的源码换行 仍然属于同一个段落;空一行才会开始下一段。

    这是第二段。需要明确换行时,可以在行末写一个反斜杠:
    这一句会另起一行,但不会变成新的段落。

    符号也能当普通文字:*这不是斜体*,# 不是标题,[不是链接],金额写成 $19。HTML 实体同样可用:©、&、<tag>。

    行内文字

    这里有 加粗、斜体、加粗且斜体 和 删除线。也可以用 另一种加粗 与 另一种斜体 写法,或者在 加粗里面放一段 斜体。

    变量名写成 birdCount,命令写成 npm run dev。如果代码本身包含反引号,就使用双反引号:`seed`。

    HTML 可以补充 下划线、标记、H2O、x2 和 HTML 的缩写说明。按 ⌘ + K 是键盘按键的写法。

    链接与引用式链接

    引用

    给文字留一点空白,也给读者留一点时间。

    引用可以有多个段落,也可以包含 强调 和 代码。

    这是嵌套引用,用来区分另一层声音。

    • 引用里面也能放列表。
    • 列表仍然按正常语法书写。

    列表与任务

    无序列表与嵌套

    • 天空
      • 云和远处的小鸟
      • 细细的树枝
        • 树枝上的一片叶子
    • 小鸟
      1. 观察周围
      2. 跳到种子旁边
      3. 低头啄一下

    -、+ 和 * 都能作为无序列表标记;一份列表里保持一种写法就好。

    有序列表与多段内容

    1. 写文章。

      这是第一项的第二个段落,缩进后仍属于这一项。

    2. 在本地预览。

      npm run dev
    3. 确认图片和链接都能打开。

    列表可以从其他数字开始:

    1. 检查排版。
    2. 提交到 Git。

    任务列表

    • 准备两篇新的格式示例
    • 补齐文字、表格和公式
    • 把这里换成自己的文章
      • 配一张合适的图片

    任务框展示文章里记录的完成状态,不会保存读者的勾选操作。

    代码块与高亮

    围栏代码块可以指定语言;鼠标移到代码框上时,右上角会出现复制按钮。

    type Bird = { name: string; seeds: number };
    
    const birds: Bird[] = [
      { name: "蓝鸟", seeds: 4 },
      { name: "粉鸟", seeds: 7 },
    ];
    
    const total = birds.reduce((sum, bird) => sum + bird.seeds, 0);
    console.log(`今天准备了 ${total} 颗种子`);

    使用注释标记新增、删除和重点行;这些标记会在展示时隐藏:

    const birdCount = 3;
    const birdCount = 5;
    const seedsPerBird = 4;
    const total = birdCount * seedsPerBird;

    也可以在语言名后用行号指定高亮范围:

    {
      "title": "一片小小的天空",
      "draft": false,
      "birds": 5,
      "seeds": 20
    }

    四个空格缩进也能生成代码块:

    small wings,
    wide sky.

    代码围栏本身可以展示出来:外层使用四个反引号,内层使用三个。

    ```ts
    const message = "hello";
    ```

    表格

    表格支持左对齐、居中和右对齐,单元格里可以继续使用行内格式。

    小鸟 状态 种子数量
    蓝鸟 观察中 4
    粉鸟 吃饭 7
    白鸟 休息 3
    写法提示 a|b 14

    竖线需要写成 \| 才不会分隔出新的单元格。

    图片

    图片带有替代文字和可选的标题。这里使用仓库里的本地素材,不依赖外部图床。

    一只头顶金色光环、带粉色翅膀的蓝白小鸟

    图片说明:首页字符画所参考的小鸟形象。

    图片也可以使用引用式写法,或者包在链接里:

    蓝白小鸟,点击阅读 Typst 图片排版示例

    分隔线

    下面是一条 Markdown 分隔线,用来表示话题转换。


    三个以上的 -、* 或 _ 都可以生成分隔线;用空行把它与前后的内容分开。

    脚注

    脚注适合放不想打断正文的说明,比如这份示例使用的图片来源1。同一个脚注可以再次引用1,也可以写包含多段内容的长脚注2。

    公式

    行内公式使用一对美元符号,例如 a2+b2=c2a^2 + b^2 = c^2,以及欧拉公式 eiπ+1=0e^{i\pi} + 1 = 0。

    独立公式使用两对美元符号:

    ∑k=1nk=n(n+1)2,∫−∞∞e−x2 dx=π\sum_{k=1}^{n} k = \frac{n(n+1)}{2}, \qquad \int_{-\infty}^{\infty} e^{-x^2}\,\mathrm{d}x = \sqrt{\pi}

    矩阵、行列式和分段函数:

    A=(1234),det⁡(A)=−2A = \begin{pmatrix} 1 & 2 \\ 3 & 4 \end{pmatrix}, \qquad \det(A) = -2 f(x)={x2x≥0−xx<0f(x) = \begin{cases} x^2 & x \geq 0 \\ -x & x < 0 \end{cases}

    多行推导可以使用 aligned:

    (a+b)2=(a+b)(a+b)=a2+2ab+b2\begin{aligned} (a+b)^2 &= (a+b)(a+b) \\ &= a^2 + 2ab + b^2 \end{aligned}

    HTML 补充与 Typst 片段

    下面的术语表使用 HTML,不需要额外启用 Markdown 方言里的定义列表扩展:

    Markdown
    用轻量标记组织内容,适合连续写作。
    Typst
    把内容、函数和布局组合在一起,适合需要结构化排版的文章。
    展开一段补充说明

    这是折叠区域里的 Markdown 正文。折叠区域、键盘标签和缩写说明属于 HTML 补充,不是 Markdown 的核心语法。

    本站还会把语言名为 typst 的代码块转换成排版结果:

    小鸟 蓝鸟 粉鸟
    种子数量 4 7

    ∑k=1nk=n(n+1)2\sum_{k = 1}^{n}k = \frac{n(n + 1)}{2}

    想保留 Typst 源码,就把语言名写成 typ:

    $ sum_(k=1)^n k = (n(n+1)) / 2 $

    Footnotes

    1. 图片复用自仓库已有的小鸟素材,保存在 src/content/article/_assets/bird.jpg,两篇示例共用同一个文件。 ↩ ↩2

    2. 这是脚注的第一段。

      这是同一条脚注的第二段,也可以包含 强调、链接 和代码:

      不打断正文,也不丢掉补充信息。
      ↩