For AI agents: the complete documentation index is available at https://lazygophers.github.io/pamphlet/llms.txt, the full documentation bundle is available at https://lazygophers.github.io/pamphlet/llms-full.txt, and this page is available as Markdown at https://lazygophers.github.io/pamphlet/write/text/headings.md.
  • 简体中文
  • 标题

    这是什么

    把文档切成一节一节的那行字。一到六级,# 越多级别越低。

    侧边的目录就是从标题生成的;每个标题还会自动得到一个锚点,可以直接链过去。

    怎么写

    # 一级标题
    ## 二级标题
    ### 三级标题
    #### 四级标题
    ##### 五级标题
    ###### 六级标题

    井号后面必须有一个空格,#标题 不是标题,是一行普通文字。七个井号也不是。

    出来是什么样

    字号、粗细、上下间距、颜色全部由主题决定,差别很大:

    主题二级标题长什么样
    editorial3.2rem 大号衬线字,前面带 01 02 章节编号
    paper1. 2. 学术编号,三级标题是斜体
    blueprint1 / 1.1 / 1.1.1 三级编号,等宽字
    architecture带 § 编号
    console全等宽,方角

    同一份文档换个主题,标题的样子完全不同,内容一个字不变。

    一级标题是文档标题

    文档里第一个 # 会变成产物的 <title>(浏览器标签页上那行字),除非你在 frontmatter 里写了 title。

    它也不进目录——目录是文档内部的导航,文档标题本身不是其中一节。

    所以:正文分节从 ## 开始,一份文档里 # 只写一个。

    锚点是怎么算出来的

    标题写的得到的锚点
    ## 提示块#提示块
    ## Theme tokens#theme-tokens
    ## 第 1 步:装一次#第-1-步装一次

    规则:转小写、空格换成连字符、标点去掉、中文原样保留。两个标题重名时,第二个自动加 -2。

    文档内部跳转就写 [跳到提示块](#提示块)。

    坑

    • 目录默认只收到二级。三级以下想进目录,frontmatter 里写 toc: { deep: 3 },见 frontmatter 参考
    • 别用标题当强调。想把一行字加粗就用 **粗体**,用 #### 会污染目录和文档大纲
    • 标签页(Tab)的指令标题也会变成真标题、也会进大纲——所以 toc.skipTabs 默认是 true