Hexo添加目录(Toc)

注:有的主题自带目录插件(Toc)那么就不能使用此方法 只适用主题无自带的目录
此插件也不能和边栏Toc同时使用 如果你有边栏Toc 那么请从删除其中一个
此插件为文章插入的toc 效果如下

@[TOC]

1.安装

首先我们执行

1
npm install hexo-toc --save

如果您使用的是默认源下载很慢,那么请更换为国内源

1
npm config set registry https://registry.npmmirror.com 

2.配置

安装完成后
在博客根目录下的 _config.yml添加如下配置

1
2
toc:
maxDepth: 3

即可
这里maxdepth的意思为
maxdepth:使用深度最大为 maxdepth 的标题
原文maxdepth: Use headings whose depth is at most maxdepth.
注:此结果是谷歌翻译
如果您有更多需要
添加其他的参数的话
请看GitHub
这里是谷歌翻译各项参数结果
maxdepth:使用深度最大为 maxdepth 的标题。
class:目录的 CSS 类。 (默认为关)
slugify:选择您要使用的 slugify 功能。 目前支持uslug(默认)和音译。
decodeEntities:选择是否启用解码实体。 (默认为关,请参阅#15)。
锚点:每个标题是否应该有一个锚点。 (默认为关)
位置:锚应该在哪里,标题,或者标题。 (默认为afterbeforeafter);
符号:您希望锚点是哪个符号。 (默认为#);
style:锚的 CSS 类,(默认为 header-anchor);

3.使用

在文章您想添加目录的位置输入

1
<!-- toc -->

4.其他

解决Hexo建站使用toc目录跳转undefined的问题

作者

KCBPMBF

发布于

2022-08-13

更新于

2022-08-22

许可协议

CC BY-NC-SA 4.0


评论