前言
Hexo 是一个静态博客框架，它的核心是基于 Node.js 的，提供了强大灵活且易于使用的功能，使得它成为一个非常受欢迎的博客框架。而 hexo-toc-ext 则是 hexo 上一个非常实用的 npm 包，通过它可以非常简单地生成文档的目录，避免了用户手动生成目录的麻烦，极大地提高了文档的可读性。
本文将介绍如何通过 npm 包 hexo-toc-ext 来快速生成 hexo 文档的目录，以及其相关的使用方法和例子。
环境准备
在使用 hexo-toc-ext 之前，你需要先安装 Hexo 和 Node.js。假设已经完成了这些操作，下面进入正文：
安装 hexo-toc-ext
在 hexo 博客根目录下，可以通过以下命令安装 hexo-toc-ext：
--- ------- ------------ ------
其中 --save 是为了把这个包写入 package.json 文件中，便于后来的依赖管理。
配置 hexo-toc-ext
在 hexo 博客根目录下的 _config.yml 文件中增加如下内容，即可对 hexo-toc-ext 进行基本配置：
----
------- ---- ----- ---
-------
- --------------
- ----------------------其中，format 项表示目录的格式，这里使用了 EJS 的模板语法，表示从文章的 title 标签中获取目录值。更多模板语法相关的信息可以参考 EJS 的官方文档： https://ejs.co/#docs
ignore 项表示忽略的文章，这里以正则表达式的格式进行配置。需要忽略的文件以及文件夹可以通过这个配置项进行筛选，可以极大地提高 hexo-toc-ext 的使用效率。
使用 hexo-toc-ext
在需要生成目录的 hexo 博客文章中，添加如下代码：
---- --- --- -- ----------------- - ------------ ----- ------ -- ---------- -- ------ ----- -- -- ---- ---- ---
其中 toc 函数就是 hexo-toc-ext 的核心 API，它的输入是当一个文章的内容，输出则会自动生成目录。这里的一些参数解释如下：
list_number: 是否显示序号，默认为false。depth: 目录的最小标题级别，默认为2。max_depth: 目录级别的最大深度，超过此深度的标题将不被加入目录，默认为3。class: 目录的 CSS 类名，默认为toc。
同时，为了确保实际有目录可以生成，需要在文章中至少加上两个标题，用以表示目录的层级。
示例代码
以下是一个文章示例的完整代码：
--- ------ -- ------------ ------ ----- ---------- -------- ----------- - ---- ----- - ---- - --- ---- ---- --- ---- --- --- -- ----------------- - ------------ ----- ------ -- ---------- -- ------ ----- -- -- ---- ---- --- -- ---- -------- --- ---- -------- ---- ---- -------- ----- ---- -------- ------ ---- -------- ------- ---- --------
页面效果如下：
结尾
通过本文的介绍，相信你已经学会了如何通过 hexo-toc-ext 自动生成 hexo 的文章目录。值得一提的是，通过 npm 包可以非常方便地扩展 hexo 的功能，更多有趣的 Hexo 插件可以在 https://hexo.io/plugins/ 上找到。
在使用 npm 包的过程中，需要注意在生产环境中使用较稳定的包版本，以避免出现不必要的不兼容性问题。同时，自己撰写 npm 包也需要保证安全性，并审慎选择包名，避免冲突与混淆。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/6005536e81e8991b448d0a15