在前端开发中，我们常常需要编写复杂的文档并添加目录结构。这时，npm 包 zeppelin-toc-spell 可以帮助我们快速生成一个目录结构，让文档更加易于阅读和导航。在本文中，我们将介绍如何使用 zeppelin-toc-spell。
安装 zeppelin-toc-spell
在开始使用 zeppelin-toc-spell 之前，我们需要先安装它。我们可以使用 npm 在命令行中输入以下命令安装 zeppelin-toc-spell：
npm install zeppelin-toc-spell --save
安装完成后，我们就可以在项目中使用 zeppelin-toc-spell 了。
使用 zeppelin-toc-spell
使用 zeppelin-toc-spell 非常简单。我们只需要在文档中添加标记，然后在适当的位置使用 zeppelin-toc-spell 插件就可以了。
首先，在需要添加目录的文档中，找到要作为一级标题的内容，例如：
# 我的文章标题
我们需要在它的下一行输入以下标记：
<!-- TOC -->
这将指示 zeppelin-toc-spell 插件生成目录，并将其插入到此处。
接着，我们需要在文档中适当的位置，使用 zeppelin-toc-spell 插件。假设我们希望在文档的右侧添加目录，我们只需要在 HTML 文档中添加以下代码即可：
<div class="toc"></div>
然后，在 JavaScript 中，我们需要添加以下代码调用 zeppelin-toc-spell：
var toc = require('zeppelin-toc-spell');
toc('.toc', {
selector: 'h1, h2, h3, h4, h5, h6', // 目录层次范围
container: '.content' // 目录插入位置
});最后，我们只需要在终端中输入以下命令启动文档服务器，就可以在浏览器中查看我们的文章以及生成的目录了。
npm start
示例代码
下面是一个示例，展示如何使用 zeppelin-toc-spell 生成目录：
-- -------------------- ---- -------
- ------
---- --- ---
- -----------
- ---- ---------
- -----------
- ---- ---------
- ---- ---------
- ---- ---------
---- ---- ---
-- ---
--- --- -
---------
-- ---
--- --- -
---------
--- --- -
---------
--- --- -
---------
---- ------------------
--------
--- --- - ------------------------------
----------- -
--------- ---- ---- -- --- -- - -- --
---------- ----------
---
---------总结与指导
在本文中，我们介绍了如何使用 npm 包 zeppelin-toc-spell 生成目录。使用它，我们可以快速生成复杂文档的目录结构，让读者能够更快地找到自己想要的内容。如果你正在编写需要添加目录结构的文档，不妨试试使用 zeppelin-toc-spell 插件吧！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600562f581e8991b448e0b55