在前端开发中,我们经常需要写文档或者整理现有文档。而生成文档目录是一个常见需求。本文将介绍一个通过 npm 包调用 Markdown 文档自动生成目录的方法:metalsmith-doctoc-cheerio。
metalsmith-doctoc-cheerio 的使用
安装 metalsmith-doctoc-cheerio
我们需要通过 npm 来安装它,你可以在你的项目中运行以下命令:
--- ------- ------------------------- ----------
配置 Metalsmith
--- ---------- - ---------------------- --- -------- - ------------------------------- --- ------- - ------------------------------------- --------------------- -------------- --------------------- ---------------- --------------- --------------- ----- - -- ----- ----- ---- ---
在这里,我们加载 metalsmith 和它的两个插件 markdown 和 doctoc-cheerio。我们还配置了源目录和生成目录,以及使用了 markdown 和 doctoc-cheerio 两个插件。
插件参数
doctoc-cheerio 插件可以接受一些参数来定制目录生成,如下所示:
--- ------- - ------------------------------------- --------------------- -------------- ---------- ---- --- ---- -------- -------- --
- selectors: 只有包含指定选择器的标题会在目录中出现,多个选择器使用逗号分隔。
- prepend: 在页面顶部插入一个标题,用于配合具有多个标题的页面。
示例代码
下面是一个示例文档,包含一些标题并使用 metalsmith-doctoc-cheerio 自动生成目录。
- ------- - ----- ----- ----- --- ----- ----------- ---------- ----- -- ------- - ---- ---- ---- -- ---- --------- -------- --- ------- - ------ ---------- ------ - ------ --------- ----- ---- ------- ---- --- ------ --- ---- --- ------ --- ------- ------- - ---- -- -------- ------ -- ------- ------- - ----------- ---- ---- ---------- --------- ------ ----- ------- ------
在 metalsmith-doctoc-cheerio 插件执行后,将自动生成以下目录:
---- ------------ ---- ------ ------------------------- ----- ---- ------ ------------------------- ----- ---- ------ ------------------------- ---------- ------ --------------------------------- ------- ---------- ----- ----- ------ --------------------------------- ------- ---------- ----- ----- ----- ------
总结
metalsmith-doctoc-cheerio 是一个非常有用的 npm 包,在 Markdown 文档生成目录方面有很好的表现。我们可以快速地为文档添加目录,为文档的阅读提高效率。
希望这篇文章能够对前端开发者们提供一些指导和帮助。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600559d981e8991b448d75b4