# @enio\.ai/typedoc 中文文档

规范地址：https://npmcn.com/package/%40enio.ai/typedoc/

版本：1\.0\.8
npm 元数据更新时间：2023-03-05T20:17:20.874Z
中文译文更新时间：2026-11-13T17:33:31.376Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40enio.ai/typedoc
原文对照：https://npmcn.com/package/%40enio.ai/typedoc/?lang=original
项目主页：https://github.com/enio-ireland/enio/tree/develop#readme
源码仓库：https://github.com/enio-ireland/enio#develop

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

- 包体积（解压后）：47.9 kB，74 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：typedoc ^0\.23\.26，typedoc-plugin-rename-defaults ^0\.6\.4，typedoc-theme-hierarchy ^3\.0\.0
- 首次发布：2022-11-14T04:47:25.434Z
- 最新版本发布：2023-03-05T20:17:20.752Z
- 近 30 天下载量：4631（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 0 个）

## 中文简介

使用类型doc 设置文件自动化的 Nx 项目的生成器

## 安装

```sh
npm install @enio.ai/typedoc
```

也可以使用：`pnpm add @enio.ai/typedoc`、`yarn add @enio.ai/typedoc`、`bun add @enio.ai/typedoc`

## README

  

![](https://github.com/enio-ireland/enio/blob/develop/images/typedoc-nx-plugin.png?raw=true)

![npm](https://img.shields.io/npm/v/@enio.ai/typedoc?style=flat-square) ![NPM](https://img.shields.io/npm/l/@enio.ai/typedoc?style=flat-square) ![npm](https://img.shields.io/npm/dm/@enio.ai/typedoc?style=flat-square) ![GitHub contributors (via allcontributors.org)](https://img.shields.io/github/all-contributors/enio-ireland/enio/develop?color=%23&style=flat-square) ![GitHub Sponsors](https://img.shields.io/github/sponsors/enio-ireland?style=flat-square)

[类型doc](https://github.com/enio-ireland/enio/tree/develop/packages/typedoc) 是一个包装插件,用于 [Nx 工作空间](https://nx.dev/) 快速设置您的项目的文档自动化 [类型doc](https://www.npmjs.com/package/typedoc)它由一群热情的个人根据麻省理工学院的许可创建、维护和作为开源发布 [埃尼奥](https://github.com/enio-ireland/enio)。 。 。 .

  
  

## 安装,运行它!

> 如果你不熟悉打字机, 说打字机是方便的是一个低调的。 如果您正在正确使用 TypeScript, 指定类型和界面, 并评论您的代码所做的事情 - 您可以在一个静态站点生成文档 .
> 
> Kudos 给作者和维护者 [优秀的图书馆](https://typedoc.org/)。我们创建了这个 Nx 包装器插件,以解决我们的问题 - 维护几个开源项目并不容易,当然,任何使代码基础可以维护的自动化都是最受欢迎的.

检查此快速演示如何通过此插件设置类型文件并使用 :

![](https://github.com/enio-ireland/enio/blob/develop/images/typedoc-demo.gif?raw=true)

  

## 开始

1.  将插件添加到您的 Nx 工作空间 :

```shell
npm install --save-dev @enio.ai/typedoc
```

2.  在您工作空间的根目录中运行以下命令, 其中 `<project>` 是您想要设置的 nx 工作空间中的工程名称 。 若为 `nx` 不是设置全局, 您可能想要先将其添加为 npm 脚本( 详见下面) 或前缀 `npx` 使用时 [无](https://npmjs.com/)。您也可以从 [Nx 控制台](https://marketplace.visualstudio.com/items?itemName=nrwl.angular-console) 扩展名 [虚拟系统](https://code.visualstudio.com/)。 。 。 .

```shell
  nx g @enio.ai/typedoc:config <project>
```

  

## 生成文档

运行以下命令, 在哪里 `<project>` 是 nx 工作空间中您工程的名称.

```shell
  npx nx run <project>:typedoc
```

可选的, 您可以在 : `package.json` 为方便起见,将文件放在您 nx 工作空间的根文件夹中.

```json
{
  "scripts": {
    "create.docs": "nx typedoc",
    "setup.docs": "nx g @enio.ai/typedoc:config"
  }
}
```

然后你可以运行命令:

```shell
  // Generating documentation
  npm run create.docs <project>

  // Setting up typedoc in your project
  npm run setup.docs <project>
```

默认情况下,文档生成于: `./docs` 相对工作空间的根目录.

  

## 配置文档

此插件包括用于最佳体验的合理默认配置 . 如果您希望在您的 Nx 项目中进一步自定义类型文档行为, 您可以 ;

1.  更新 `typedoc.json` 文件在您的工程目录中.
2.  更新类型文件条目选项 `nx.json` 在运行您的 Nx 项目生成文档命令时应用一致的行为.

  

## [贡献者](https://github.com/enio-ireland/enio/blob/develop/CONTRIBUTORS.md)

  

## 发起人

所有捐助者和赞助者都能够维持这一项目。 如果您愿意赞助这个项目, 请将您的相片或公司标志显示在下面 [点击这里](https://github.com/sponsors/enio-ireland)。 。 。

(此列表会在未来自动生成. )

## 常见问题

### @enio\.ai/typedoc 是什么？

使用类型doc 设置文件自动化的 Nx 项目的生成器

### 如何安装 @enio\.ai/typedoc？

在项目目录运行 npm install @enio\.ai/typedoc，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typedoc（^0\.23\.26）、typedoc-plugin-rename-defaults（^0\.6\.4）、typedoc-theme-hierarchy（^3\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @enio\.ai/typedoc 支持 TypeScript 吗？

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

### @enio\.ai/typedoc 支持 ESM 还是 CommonJS？

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

### @enio\.ai/typedoc 可以商用吗？

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

### @enio\.ai/typedoc 的下载量有多少？

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

### @enio\.ai/typedoc 还在维护吗？

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