在前端开发中，Markdown 是一种功能强大的写作语言。它可以帮助我们快速地创建简洁、易读的文档，并且在远程协作时尤为方便。然而，当我们的 Markdown 文档变得越来越长时，其目录结构将变得难以阅读，这时候我们可以使用 fe-markdown-toc 来自动生成文档目录。
什么是 fe-markdown-toc？
fe-markdown-toc 是一款基于 Node.js 的 npm 包，它可以为 Markdown 文档自动生成目录。与手动生成目录相比，它可以更加快捷、更加准确地生成目录结构，极大地提高了文档阅读的效率和体验。
如何使用 fe-markdown-toc？
安装 fe-markdown-toc
使用 npm 安装 fe-markdown-toc：
npm install fe-markdown-toc --save-dev
创建 markdown 文件
在项目中创建 markdown 文件并进行书写。
运行 fe-markdown-toc
在终端中进入项目根目录，运行以下命令：
npx fe-markdown-toc -i ./README.md
此命令会在当前项目路径下生成 toc.md 文件，该文件包含你输入的 markdown 文件的目录结构。
Markdown 文件导入目录结构
在 markdown 文件中添加 [TOC] 标签，即可直接导入生成的目录结构。
例如：
-- -------------------- ---- ------- - ----- ----- ----- -- ------- - --- ----------- --- --- ----------- --- -- ------- - --- ----------- --- --- ----------- ---
在你完成以上步骤之后，你的 markdown 文件中应该已经包含了一个自动生成的目录结构，如下所示：
-- -------------------- ---- ------- - ----- ----- - -------- -------------- - ------------ --------------------- - ------------ --------------------- - -------- -------------- - ------------ --------------------- - ------------ --------------------- -- ------- - --- ----------- --- --- ----------- --- -- ------- - --- ----------- --- --- ----------- ---
总结
通过本文的介绍，你应该已经学会了如何使用 fe-markdown-toc 为你的 markdown 文件生成目录结构。目录结构的存在可以大幅提高文档的阅读体验，让读者更加轻松地阅读和查找文档内容。希望大家在使用 fe-markdown-toc 时能够收获一些帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600673dffb81d47349e53c14