# @apify/docusaurus-plugin-typedoc-api 中文文档

规范地址：https://npmcn.com/package/%40apify/docusaurus-plugin-typedoc-api/

版本：5\.1\.16
npm 元数据更新时间：2026-06-22T14:12:15.726Z
中文译文更新时间：2026-11-06T13:29:16.543Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：646 kB，340 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=16\.12\.0
- 运行依赖：7 个
- peer 依赖：@docusaurus/core ^3\.8\.1，@docusaurus/mdx-loader ^3\.8\.1，@docusaurus/plugin-content-docs ^3\.8\.1，@docusaurus/preset-classic ^3\.8\.1，@docusaurus/theme-common ^3\.8\.1，@docusaurus/types ^3\.8\.1，@docusaurus/utils ^3\.8\.1，@types/react ^18\.3\.11 \|\| \>=19\.0\.0，react \>=18\.0\.0 \|\| \>=19\.0\.0，react-dom ^18\.2\.0 \|\| \>=19\.0\.0，typescript ^5\.0\.0
- 首次发布：2023-08-01T09:29:48.296Z
- 最新版本发布：2026-06-22T14:12:15.211Z
- 近 30 天下载量：3127（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：62（近 12 个月 19 个）

## 中文简介

Docusaurus插件提供由TypeDoc提供动力的源代码API文档.

## 安装

```sh
npm install @apify/docusaurus-plugin-typedoc-api
```

也可以使用：`pnpm add @apify/docusaurus-plugin-typedoc-api`、`yarn add @apify/docusaurus-plugin-typedoc-api`、`bun add @apify/docusaurus-plugin-typedoc-api`

## README

# 说明叉子 `docusaurus-plugin-typedoc-api`

这是叉子 [docusaurus-plugin 类型多克- api](https://github.com/milesj/docusaurus-plugin-typedoc-api) 调整后 用于将库文档渲染到 [证明文件](https://docs.apify.com/)。 。 。 .

## 出版

目前还没有CI,所以您必须手动发布软件包的更新版本.

1.  凸起版本进入 `packages/plugin/package.json`
2.  `yarn build` 输入根
3.  `cd packages/plugin && npm publish`

# 原始读取器

> ## 这一项目不再积极维持! TypeScript 和 TypeDoc 继续释放断开的更改,使此工程处于可行状态非常困难. 这不值得我花时间,所以如果你需要这个项目, 我建议放弃它.

![Build](https://github.com/milesj/docusaurus-plugin-typedoc-api/actions/workflows/build.yml/badge.svg?branch=master) [![npm version](https://badge.fury.io/js/docusaurus-plugin-typedoc-api.svg)](https://www.npmjs.com/package/docusaurus-plugin-typedoc-api)

用于生成源代码的 Docusaurus 插件 `/api/*` 路线,由 [类型文件](https://typedoc.org/)。 。 。 .

## 文档

查看 [正式读取器](https://npmcn.com/package/%40apify/docusaurus-plugin-typedoc-api/packages/plugin/README.md) 关于安装的更多信息 用途.

## 捐款

由于这个寄存器没有公开的API,其源代码组织方式也没有达到 使用类型Doc,我们依赖由 [脚](https://github.com/milesj/boost)改为: 贡献,你需要克隆 Boost项目 相对于这个项目 作为一个兄弟.

```bash
# Setup plugin
git clone git@github.com:milesj/docusaurus-plugin-typedoc-api.git
cd docusaurus-plugin-typedoc-api
yarn install
yarn run pack

# Setup Boost
cd ..
git clone git@github.com:milesj/boost.git
cd boost
yarn install
yarn run pack
```

在两个项目设置之后,您可以修改这个项目,然后验证 通过启动 Docusaurus 服务器更改 `yarn run docs`。 。 。 . _不过_,热重装不会 工作,所以你不得不一遍又一遍地运行这个命令... 没有花时间 改进这一点.

## 常见问题

### @apify/docusaurus-plugin-typedoc-api 是什么？

Docusaurus插件提供由TypeDoc提供动力的源代码API文档\.

### 如何安装 @apify/docusaurus-plugin-typedoc-api？

在项目目录运行 npm install @apify/docusaurus-plugin-typedoc-api，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@docusaurus/core（^3\.8\.1）、@docusaurus/mdx-loader（^3\.8\.1）、@docusaurus/plugin-content-docs（^3\.8\.1）、@docusaurus/preset-classic（^3\.8\.1）、@docusaurus/theme-common（^3\.8\.1）、@docusaurus/types（^3\.8\.1）、@docusaurus/utils（^3\.8\.1）、@types/react（^18\.3\.11 \|\| \>=19\.0\.0）、react（\>=18\.0\.0 \|\| \>=19\.0\.0）、react-dom（^18\.2\.0 \|\| \>=19\.0\.0）、typescript（^5\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @apify/docusaurus-plugin-typedoc-api 支持 TypeScript 吗？

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

### @apify/docusaurus-plugin-typedoc-api 支持 ESM 还是 CommonJS？

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

### @apify/docusaurus-plugin-typedoc-api 需要什么版本的 Node\.js？

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

### @apify/docusaurus-plugin-typedoc-api 可以商用吗？

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

### @apify/docusaurus-plugin-typedoc-api 的下载量有多少？

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

### @apify/docusaurus-plugin-typedoc-api 还在维护吗？

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