dartdoc是否已移除Markdown文档生成支持？求替代方案

一、dartdoc是否移除了Markdown生成支持？ #

是的，dartdoc在后续版本（包括你使用的8.0.8）中已经移除了--format=md参数，当前官方仅支持HTML格式的文档输出，旧版本的Markdown生成功能已被废弃。

二、Flutter/Dart项目生成Markdown文档的替代方案 #

1. 用dartdoc_markdown第三方包生成 #

这是专门为dartdoc补充Markdown输出的工具，基于dartdoc的代码分析能力生成规范的Markdown文档，适配GitHub Wiki需求：

• 安装：在项目根目录执行 dart pub add dartdoc_markdown --dev
• 使用：
  • 确保项目代码已经按照dartdoc规范写好注释
  • 执行命令 dart run dartdoc_markdown，默认会在项目根目录生成docs/markdown文件夹，里面是分模块的Markdown文档
  • 还能自定义输出路径、排除不需要的目录，比如 dart run dartdoc_markdown --output ./wiki-docs --exclude test

2. 自定义脚本解析dartdoc的JSON输出 #

dartdoc支持输出JSON格式的代码分析结果，你可以写个简单的Dart脚本把JSON转成Markdown：

• 先生成JSON：执行 dart doc --output ./doc-json --format json
• 编写Dart脚本：读取JSON文件，遍历里面的库、类、方法、属性节点，按照GitHub Wiki的格式（比如层级标题、列表、代码块）生成对应的Markdown内容
• 这种方式灵活性最高，能完全自定义文档的结构和样式

3. HTML转Markdown（适合已有HTML文档的情况） #

如果已经用dartdoc生成了HTML文档，可以用工具把HTML转成Markdown，再调整格式适配GitHub Wiki：

• 先生成HTML：执行 dart doc
• 用工具转换：比如用Python的pandoc或html2text批量把HTML文件转成Markdown
• 注意：转换后可能需要手动调整细节，比如代码块格式、链接路径、标题层级，让它更符合GitHub Wiki的显示效果

4. 手动编写核心文档（小型项目首选） #

如果项目规模不大，核心API不多，直接手动写Markdown文档更高效：从代码注释里复制关键内容，按照GitHub Wiki的格式整理成文档，既能保证准确性，还能根据需求精简内容

内容的提问来源于stack exchange，提问作者L483