Markdown 目录

Markdown 目录

TOC

TOC 全称为 Table of Content，自动列出全部标题。

• 用法：
  [toc]

  在 Markdown 中，自动生成目录非常简单，只需要在恰当的位置添加 [TOC] 符号，凡是以 # 定义的标题都会被编排到目录中。

  note:

  1. 如果你想要在你的 TOC 中排除一个标题，请在你的标题 后面 添加 {ignore=true} 即可
  2. 部分平台支持，已测试typora支持， vscode-Markdown TOC插件支持（vscode原生Markdown不支持）

手动书写目录

vscode-Markdown All in One插件， 可以直接生成目录， 内容和手写目录基本一样, 插件生成目录： Ctrl + Shift + P -> markdown all in one create table of contents（该方案会生成所有的标题目录，并按标题等级生成无序列表目录）

• 手写目录

手动添加目录的方法就是将「列表」和「页内超链接」相结合。（与HTML的锚点链接类似）

• 用法：
  [目录名](#标题链接)

• 规则：

  1. 标题链接格式为： 一个 # + 被链接标题
  2. 标题链接中不能出现大写字母，大写字母用小写字母代替
  3. 标题链接中不能出现空格 ，空格 用 - 代替。

  note:

  1. 目录排布由 有序列表 或 无序列表 控制
  2. 跳转与 目录名 无关，标题 和 标题链接 符合规则即可

• 栗子：

  // 目录
   
  * [跳到1. 这是一级标题](#1-这是一级标题)
    * [跳到1.1. 这是二级标题 1-1](#11-这是二级标题-1-1)
    * [跳到1.2. 这是大写字母标题 QWER](#12-这是大写字母标题-qwer)
      * [跳到1.2.1. 这是 空格测试标题](#121-这是-空格测试标题)
   
  // 标题
   
  # 1. 这是一级标题
   
  ## 1.1. 这是二级标题 1-1
   
  ## 1.2. 这是大写字母标题 QWER
   
  ### 1.2.1. 这是 空格测试标题
   
  // 预览效果如下：

  • 跳到1. 这是一级标题
    • 跳到1.1. 这是二级标题 1-1
    • 跳到1.2. 这是大写字母标题 QWER
      • 跳到1.2.1. 这是 空格测试标题

1. 这是一级标题

1.1. 这是二级标题 1-1

1.2. 这是大写字母标题 QWER

1.2.1. 这是 空格测试标题

插入HTML标签

Markdown支持原生 HTML 语法，可以使用内联样式，这个就不介绍了。

Via

• https://www.bookstack.cn/read/mpe/zh-cn-toc.md
• http://www.imooc.com/wiki/markdownlesson/markdowntoc.html