运算符
用于现代Angular项目的静态文档生成器. 读取您的 TypeScript 源、组件模板和 (S) CSS, 并发布自成一体的 HTML 站点.
为何连锁店
继承人 模拟 用于现代Angular,而不是倒置替换. 它记录了Angular 21+独立代码(信号输入、输出和模型, inject(),结构化 host 元数据、功能卫士、截取器和解析器),并在您的 CSS / SCSS 令牌上方添加由 JSDoc/ SassDoc 风格注释驱动的 Theming 标签 。 渲染层是新的(JSX模板,Tailwind v4,Pagefind,D3).
NgModules, 装饰成员(@Input, (中文(简体) ), @Output, (中文(简体) ), @HostBinding, (中文(简体) ), @HostListener),Angular类和基于班级的警卫,截取器和解析器没有记录;运行时在一份遗留通知中报告. Page URL和JSON导出计划与compodoc不同. 从compodoc切换意味着改变软件包和脚本,运行,并在它打印的警告上采取行动; MIGRATION.md 解释每一个.
所需资源
- 22号节点或更新
- 角项目
tsconfig.json(Angular 21+,独立代码;对21和22进行测试)
安装
npm install --save-dev @cngxjs/compodocx
在一个角工作空间内,图示种子 tsconfig.doc.json,登记 npm 脚本,和(如果你来自 @compodoc/compodoc)替换软件包并重写 compodoc 单行本 :
ng add @cngxjs/compodocx
快开始
# Generate static documentation into ./docs
npx compodocx -p tsconfig.app.json -d docs
# Generate, serve, open in browser
npx compodocx -p tsconfig.app.json -d docs -s -o
# Watch + rebuild on every change
npx compodocx -p tsconfig.app.json -d docs -s -w
# Coverage check that fails CI under 70%
npx compodocx -p tsconfig.app.json -d docs --coverageTest 70 --coverageTestThresholdFail
CLI也暴露为 compodoc因此,现有的 npm 脚本继续运行.
配置
放下一个 .compodocxrc.json (或 .yaml, (中文(简体) ), .js)进入您的项目根. 年长者 .compodocrc 仍然找到名称 :
{
"tsconfig": "./tsconfig.app.json",
"output": "./docs",
"theme": "ocean"
}
每个 CLI 旗帜和配置密钥的完整引用 : docs/configuration.md 或者说 compodocx.dev/指针/选项。 。 。 .
文档
| 专题 | 文件 |
|---|---|
| 配置参考 | docs/configuration.md |
| 自定义 JS 模板覆盖 | docs/custom-templates.md |
| SCSS / CSS 中的主题符号 | docs/theming-tokens-authoring-guide.md |
| 额外的下行页面 | docs/additional-pages.md |
| 多版本输出 | docs/versioned-docs.md |
| JSON 输出计划历史 | docs/json-export.md |
| 国际化 | docs/i18n.md |
| 从compodoc 移动 | MIGRATION.md |
| 释放 | docs/RELEASING.md |
发展
git clone https://github.com/cngxjs/compodocx.git
cd compodocx
npm ci
npm run build
npm run test:all
| 任务 | 命令 |
|---|---|
| 单位测试 | npm run test:unit |
| CLI 整合测试 | npm run test:cli |
| 剧作家 e2e | npm run test-e2e-playwright |
| 显示/ 格式 | npm run lint 编号 : npm run format:write |
Dev 监视器在源文件更改时重建独立固定的docs站点:
npm run dev # port 8081
欢迎提出的问题和要求 github.com/cngxjs/compodocx 页面存档备份,存于互联网档案馆。 。 。 .
承认
compodocx 是一个叉 模拟 由文森特·奥格洛布林斯基和撰稿人出品. 它的编译器和JSDoc标签处理是这里所有基础的基础.
许可证
麻省理工学院. 见 LICENSE。 。 。 .