说明叉子 docusaurus-plugin-typedoc-api
这是叉子
docusaurus-plugin 类型多克- api 调整后
用于将库文档渲染到 证明文件。 。 。 .
出版
目前还没有CI,所以您必须手动发布软件包的更新版本.
- 凸起版本进入
packages/plugin/package.json
yarn build 输入根cd packages/plugin && npm publish
原始读取器
这一项目不再积极维持! TypeScript 和 TypeDoc 继续释放断开的更改,使此工程处于可行状态非常困难. 这不值得我花时间,所以如果你需要这个项目, 我建议放弃它.
用于生成源代码的 Docusaurus 插件 /api/* 路线,由
类型文件。 。 。 .
文档
查看 正式读取器 关于安装的更多信息
用途.
捐款
由于这个寄存器没有公开的API,其源代码组织方式也没有达到
使用类型Doc,我们依赖由 脚改为:
贡献,你需要克隆 Boost项目 相对于这个项目 作为一个兄弟.
# Setup plugin
git clone [email protected]:milesj/docusaurus-plugin-typedoc-api.git
cd docusaurus-plugin-typedoc-api
yarn install
yarn run pack
# Setup Boost
cd ..
git clone [email protected]:milesj/boost.git
cd boost
yarn install
yarn run pack
在两个项目设置之后,您可以修改这个项目,然后验证
通过启动 Docusaurus 服务器更改 yarn run docs。 。 。 . 不过,热重装不会
工作,所以你不得不一遍又一遍地运行这个命令... 没有花时间
改进这一点.
关于 @apify/docusaurus-plugin-typedoc-api 的常见问题
@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 和提交记录判断。