特性

  • 支持 — Angular, NestJS & Stencil

  • 干净,简单的设计 — 使用 Compodoc，主要端点位于文档的左侧，所有内容位于右侧

  • 美丽的主题 — 8 个主题可以从著名的文档工具如Gitbook, Read the Docs 或项目如 Vagrant, Laravel, Postmark, Material design and Stripe中获得.

  • i18n — 许多可用的语言: de-DE, en-US, es-ES, fr-FR, hu-HU, it-IT, ja-JP, nl-NL, pl-PL, pt-BR, sk-SK, zh-CN

  • 搜索 — Compodoc 包括一个强大的搜索引擎(lunr.js)，可以方便地找到您的信息

  • 自动目录 - API 目录是使用在文件解析期间找到的元素生成的

  • 开源和 npm 发布 - 使用 npm 和一个脚本直接在你的项目中使用它，就是这样!

  • 当地的一个工具 - 不需要服务器，不需要在线上传资源

  • 没有 TypeScript 编译 - Compodoc 解析你的代码

  • JSDoc 轻支持 - 支持 @param, @returns, @link, @ignore and @example 标签

  • 文档覆盖 - 获取项目的文档覆盖率报告

  • Angular-CLI 友好 - Compodoc 支持开箱即用的 Angular-CLI 项目

  • 暗黑模式 - Compodoc 支持您的浏览器的开箱暗模式