用途:为技术规格、API 文档、用户指南和知识库提供文档生成模式,基于成熟工具与框架产出专业文档。
主要能力:Python 侧支持 Sphinx(autodoc、napoleon、typehints、myst_parser)与 MkDocs Material(mkdocstrings);TypeScript/JavaScript 侧支持 TypeDoc、JSDoc、TSDoc;API 文档支持 FastAPI/Express 生成 OpenAPI/Swagger,配合 Redoc、Stoplight;静态站点支持 Nextra、Docusaurus、VitePress;通用格式含 Markdown、MDX、reStructuredText。还涵盖从 SPEC 文件生成文档、CI/CD 文档流水线、链接检查、拼写检查、文档覆盖率检查与多语言文档。
使用方式:Sphinx 用 pip install sphinx sphinx-autodoc-typehints sphinx-rtd-theme myst-parser 安装,sphinx-quickstart docs 初始化,配置 conf.py 后运行 sphinx-apidoc 与 make html。MkDocs 用 pip install mkdocs mkdocs-material mkdocstrings mkdocstrings-python,在 Markdown 中用 ::: module.path 生成 API 文档,mkdocs serve/build/gh-deploy。TypeDoc 用 npm install typedoc --save-dev,脚本 typedoc --out docs/api src/index.ts。JSDoc 用 npm install jsdoc --save-dev。FastAPI 自带 /docs 与 /redoc。Docusaurus 用 npx create-docusaurus@latest my-docs classic,VitePress 用 npm init vitepress。
适用场景:从代码注解生成 API 文档、构建带搜索与导航的文档站点、编写用户指南与技术规格、在 CI/CD 中自动更新文档、转换文档格式。
限制:资料未提供具体收费、价格、平台支持范围与效果数据;部分工具需自行安装配置,多语言与校验能力依赖对应插件。