懂AI
typedoc

typedoc

TypeScript项目文档自动生成器

TypeDoc是一款专业的TypeScript项目文档生成工具。它可自动分析项目结构并生成API文档，支持多入口点和单体仓库。TypeDoc提供命令行界面，易于集成到开发流程中。通过灵活的主题定制，TypeDoc能够满足不同项目的文档需求，有助于提高代码的可维护性。

命令行工具NPM包Github开源项目TypeDocTypeScript文档生成器
访问官网GitHub文档

TypeDoc

TypeScript项目的文档生成器。

CI NPM版本

文档

有关更详细的文档、更新日志以及使用TypeDoc渲染的TypeDoc文档，请访问 https://typedoc.org。

安装

TypeDoc运行在Node.js上，可作为NPM包使用。

npm install typedoc --save-dev

使用方法

要生成文档，TypeDoc需要知道你的项目入口点和TypeScript编译器选项。它会自动尝试查找你的tsconfig.json文件，所以你只需指定库的入口点即可：

typedoc src/index.ts

如果你有多个入口点，请分别指定每个入口点。

typedoc package1/index.ts package2/index.ts

如果你指定一个目录，TypeDoc将使用entryPointStrategy选项来决定如何解析它。默认情况下，TypeDoc将在该目录下搜索名为index的文件。

单体仓库 / 工作区

如果你的代码库由一个或多个npm包组成，你可以为每个包单独构建文档，然后通过设置entryPointStrategy为packages将结果合并到一个站点中。在这种模式下，TypeDoc需要在每个目录中提供配置来指定入口点。有关示例设置，请参见 https://github.com/Gerrit0/typedoc-packages-example

参数

有关命令行参数的完整列表，请运行typedoc --help或访问我们的网站。

  • --out <文档输出路径/><br> 指定文档应该写入的位置。默认为./docs
  • --json <输出路径/output.json><br> 指定描述项目的json文件的位置和文件名。指定此选项时，除非同时指定了--out，否则不会生成文档。
  • --options<br> 指定应该加载的json选项文件。如果未指定，TypeDoc将在当前目录中查找'typedoc.json'。
  • --tsconfig <tsconfig.json路径><br> 指定应该加载的typescript配置文件。如果未指定，TypeDoc将在当前目录中查找'tsconfig.json'。
  • --exclude <模式><br> 当提供路径作为源时，使用给定的模式排除文件。支持标准的minimatch模式。

主题

  • --theme <default|插件定义的主题><br> 指定应该使用的主题。
  • --name <文档标题><br> 设置将在模板头部使用的项目名称。
  • --readme <readme路径|none><br> 应该在索引页面显示的readme文件的路径。传递none可禁用索引页面，并从全局页面开始文档。

其他

  • --version<br> 显示TypeDoc的版本号。
  • --help<br> 显示所有TypeDoc选项。

贡献

本项目由开发者社区维护。欢迎并感谢贡献。 你可以在GitHub上找到TypeDoc；随时打开问题或创建拉取请求： https://github.com/TypeStrong/typedoc

更多信息，请阅读贡献指南。

编辑推荐精选

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境（IDE），通过自动化和多元协作改变开发流程。利用Trae，团队能够更快速、精确地编写和部署代码，从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能，是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手，随时解答生活与工作的多样问题

问小白，由元石科技研发的AI智能助手，快速准确地解答各种生活和工作问题，包括但不限于搜索、规划和社交互动，帮助用户在日常生活中提高效率，轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手，它拥有超精准的音频识别翻译能力，几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球，无论你是留学生、商务人士、韩剧美剧爱好者，还是出国游玩、多国会议、跨国追星等等，都可以满足你所有需要同传的场景需求，线上线下通用，扫除语言障碍，让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word，让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目，能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定，还是学生群体的职业生涯规划、实习避坑指南，亦或是活动策划、旅游攻略等内容，它都能提供支持，帮助用户精准表达，轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级，全面对标OpenAI o1

科大讯飞的星火大模型，支持语言理解、知识问答和文本创作等多功能，适用于多种文件和业务场景，提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台，涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能，能为不同需求的用户提供便捷高效的帮助，助力用户轻松获取信息、解决问题，满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目，由多个知名机构联合参与。该项目提供了高效的 LLM（大语言模型）驱动的语音合成方案，支持语音克隆和语音创建功能，可通过命令行界面（CLI）和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数，生成高质量的语音。该项目适用于多种场景，如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力，做PPT更简单！

咔片是一款轻量化在线演示设计工具，借助 AI 技术，实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT，提供海量模板、智能美化、素材替换等功能，适用于销售、教师、学生等各类人群，能高效制作出高品质 PPT，满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文，一站式创作，让内容运营更高效

讯飞绘文，一个AI集成平台，支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容，加速品牌传播，提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台，公文写作神器

AI 材料星，专业的 AI 公文写作辅助平台，为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能，支持 30 + 文稿类型生成，助力快速完成领导讲话、工作总结、述职报告等材料，提升办公效率，是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK，助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK，它为开发者提供了与 OpenAI 模型交互的高效工具，支持工具调用、结果处理、追踪等功能，涵盖多种应用场景，如研究助手、财务研究等，能显著提升开发效率，让开发者更轻松地利用 OpenAI 的技术优势。

下拉加载更多