markdown-toc-sef 是一款能够生成带有锚点链接的目录的 npm 包,并且支持自定义锚点链接的格式。在前端开发中,经常会使用 markdown 进行文档编写,如果需要生成文档目录和锚点链接,markdown-toc-sef 是一款不错的选择。
安装
使用 npm 进行全局安装:
npm install -g markdown-toc-sef
使用示例
生成目录:
markdown-toc-sef README.md
生成带有锚点链接的目录:
markdown-toc-sef README.md --linkTemplate '<a href="#%s">%s</a>'
其中,--linkTemplate
参数是用于自定义锚点链接格式的,%s
代表插入目录标题和链接的位置。
目录深度控制
默认情况下,markdown-toc-sef 会识别 h1~h6 六级标题,生成相应深度的目录。可以使用 --maxHeadingLevel
和 --minHeadingLevel
参数来控制识别的最大和最小标题深度。
markdown-toc-sef README.md --maxHeadingLevel 3
该命令将只识别 h1~h3 三级标题,并生成相应深度的目录。
指定目录生成位置
如果需要将生成的目录插入到指定位置,可以使用 --insert
参数,比如:
markdown-toc-sef README.md --insert README.md
上述命令将在 README.md
文件中插入生成的目录。
总结
通过使用 markdown-toc-sef,我们可以方便地生成带有锚点链接的目录,并且支持自定义锚点链接的格式和目录深度控制。在编写文档时,能够方便地生成目录和锚点链接,不仅省去了手动添加链接的麻烦,还能提高文档的可读性和用户体验。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055fc381e8991b448dd1e4