很多人在看书时都习惯先从目录了解文章的整体结构,然后再快速定位到具体的章节仔细阅读。看文档也是如此。
像 Typora、VS Code、印象笔记等等 Markdown 编辑器,都支持使用 [TOC] 自动生成文章目录。可 GitHub 偏偏就不支持,如果想在 GitHub 上插入目录,只能使用锚点目录。
而锚点目录就是一种比较通用的制作目录的方法,是被绝大多数编辑器所支持的。
锚点目录格式如下:
* [一级标题](#一级标题)
* [二级标题1](#二级标题)
* [三级标题](#三级标题)
* [二级标题2](#二级标题) 除了制作目录以外,文档间的交叉引用和文档内的位置跳转都会使用到锚点。
那究竟什么是锚点?
锚点其实就是一种超链接,在 Markdown 中用于链接到文档的标题,通过锚点可以实现文档内或文档间的跳转。
锚点由锚文本和锚链接组成。
锚文本是链接指向位置的文本描述,锚链接是链接到文档和标题的路径,如果链接到的是文档内的标题,链接由 # 和标题名组成,如果链接到的是另一个文档的标题,则需要在 # 前加上文档的路径。
格式如下:
[锚点描述](#标题名)
或
[锚点描述](另一个文档.md#标题名)语法说明:
-
#和标题名之间没有空格,且不管几级标题都只有一个#。 -
标题名最好使用字母和数字,当然中文也是可以的,但不排除有些网站支持得不够好。
-
标题名是区分英文大小写的,如果标题中有字母是大写的,在链接中最好将其转换成小写。
-
标题名中不能含有空格,如果有空格请使用
-(减号)来代替,另外,最好不要有特殊字符。
目录
* [1.1 Why](#1.1-why)
* [1.2 What](#1.2-what)
* [1.2.1 Where](#1.2.1-where)
* [1.3 How](#1.3-how)
## 1.1 Why
ba la ba la
## 1.2 What
ba la ba la
### 1.2.1 Where
ba la bala
## 1.3 How
更多技巧,请参考 《[使用技巧](docs/chapter03.md#3.5-使用技巧)》。