← Go back

MarkDown语法三

MarkDown目录生成

Table of contents

Open Table of contents

    此篇博文乃MarkDown的结尾篇,单独讲述MarkDown目录的生成,因为篇幅较长,所以单独作为一篇博文发表,如果你对MarkDown的语法还不是很了解,请阅读MarkDown语法一和MarkDown语法二

    在编写一些技术开发文档的时候,通常篇幅较长,为了快速定位和浏览,可以生成篇内目录。下面是 Kramdown 的写法:

    * 目录
    {:toc}
    

    语法

    {:toc} 是 Kramdown 扩展语法,用在无序列表之后。

    [TOC] 和 [MENU] 是部分编辑器或平台自己的约定;本项目的 Kramdown 不会识别,会原样显示。

    说明

    格式说明

    • {:toc} 会把前面的无序列表替换为标题目录。
    • 这是 Kramdown 扩展,不属于通用 Markdown 语法。

    功能说明

    • 未另行配置时,Kramdown 会把带有 ID 的标题(默认 h1 至 h6)加入目录;可通过 toc_levels 配置范围。
    • 本博客顶部的目录由 front matter 中的 catalog: true 和 js/paper.js 生成,读取正文的 h1 至 h6;这是站点主题功能,与 {:toc} 不同。

    关于序号

    目录只显示标题原文,不会自动编号或判断标题是否已有序号。需要编号时,请把序号直接写入标题;以下是手动编号的标题示例。

    数字序号示范

    4.1 示范

    (4.2) 示范

    中文序号示范

    第一章 示范

    第二节 示范

    三、示范

    (四) 示范

    (十四) 示范

    【一百二十三】示范

    【壹佰伍拾陆】示范

    英语序号示范

    chapter 1 exa

    section 2 exa

    part 3 exa

    step 4 exa

    罗马数字序号示范

    Ⅰ. 示范

    Ⅶ 示范