解决github的md使用toc无法生成目录
markdown可以使用[toc]
语法来生成目录,但github不支持[toc]
标签
目录语法规则
目录支持另外一种语法,即
- [显示在目录上的一级标题名](#实际一级标题名)
- [显示在目录上的二级标题名](#实际二级标题名)
但()里的实际标题名有一些规则,如果是包含空格,则需要替换为-,如果是其他特殊字符直接忽略掉
- 举例
# 标题 1
1111
## 1.1、标题1a d !@#$% aa
2222
生成的目录为:
- [标题 1](#标题-1)
- [1.1、标题1a d !@#$% aa](#11标题1a-d--aa)
但每次手写目录过于麻烦,可以借助其他代码来生成这个格式的目录,或者借助vs code插件自动生成目录
使用vs code插件生成目录
- 安装插件markdown all in one
![](https://img2023.cnblogs.com/blog/3021099/202306/3021099-20230607215237064-910772360.png)
- vscode中打开md文件
![](https://img2023.cnblogs.com/blog/3021099/202306/3021099-20230607215840767-1733949407.png)
- 光标定位到需要生成目录的行,打开命令面板(快捷建:Shift+Command+P),输入markdown all in one create table of contents
![](https://img2023.cnblogs.com/blog/3021099/202306/3021099-20230607220655922-1954494979.png)
选中,生成目录
![](https://img2023.cnblogs.com/blog/3021099/202306/3021099-20230607220754307-858041999.png)