让开源，少一点语言距离。
npm包中文文档

@ankhorage/rules-documentation

中文文档
0.4.0发布于 2026/10/09MITTypeScriptES Module构建来源已验证近 30 天下载 8.4万

Documentation rule provider for Ankhorage source and generated documentation.

原始使用文档
中文原文
文档目录3 节
  1. Configuration
  2. Example
  3. Generated documentation

@ankhorage/rules-documentation

license: MIT npm: v0.4.0 runtime: bun typescript: strict eslint: checked prettier: checked build: checked tests: checked paradox: canonical

Documentation rule provider for Ankhorage source and generated documentation.

Configuration

Example

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' },
});

Generated documentation

版本与发布记录

@ankhorage/rules-documentation 共发布 3 个版本，首次发布于 2026/10/03；过去 12 个月发布了 3 个版本。最新版本附带 npm provenance 构建来源证明，可追溯到公开的 CI 构建记录。

版本发布日期距今
0.4.0latest2026/10/0927 天前
0.3.42026/10/031 个月前
0.3.32026/10/031 个月前

关于 @ankhorage/rules-documentation 的常见问题

@ankhorage/rules-documentation 是什么？

Documentation rule provider for Ankhorage source and generated documentation.

如何安装 @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 和提交记录判断。