本文将介绍一款方便实用的 npm 包 txt_tocfill，该包能够自动生成 markdown 文件的目录，并将其填充到文件中。
概述
在编写较长的 markdown 文件时，经常需要添加目录作为导航，以方便读者。手动生成目录不仅费时，还容易出错。而 txt_tocfill 包就能够快速、准确地生成 markdown 文件中的目录，从而使文章结构更加清晰易懂。
安装和使用
我们可以使用 npm 来进行安装：
npm install -g txt_tocfill
使用该包也非常简单，只需要执行以下命令即可：
txt_tocfill -i input.md -o output.md
其中，input.md 是原始 markdown 文件的路径，output.md 是输出文件的路径。如果您想在原始文件上进行修改，则可以忽略 -o 参数，如下所示：
txt_tocfill -i input.md
此时，生成的目录将直接填充到 input.md 文件中。
高级用法
txt_tocfill 还提供了一些高级选项，使得生成的目录更加灵活。以下是一些实用的选项：
--depth：指定生成目录的层级深度；--skipPattern：跳过匹配规则，不生成目录；--title：生成的目录标题；--appendContent：在目录和正文之间添加文本内容。
现在我们来详细介绍一下这些选项。
指定生成目录的层级深度
有时候，我们并不想把整篇文章全部加入目录，而只是想列出其中的某些层级。这时，我们可以使用 --depth 选项。
比如，如果我们只想列出一级标题和二级标题，可以这样使用：
txt_tocfill -i input.md -o output.md --depth 2
上面的命令中，--depth 2 表示只生成一级标题和二级标题的目录。
跳过匹配规则
有时候，我们想忽略某些特定的标题（如部分前言、说明等），不在目录中列出。这时，我们可以使用 --skipPattern 选项来指定要跳过的标题。
比如，如果我们想跳过所有带有 [skip] 标记的标题，可以这样使用：
txt_tocfill -i input.md -o output.md --skipPattern "\[skip\]"
指定生成的目录标题
有时候，我们想自定义生成的目录标题。比如，如果我们想使用中文标题「目录」，可以这样使用：
txt_tocfill -i input.md -o output.md --title 目录
在目录和正文之间添加文本内容
有时候，我们想在目录和正文之间添加一些自定义的文本内容（如版权声明等）。这时，我们可以使用 --appendContent 选项。
比如，如果我们想在目录和正文之间添加一行版权声明，可以这样使用：
txt_tocfill -i input.md -o output.md --appendContent "\n\n© 2021 My Blog, All rights reserved."
示例代码
为了更好地应用和理解，我们提供一份示例代码。该示例代码包含两个文件：
1、test.md：原始 markdown 文件，用于生成目录；2、test_output.md：输出文件，其中包含了生成的目录。
我们要做的事情就是在 test.md 中添加一些 markdown 格式的标题，运行 txt_tocfill 命令，然后将生成的目录插入到 test.md 中。
-- -------------------- ---- ------- ---- ------- --- - --- ---- -- ---- --- ----- --- ----- --- ----- -- ---- -- ---- -- ---- - --- ---- -- ---- -- ---- --- -----
然后，我们执行以下命令：
txt_tocfill -i test.md -o test_output.md --depth 2 --title 目录 --skipPattern "注.*"
最后，将生成的目录插入到 test.md 中即可：
-- -------------------- ---- -------
---- ------- ---
- ---
---- ----- -------- ---
-------------
-- -----------
-- -------------
-- ---------------
-- ---------------
-- ---------------
-- -------------
-- -------------
-- -------------
-- -----------
-- ---------------
-- ---------------
-- -----------------
---- --- -------- ---
----
-- ----
--- -----
--- -----
--- -----
-- ----
-- ----
-- ----
- ---
----
-- ----
-- ----
--- -----可以看到，我们成功使用 txt_tocfill 生成了一个层级为 1-2 的目录，并将其插入到了文件中。
总结
本文介绍了 npm 包 txt_tocfill 的使用方法，并详细介绍了其高级选项。通过使用 txt_tocfill，我们可以方便地在 markdown 文件中生成目录，从而提高文章的可读性和可理解性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64403