DocuSaurus下JavaScript代码注释转文档工具及替代方案咨询
以下是除jsdoc-to-markdown之外的可用选项,均支持实现和DocDash一致的自动导航菜单效果:
docusaurus-plugin-typedoc
虽主打TypeScript项目,但原生支持带JSDoc注释的纯JavaScript项目,可直接对接Docusaurus构建流程,无需手动中转Markdown文件。内置输出结构默认按命名空间、类、函数、属性的层级自动生成侧边栏导航,分组逻辑和DocDash完全一致,支持导航项折叠、当前页高亮,无需额外配置侧边栏。documentation.js
完全兼容JSDoc注释规范,可直接输出适配Docusaurus格式的Markdown文件,支持自定义输出模板。你可以配置生成流程同步输出Docusaurus可用的侧边栏配置文件,直接导入到Docusaurus的sidebar.js即可实现和DocDash结构一致的导航菜单,支持按模块、实例方法、静态属性自定义分组规则。jsdoc-md
轻量型JSDoc转Markdown工具,输出的文件格式更贴合静态站点生成器的要求。搭配Docusaurus官方文档插件的自动侧边栏功能,只要将生成的Markdown文件按「模块/类/方法」的层级存放到对应目录,Docusaurus会自动生成和DocDash逻辑一致的导航结构,支持自定义排序和分组规则。
通用适配技巧:若你选用的工具不直接输出侧边栏配置,可写简单的Node.js脚本遍历生成的Markdown文件的头部元数据,按DocDash的分组规则生成侧边栏配置数组,导入到Docusaurus配置中即可实现完全一致的导航效果。
内容的提问来源于stack exchange,提问作者user5507535

