跳转至

mkdocstrings 对 TypeScript 评估

目的：评估 mkdocstrings 是否适合 Claude Code 文档 关联：[B1-3]

1. 评估结果

结论：不推荐 Claude Code 使用 mkdocstrings 对 TypeScript。

3 原因： 1. mkdocstrings 主要支持 Python（griffe 解析器） 2. TypeScript 解析需第三方（TypeDoc 等）但集成度低 3. Claude Code 文档手工已足够

2. 3 个候选

工具 TS 支持 成熟度
mkdocstrings (griffe) ❌ 弱 成熟
TypeDoc ✅ 强 成熟
typedoc-plugin-markdown ✅ 集成

3 候选。

3. 为什么不推荐

3.1 成本

  • mkdocs + TypeDoc 双工具链
  • 配置复杂
  • 维护成本

3.2 收益有限

  • Claude Code 已有 ~70 文档
  • 多数是分析 / 教程而非 API 文档
  • 手工写更精确

3.3 替代

4. TypeDoc 集成（如果要做）

# mkdocs.yml
plugins:
  - search
  - typedoc:
      source: ../src
      output: api

2 步。

5. 5 个替代方案

  1. ✅ 继续手工（推荐）
  2. ⚠️ TypeDoc 单用
  3. ⚠️ typedoc-plugin-markdown + mkdocs
  4. ❌ mkdocstrings（不支持 TS）
  5. ❌ Docusaurus（重）

5 替代。

6. 结论

不集成 mkdocstrings。

已用文档足够。

7. 总结

评估 = 不推荐 + 5 替代。

下一步： - 继续手工 - 看其他 B1