# @cngxjs/compodocx 中文文档

规范地址：https://npmcn.com/package/%40cngxjs/compodocx/

版本：0\.16\.1
npm 元数据更新时间：2026-11-06T13:28:19.875Z
中文译文更新时间：2026-11-10T04:37:31.045Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cngxjs/compodocx
原文对照：https://npmcn.com/package/%40cngxjs/compodocx/?lang=original
项目主页：https://compodocx.dev/
源码仓库：https://github.com/cngxjs/compodocx

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：12.9 MB，52 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=22
- 运行依赖：19 个
- 首次发布：2026-05-05T04:48:25.655Z
- 最新版本发布：2026-11-06T13:28:19.521Z
- 近 30 天下载量：2207（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：37（近 12 个月 37 个）

## 中文简介

现代Angular项目的静态文档生成器——信号,注入(),独立组件,它们标签,基于JS的模板覆盖,Pagefind搜索.

## 安装

```sh
npm install @cngxjs/compodocx
```

也可以使用：`pnpm add @cngxjs/compodocx`、`yarn add @cngxjs/compodocx`、`bun add @cngxjs/compodocx`

## README

![compodocx](https://npmcn.com/package/%40cngxjs/compodocx/docs/assets/compodocx-mark.svg)

# 运算符

用于现代Angular项目的静态文档生成器. 读取您的 TypeScript 源、组件模板和 (S) CSS, 并发布自成一体的 HTML 站点.

[![CI](https://github.com/cngxjs/compodocx/workflows/CI/badge.svg)](https://github.com/cngxjs/compodocx/actions) [![npm](https://img.shields.io/npm/v/@cngxjs/compodocx.svg)](https://www.npmjs.com/package/@cngxjs/compodocx) [![License: MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)

**联合国** [compodocx.dev (英语)](https://compodocx.dev/)

## 为何连锁店

继承人 [模拟](https://github.com/compodoc/compodoc) 用于现代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`](https://npmcn.com/package/%40cngxjs/compodocx/MIGRATION.md) 解释每一个.

## 所需资源

-   22号节点或更新
-   角项目 `tsconfig.json` (Angular 21+,独立代码;对21和22进行测试)

## 安装

```bash
npm install --save-dev @cngxjs/compodocx
```

在一个角工作空间内,图示种子 `tsconfig.doc.json`,登记 npm 脚本,和(如果你来自 `@compodoc/compodoc`)替换软件包并重写 `compodoc` 单行本 :

```bash
ng add @cngxjs/compodocx
```

## 快开始

```bash
# 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` 仍然找到名称 :

```json
{
    "tsconfig": "./tsconfig.app.json",
    "output": "./docs",
    "theme": "ocean"
}
```

每个 CLI 旗帜和配置密钥的完整引用 : [`docs/configuration.md`](https://npmcn.com/package/%40cngxjs/compodocx/docs/configuration.md) 或者说 [compodocx.dev/指针/选项](https://compodocx.dev/guides/options/)。 。 。 .

## 文档

| 专题 | 文件 |
| --- | --- |
| 配置参考 | [`docs/configuration.md`](https://npmcn.com/package/%40cngxjs/compodocx/docs/configuration.md) |
| 自定义 JS 模板覆盖 | [`docs/custom-templates.md`](https://npmcn.com/package/%40cngxjs/compodocx/docs/custom-templates.md) |
| SCSS / CSS 中的主题符号 | [`docs/theming-tokens-authoring-guide.md`](https://npmcn.com/package/%40cngxjs/compodocx/docs/theming-tokens-authoring-guide.md) |
| 额外的下行页面 | [`docs/additional-pages.md`](https://npmcn.com/package/%40cngxjs/compodocx/docs/additional-pages.md) |
| 多版本输出 | [`docs/versioned-docs.md`](https://npmcn.com/package/%40cngxjs/compodocx/docs/versioned-docs.md) |
| JSON 输出计划历史 | [`docs/json-export.md`](https://npmcn.com/package/%40cngxjs/compodocx/docs/json-export.md) |
| 国际化 | [`docs/i18n.md`](https://npmcn.com/package/%40cngxjs/compodocx/docs/i18n.md) |
| 从compodoc 移动 | [`MIGRATION.md`](https://npmcn.com/package/%40cngxjs/compodocx/MIGRATION.md) |
| 释放 | [`docs/RELEASING.md`](https://npmcn.com/package/%40cngxjs/compodocx/docs/RELEASING.md) |

## 发展

```bash
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站点:

```bash
npm run dev          # port 8081
```

欢迎提出的问题和要求 [github.com/cngxjs/compodocx 页面存档备份,存于互联网档案馆](https://github.com/cngxjs/compodocx)。 。 。 .

## 承认

compodocx 是一个叉 [模拟](https://github.com/compodoc/compodoc) 由文森特·奥格洛布林斯基和撰稿人出品. 它的编译器和JSDoc标签处理是这里所有基础的基础.

## 许可证

麻省理工学院. 见 [`LICENSE`](https://npmcn.com/package/%40cngxjs/compodocx/LICENSE)。 。 。 .

## 常见问题

### @cngxjs/compodocx 是什么？

现代Angular项目的静态文档生成器——信号,注入\(\),独立组件,它们标签,基于JS的模板覆盖,Pagefind搜索\.

### 如何安装 @cngxjs/compodocx？

在项目目录运行 npm install @cngxjs/compodocx，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 compodoc、compodocx，可以用 npx compodoc 直接运行。

### @cngxjs/compodocx 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/cngxjs\_\_compodocx 是否存在。

### @cngxjs/compodocx 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @cngxjs/compodocx 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cngxjs/compodocx 可以商用吗？

@cngxjs/compodocx 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cngxjs/compodocx 的下载量有多少？

根据 npm 官方下载统计，@cngxjs/compodocx 在 2026/10/10 – 2026/11/08 这 30 天内被下载 2,207 次，日均约 74 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cngxjs/compodocx 还在维护吗？

最新版本 0\.16\.1 发布于 2026/11/06（3 天前）；至今共发布 37 个版本，其中过去 12 个月发布了 37 个；首次发布于 2026/05/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。