简介
markdown-contents 是一款方便生成目录的 npm 包， 可以通过它轻松地为 markdown 文件添加目录。该工具可以使得阅读体验更好，并且在查找内容时更加方便。
安装
使用 npm 命令安装 markdown-contents：
npm install markdown-contents
使用方法
命令行使用
在终端使用以下命令来生成目录：
npx markdown-contents <path-to-markdown-file>
例如，在当前目录中的 README.md 文件中添加目录：
npx markdown-contents README.md
模块引用
将 markdown-contents 模块引入到您的项目中：
const mdContents = require('markdown-contents');然后，在需要添加目录的 markdown 文件中，通过以下方式生成目录：
const fs = require('fs');
const markdown = fs.readFileSync('./example.md', 'utf8');
const toc = mdContents(markdown).content;
console.log(toc);配置
markdown-contents 提供了一些可选配置参数，以便自定义生成的目录。下面是一些示例配置：
maxDepth：最大目录深度（默认为 6）filter：匹配哪些标题生成目录（默认为所有 h1 到 h6 标题）
const mdContents = require('markdown-contents');
const options = {
maxDepth: 3,
filter: /^h(2|3)$/,
};
const toc = mdContents(markdown, options).content;示例
假设我们有一个 markdown 文件，其中包含以下内容：
-- -------------------- ---- ------- - --- --------- -- ---- ---------- -- ---- ---------- --- ----- ----------- --- ----- ----------- - --- ---------
使用默认配置生成的目录如下：
- [标题一](#标题一)
- [子标题一](#子标题一)
- [子标题二](#子标题二)
- [孙子标题一](#孙子标题一)
- [孙子标题二](#孙子标题二)
- [标题二](#标题二)可以看到，生成的目录根据标题层次结构进行缩进，并且标题名称已链接到相应的标题位置。
结论
markdown-contents 是一个易于集成和使用的 npm 包，它可以方便地为 markdown 文件添加目录。通过使用该工具，您可以提高阅读体验，并且更加轻松地找到所需内容。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/46790