Hexo-toc插件-恢复Markdown失效的toc

本文最后更新于:2021年1月25日 中午

简介

总所周知,toc 被用于在markdown文件中自动生成目录。
而在某次 npm 更新后,hexo中的 markdown 文件的toc失效了
所以如果你如果希望继续使用 toc,就需要安装这个插件了

注意:如果使用的主题已经拥有显示目录的能力,那么不建议安装

使用方法

1. 安装hexo-toc

1
npm install hexo-toc --save

2. 在_config.yml文件中添加参数

1
2
3
4
5
6
7
8
9
toc:
maxdepth: 3
class: toc
slugify: transliteration
decodeEntities: false
anchor:
position: after
symbol: '#'
style: header-anchor
参数 意义
maxdepth 允许的最大节点深度,必填
class toc的CSS样式设置(默认值是false
slugify 选择你想要的slugify方法,目前只有uslug(默认)和transliteration两种
decodeEntities 是否要编译内容,具体看这
anchor 锚点相关的内容,默认是false
position 锚点相对于标题的位置设置,可选beforeafter(默认)
symbol 锚点的代表字符(默认是#
style 锚点的CSS样式类,默认是header-anchor

3. 在markdown文档中使用toc

在需要使用到toc的地方输入:

1
<!-- toc -->

Hexo-toc Github:https://github.com/bubkoo/hexo-toc


参考:
https://imys.net/20150514/hexo-toc.html
https://www.colabug.com/2018/1022/4979695/


本博客所有文章除特别声明外,均采用 CC BY-SA 4.0 协议 ,转载请注明出处!