Compodoc是否支持生成Markdown文档？若支持，对应的CLI选项是什么？

嘿，刚好对这个问题有研究——Compodoc完全支持从TypeScript注释生成Markdown格式的文档，完全能替代默认的HTML输出，完美匹配Visual Studio Team Services（现在叫Azure DevOps）Wiki只接受Markdown文件的要求。

下面是你需要知道的关键细节：

核心CLI选项 #

要生成Markdown文档，只需要在Compodoc命令中添加 --format markdown 参数即可，结合常用选项的示例如下：

• 基础生成命令（基于你的tsconfig.json配置）：

  npx compodoc -p tsconfig.json --format markdown
  

• 指定自定义输出目录（默认输出到documentation文件夹，这里改成适合VSTS Wiki的路径）：

  npx compodoc -p tsconfig.json --format markdown -o ./vsts-wiki-output
  

• 如果需要包含私有成员的文档：

  npx compodoc -p tsconfig.json --format markdown --includes-private
  

适配VSTS Wiki的小建议 #

• Compodoc生成的Markdown文件结构非常规整，每个模块、类、接口都会生成独立的.md文件，直接上传到VSTS Wiki的仓库就能使用，不需要额外调整结构。
• 要是需要自定义文档内容或排除某些文件，可以创建compodoc.json配置文件来精细化控制，比如设置exclude字段排除特定目录，或者调整title自定义文档标题。

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