# @ankhorage/paradox 中文文档

规范地址：https://npmcn.com/package/%40ankhorage/paradox/

版本：0\.3\.6
npm 元数据更新时间：2026-10-29T14:49:07.354Z
中文译文更新时间：2026-11-06T05:08:57.342Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：232 kB，132 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：7 个
- 首次发布：2026-04-24T14:27:16.669Z
- 最新版本发布：2026-10-29T14:49:06.107Z
- 近 30 天下载量：89583（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：75（近 12 个月 75 个）

## 中文简介

TypeScript 包的决定性文档生成器.

## 安装

```sh
npm install @ankhorage/paradox
```

也可以使用：`pnpm add @ankhorage/paradox`、`yarn add @ankhorage/paradox`、`bun add @ankhorage/paradox`

## README

# @ankhorage/paradox (英语)

![license: MIT](https://npmcn.com/package/%40ankhorage/paradox/paradox/badges/license.svg) ![npm: v0.3.6](https://npmcn.com/package/%40ankhorage/paradox/paradox/badges/npm.svg) ![runtime: bun](https://npmcn.com/package/%40ankhorage/paradox/paradox/badges/runtime.svg) ![typescript: strict](https://npmcn.com/package/%40ankhorage/paradox/paradox/badges/typescript.svg) ![eslint: checked](https://npmcn.com/package/%40ankhorage/paradox/paradox/badges/eslint.svg) ![prettier: checked](https://npmcn.com/package/%40ankhorage/paradox/paradox/badges/prettier.svg) ![build: checked](https://npmcn.com/package/%40ankhorage/paradox/paradox/badges/build.svg) ![tests: checked](https://npmcn.com/package/%40ankhorage/paradox/paradox/badges/tests.svg) ![paradox: canonical](https://npmcn.com/package/%40ankhorage/paradox/paradox/badges/docs.svg)

TypeScript 包的决定性文档生成器.

## 使用量

### 国 际

Ankhorage 包通过命令行界面曝光 `ankh`启用 `ankh --help` 来发现可用的软件包命令,或用 `--help` 用于特定软件包.

```zsh
# Install the Ankhorage CLI
bun add --global @ankhorage/ankh

# Show usage information for paradox
ankh paradox --help
```

### 基本用途

Paradox从犬类包结构生成文档. 使用文件寿命 仅在下文 `examples/**` 或者说 `src/cli/**`。存储库可能包含多个 `@usage` 实例,但以下确切的一个例子 `examples/**` 升级到 README 中 `@readme`。 。 。 .

README促进的用法提供了明确的 `@title` 与无空道相. 代码总是来自 真实源声明,而不是在 Paradox 注释中重复代码块.

```ts
export const basicConfig = defineParadoxConfig({
  mode: 'safe',
});
```

## 配置

为软件包配置 Paradox 文档生成 .

配置选项

| 外地 | 类型 | 需求 | 默认 | 说明 |
| --- | --- | --- | --- | --- |
| 模式 | `'safe' | 'write' | undefined` | 没有 | —— 说 |  |
| 协作者 | `true | undefined` | 没有 | —— 说 |  |
| 捐赠 | `{ account: string; } | undefined` | 没有 | —— 说 |  |
| 文档 | `{ title?: string; description?: string; } | undefined` | 没有 | —— 说 |  |
| 软件包 | `{ root?: string; entrypoints?: string[]; } | undefined` | 没有 | —— 说 |  |
| 产出 | `{ dir?: string; } | undefined` | 没有 | —— 说 |  |

## 生成的文件

-   [交互式文件应用](https://npmcn.com/package/%40ankhorage/paradox/paradox/index.html)
-   [公共 API 参考](https://npmcn.com/package/%40ankhorage/paradox/paradox/exports.md)
-   [构成部分登记册](https://npmcn.com/package/%40ankhorage/paradox/paradox/components.md)
-   [结构概览](https://npmcn.com/package/%40ankhorage/paradox/paradox/diagrams/architecture-overview.mmd)
-   [模块关系](https://npmcn.com/package/%40ankhorage/paradox/paradox/diagrams/module-relationships.mmd)
-   [导出图](https://npmcn.com/package/%40ankhorage/paradox/paradox/diagrams/export-graph.mmd)
-   [是 Paradox DocTag 序列Name](https://npmcn.com/package/%40ankhorage/paradox/paradox/diagrams/sequences/is-paradox-doc-tag-name.mmd)
-   [悖论序列](https://npmcn.com/package/%40ankhorage/paradox/paradox/diagrams/sequences/paradox.mmd)

## 公共 API

### 配置

定义 Paradox 连接

```ts
defineParadoxConfig(config: ParadoxConfig) => ParadoxConfig
```

定义一个 Paradox 配置对象而不改变其形状.

模块 : `src/config/defineParadoxConfig.ts` 资料来源: `src/config/defineParadoxConfig.ts:8:1` 相关符号 : `ParadoxConfig`

### 文档

帕拉多克-多克-塔斯

支持由 Cononical 文件规则提供者预测的 Paradox 文件标记 .

模块 : `src/doc-tags/registry.ts` 资料来源: `src/doc-tags/registry.ts:33:14`

### 类型

配置

为软件包配置 Paradox 文档生成 .

模块 : `src/types/config.ts` 资料来源: `src/types/config.ts:9:1`

## 合作者

## 捐款

如果这个项目对您有用,您可以支持它的持续发展.

[支持@ ankhorage](https://github.com/sponsors/ankhorage)

## 常见问题

### @ankhorage/paradox 是什么？

TypeScript 包的决定性文档生成器\.

### 如何安装 @ankhorage/paradox？

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

### @ankhorage/paradox 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @ankhorage/paradox 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @ankhorage/paradox 可以商用吗？

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

### @ankhorage/paradox 的下载量有多少？

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

### @ankhorage/paradox 还在维护吗？

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