在前端开发中，常常需要对文档进行目录结构生成。为了更加方便生成文档的目录，我们可以使用 npm 包 create-toc-app，它可以帮助我们快速生成 Markdown 格式的目录。
安装
使用以下 npm 命令安装 create-toc-app：
npm install -g create-toc-app
使用
使用 create-toc-app 命令，指定需要生成目录的 Markdown 文件，即可生成目录。
create-toc-app [filename]
例如，要生成 README.md 的目录：
create-toc-app README.md
生成的目录如下：
<!-- TOC --> - [npm 包 create-toc-app 使用教程](#npm-包-create-toc-app-使用教程) - [安装](#安装) - [使用](#使用) <!-- /TOC -->
我们可以把目录复制到 Markdown 文件的开头，这样读者就可以在阅读文档时方便地查看目录结构。
示例代码
下面是一个示例，假设我们有一个 Markdown 文件 mydoc.md 如下：
-- -------------------- ---- ------- - -- - -------- -- -- --- ---- --- ---- -- -- --- ---- --- ---- - -- - -------- -- -- --- ---- --- ---- -- -- --- ---- --- ----
使用 create-toc-app 命令，指定需要生成目录的 Markdown 文件 mydoc.md，即可生成目录。
create-toc-app mydoc.md
生成的目录如下：
-- -------------------- ---- ------- ---- --- --- - --- --------- - --- ------------ - --- ------------ - --- --------- - --- ------------ - --- ------------ ---- ---- ---
把目录复制到 Markdown 文件的开头，即可方便地查看目录。
-- -------------------- ---- ------- ---- --- --- - --- --------- - --- ------------ - --- ------------ - --- --------- - --- ------------ - --- ------------ ---- ---- --- - -- - -------- -- -- --- ---- --- ---- -- -- --- ---- --- ---- - -- - -------- -- -- --- ---- --- ---- -- -- --- ---- --- ----
使用 create-toc-app 可以快速生成 Markdown 文件的目录，并使文档更加易于阅读和理解。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600673e2fb81d47349e53dc9