简介
remark-toc 是一个在 markdown 文件中自动生成目录的 npm 包，可以为文档提供方便的导航功能。
安装
npm install remark-cli remark-toc
使用方法
命令行使用
remark --use remark-toc input.md -o output.md
这将会在 input.md 中生成目录，并将结果输出到 output.md。
配置文件使用
在 .remarkrc.js 或者 .remarkrc.yaml 中添加以下配置即可：
-- -------------------- ---- -------
-------------- - -
-------- -
-
-------------
-
-------- ----- -- --
------ ----- -- --
--
--
--
--API 使用
-- -------------------- ---- ------- ----- ------- - ------------------- ----- -------- - ------------------------ ----- --- - ---------------------- ----- --------- - ---------------------------- --------- -------------- --------- - -------- ----- ------ ---- -- --------------- ----------- ---------- ------------ -- ---------------------------
这将会打印出以下结果：
# 目录 - [标题](#标题) ## 标题 正文
参数选项
| 选项名 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| heading | string | "Table of Contents" | 自定义目录标题 |
| tight | boolean | false | 是否开启紧凑模式，即不在标题前添加空格 |
总结
remark-toc 是一个非常实用的 npm 包，可以方便地为 markdown 文件添加目录，提高文档的可读性和易用性。上面介绍了命令行、配置文件和 API 三种使用方式，对于不同的项目使用场景都能够适用。通过学习本文，相信大家已经可以熟练掌握 remark-toc 的使用方法。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/48458