# @ankhorage/rules-documentation 中文文档

规范地址：https://npmcn.com/package/%40ankhorage/rules-documentation/

版本：0\.4\.0
npm 元数据更新时间：2026-10-09T10:20:35.743Z
中文译文更新时间：2026-11-06T05:09:02.299Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：94.8 kB，52 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-10-02T18:38:11.179Z
- 最新版本发布：2026-10-09T10:20:35.327Z
- 近 30 天下载量：84277（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

Ankhorage源的文档规则提供者并生成文档.

## 安装

```sh
npm install @ankhorage/rules-documentation
```

也可以使用：`pnpm add @ankhorage/rules-documentation`、`yarn add @ankhorage/rules-documentation`、`bun add @ankhorage/rules-documentation`

## README

# @ankhorage/ rules- 文件

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

Ankhorage源的文档规则提供者并生成文档.

## 配置

### 示例

```ts
import { defineParadoxConfig } from '@ankhorage/paradox';

export default defineParadoxConfig({
  mode: 'write',
  docs: {
    title: '@ankhorage/rules-documentation',
    description: 'Documentation rule provider for Ankhorage source and generated documentation.',
  },
  package: {
    root: '.',
    entrypoints: ['src/index.ts'],
  },
  output: { dir: './paradox' },
});
```

## 生成的文件

-   [交互式文件应用](https://npmcn.com/package/%40ankhorage/rules-documentation/paradox/index.html)
-   [公共 API 参考](https://npmcn.com/package/%40ankhorage/rules-documentation/paradox/exports.md)
-   [构成部分登记册](https://npmcn.com/package/%40ankhorage/rules-documentation/paradox/components.md)
-   [结构概览](https://npmcn.com/package/%40ankhorage/rules-documentation/paradox/diagrams/architecture-overview.mmd)
-   [模块关系](https://npmcn.com/package/%40ankhorage/rules-documentation/paradox/diagrams/module-relationships.mmd)
-   [导出图](https://npmcn.com/package/%40ankhorage/rules-documentation/paradox/diagrams/export-graph.mmd)

## 常见问题

### @ankhorage/rules-documentation 是什么？

Ankhorage源的文档规则提供者并生成文档\.

### 如何安装 @ankhorage/rules-documentation？

在项目目录运行 npm install @ankhorage/rules-documentation，或使用 pnpm add / yarn add / bun add。

### @ankhorage/rules-documentation 支持 TypeScript 吗？

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

### @ankhorage/rules-documentation 支持 ESM 还是 CommonJS？

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

### @ankhorage/rules-documentation 可以商用吗？

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

### @ankhorage/rules-documentation 的下载量有多少？

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

### @ankhorage/rules-documentation 还在维护吗？

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