标题 - 目录生成
# 标题目录生成
推荐使用DocToc，使用自带的vuepress即可
# typora
输入
[TOC]
1
生成所有标题
但不能在 github vuepress 中正常显示，可在 csdn 中使用
# vuepress
输入
[[TOC]]
1
只生成二级、三级标题，新版本可以使目录栏支持h2~h6标题v1.10.0 +
只在 vuepress 中显示
# markdown.extractHeaders
- 类型: Array
- 默认值: ['h2', 'h3']
Markdown 文件的 headers (标题 & 小标题) 会在准备阶段被提取出来，并存储在 this.$page.headers 中。默认情况下，VuePress 会提取 h2 和 h3 标题。你可以通过这个选项来修改提取出的标题级别。
module.exports = {
markdown: {
extractHeaders: [ 'h2', 'h3', 'h4', 'h5', 'h6' ]
}
}
1
2
3
4
5
2
3
4
5
注：此配置来自 VuePress官方文档 (opens new window)
# DoCToc
DocToc (opens new window)：为本地git仓库内的markdown文件生成目录。链接与github或其他站点生成的锚点兼容。
全局安装
npm install -g doctoc
1
使用方法：
官方文档：https://www.npmjs.com/package/doctoc (opens new window)
DocToc 默认在顶头生成目录，但在 vuepress 中顶头写的是配置
所以需要自定义目录位置
<!-- START doctoc -->
<!-- END doctoc -->
1
2
2
例如：
// my_new_post.md
Here we are, introducing the post. It's going to be great!
But first: a TOC for easy reference.
<!-- START doctoc -->
<!-- END doctoc -->
# Section One
Here we'll discuss...
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
生成目录
生成一个文件 README.md
doctoc README.md --github
1
更新目录
更新一个文件 README.md
doctoc README.md --github -u
1
目录下所有文件一键生成
在项目根目录中
doctoc . --github -u
1
此命令只会在有标记记录的md文件 生成/更新 目录
若你想每个文件都生成，需要自己在每个文件中加上标记
# 标题建议
为了链接适配 github 及 vuepress 标题锚点兼容
建议
不要使用小写数字+空格，可用大写数字+空格
不要使用符号
可以用空格，且只能一个空格
三级标题及更小标题不可添加符号及空格
正确：
## 一 java简介
## 二 Java的特性和优势
## Java三大版本
1
2
3
2
3
错误
//使用二个空格
## 一 java简介
//使用符号
## 2、java简介
//三级及以下标题不可加符号和空格
### 三 Java三大版本
1
2
3
4
5
6
7
2
3
4
5
6
7
两者生成的锚点链接差异：访问下文
总结：不用符号
在 GitHub 上编辑此页 (opens new window)
最后更新: 2022/06/12, 3:06:00