# @convex-dev/docusaurus-plugin-typedoc 中文文档 规范地址：https://npmcn.com/package/%40convex-dev/docusaurus-plugin-typedoc/ 版本：0\.19\.2 npm 元数据更新时间：2026-10-07T00:51:44.718Z 中文译文更新时间：2026-11-10T18:00:51.431Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40convex-dev/docusaurus-plugin-typedoc 原文对照：https://npmcn.com/package/%40convex-dev/docusaurus-plugin-typedoc/?lang=original 项目主页：https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc 源码仓库：https://github.com/tgreyuk/typedoc-plugin-markdown ## 关键信息（来自 npm 元数据） - 包体积（解压后）：41.1 kB，18 个文件 - 模块格式：CommonJS - TypeScript 类型：未声明 - 运行依赖：0 个 - peer 依赖：typedoc \>=0\.24\.0 - 首次发布：2023-03-02T17:57:21.675Z - 最新版本发布：2023-05-03T00:11:39.691Z - 近 30 天下载量：10415（2026-10-11 至 2026-11-09，npm 官方下载统计） - 已发布版本数：5（近 12 个月 0 个） ## 中文简介 一个 Docusaurus v2 插件,用于用 TypeDoc 构建 API 文档. ## 安装 ```sh npm install @convex-dev/docusaurus-plugin-typedoc ``` 也可以使用：`pnpm add @convex-dev/docusaurus-plugin-typedoc`、`yarn add @convex-dev/docusaurus-plugin-typedoc`、`bun add @convex-dev/docusaurus-plugin-typedoc` ## README # docusaurus-plugin 类型道克 A 类 [Docusaurus v2 (英语)](https://v2.docusaurus.io/) 用于构建文档的插件 [类型文件](https://github.com/TypeStrong/typedoc)。 。 。 . [![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc.svg)](https://www.npmjs.com/package/docusaurus-plugin-typedoc) ![CI](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=master) ## 这有什么用? 在Markdown中生成静态的TypeDoc页面,其前题是Docusaurus构建的一部分. ## 安装 > 安装 [多龙](https://v2.docusaurus.io/docs/installation) 在您的工程根中,并在 Docuraurus 网站目录的同一位置安装插件依赖性. ```shell npm install typedoc typedoc-plugin-markdown docusaurus-plugin-typedoc --save-dev ``` ## 使用量 ### 配置 将插件添加到 `docusaurus.config.js` 并指定所需选项(见 [选项](https://npmcn.com/package/%40convex-dev/docusaurus-plugin-typedoc/#readme-options)) (中文(简体) ). ```js module.exports = { plugins: [ [ 'docusaurus-plugin-typedoc', // Plugin / TypeDoc options { entryPoints: ['../src/index.ts'], tsconfig: '../tsconfig.json', }, ], ], }; ``` TypeDoc 将用 Docusaurus 绑起靴子 `start` 财务报告和审定财务报表 `build` [cli 命令](https://v2.docusaurus.io/docs/cli)数字 : ```javascript "start": "docusaurus start", "build": "docusaurus build", ``` 一旦建成,文件将在 `/docs/api` (或等同出目录). ### 目录结构 ``` ├── docusauruss-website ├── build/ (static site dir) ├── docs/ │ ├── api/ (compiled typedoc markdown) ├── docusaurus.config.js ├── package.json ├── sidebars.js ├──package.json ├──src (typescript source files) ├──tsconfig.json ``` ## 选项 ### 类型文件选项 要配置类型文件,请通过任何相关的文件 [类型文件选项](https://typedoc.org/guides/options/) 给配置. 起码 `entryPoints` 财务报告和审定财务报表 `tsconfig` 需要设置选项. ```js entryPoints: ['../src/index.ts'], tsconfig: '../tsconfig.json' ``` 需要明确设置额外的类型文件插件 : ```js plugin: ['typedoc-plugin-xyz']; ``` #### 其他配置选项 类型Doc 选项也可以声明: - 使用a `typedoc.json` 文档. - 在 `typedocOptions` 键入 `tsconfig.json`。 。 。 . > 注:以这种方式宣布的选项将具有优先权并覆盖在 `docusaurus.config.js`。 。 。 . ### 插件选项 插件特有的选项也应该在同一对象中声明. | 名称 | 默认 | 说明 | | :-- | :-- | :-- | | `out` | `"api"` | 相对于文件目录的输出目录( 使用) `.` 没有子目录 . | | `includeExtension` | `true` | 确定是否保留 `.md` 在相对链接中扩展. `true` 建议按 [Docusaurus 文档](https://docusaurus.io/docs/docs-markdown-features#referencing-other-documents) | | `frontmatter` | `null` | 其他前题选项对象 。 见 [前题](https://npmcn.com/package/%40convex-dev/docusaurus-plugin-typedoc/#readme-frontmatter)。 。 。 . | | `sidebar.categoryLabel` | `API` | 侧边栏父类别标签 . | | `sidebar.collapsed` | `true` | 父类是否初始崩溃 | | `sidebar.fullNames` | `false` | 以模块路径显示全名 . | | `sidebar.position` | `auto` | 树上侧边栏的位置. | ### 示例配置 ```js module.exports = { plugins: [ [ 'docusaurus-plugin-typedoc', { // TypeDoc options entryPoints: ['../src/index.ts'], tsconfig: '../tsconfig.json', plugin: ['typedoc-plugin-xyz'], // Plugin options out: 'api-xyz', sidebar: { categoryLabel: 'API XYZ', collapsed: false, position: 0, fullNames: true, }, }, ], ], }; ``` ## 食谱 ### 侧边栏和导航栏 #### 边栏 `sidebars.js` 可用下列方式配置: 1. 从文档文件夹的文件结构( 默认行为) 生成整个侧边栏 : ```js module.exports = { sidebar: [ { type: 'autogenerated', dirName: '.', // '.' means the docs folder }, ], }; ``` 2. 或者,如果您想要手动控制侧边栏的其他部分,您可以使用切片来切换类型Doc侧边栏. > 注释 : `sidebar.categoryLabel`, (中文(简体) ), `sidebar.collapsed`,以及 `sidebar.position` 选项在此执行中被忽略) ```js module.exports = { sidebar: { 'Category 1': ['doc1', 'doc2', 'doc3'], API: [ { type: 'autogenerated', dirName: 'api', // 'api' is the 'out' directory }, ], }, }; ``` 请看 [https://docusaurus.io/docs/ sidebar (中文(简体) )](https://docusaurus.io/docs/sidebar) 用于侧边栏文档. #### 导航 可以在 `themeConfig` 选项 `docusaurus.config.js`数字 : ```js themeConfig: { navbar: { items: [ { to: 'docs/api/', // 'api' is the 'out' directory activeBasePath: 'docs', label: 'API', position: 'left', }, ], }, }, ``` 请看 [https://docusaurus.io/docs/api/ 主题/configulation#navbar-items](https://docusaurus.io/docs/api/themes/configuration#navbar-items) 用于导航文档. ### 前题 默认情况下, 插件将配置所需的最小值 [前题](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter) 配置 . 此外,在使用全球前题选项时,还可以通过所需的全球前题选项 `frontmatter` 选项对象 `docusaurus.config.js`数字 : ```js plugins: [ [ 'docusaurus-plugin-typedoc', { // .... other plugin option frontmatter: { pagination_prev: null, pagination_next: null } ] ] ``` ### 多实例 可以通过在多个配置中以独特的 ID 来构建多类型Doc 实例 : `docusaurus.config.js` ```js module.exports = { plugins: [ [ 'docusaurus-plugin-typedoc', { id: 'api-1', entryPoints: ['../api-1/src/index.ts'], tsconfig: '../api-1/tsconfig.json', out: 'api-1', }, ], [ 'docusaurus-plugin-typedoc', { id: 'api-2', entryPoints: ['../api-2/src/index.ts'], tsconfig: '../api-2/tsconfig.json', out: 'api-2', }, ], ], }; ``` ### 监视模式 通过在 `watch: true` 选项参见 [https://typedoc.org/guides/options/#watch (英语)](https://typedoc.org/guides/options/#watch)。 。 。 . 只能使用节点环境变量在开发模式中瞄准选项: `package.json` ```json "start": "TYPEDOC_WATCH=true docusaurus start", "build": "TYPEDOC_WATCH=false docusaurus build", ``` `docusaurus.config.js` ```js module.exports = { plugins: [ [ 'docusaurus-plugin-typedoc', { entryPoints: ['../src/index.ts'], tsconfig: '../tsconfig.json', watch: process.env.TYPEDOC_WATCH, }, ], ], }; ``` ### Monorepo 设置 `docusaurus.config.js` ```js module.exports = { plugins: [ [ 'docusaurus-plugin-typedoc', { entryPoints: ['../packages/package-a', '../packages/package-b'], entryPointStrategy: 'packages', sidebar: { fullNames: true, }, }, ], ], }; ``` ## 许可证 [麻省理工学院](https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/docusaurus-plugin-typedoc/LICENSE) ## 常见问题 ### @convex-dev/docusaurus-plugin-typedoc 是什么？ 一个 Docusaurus v2 插件,用于用 TypeDoc 构建 API 文档\. ### 如何安装 @convex-dev/docusaurus-plugin-typedoc？ 在项目目录运行 npm install @convex-dev/docusaurus-plugin-typedoc，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typedoc（\>=0\.24\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。 ### @convex-dev/docusaurus-plugin-typedoc 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/convex-dev\_\_docusaurus-plugin-typedoc 是否存在。 ### @convex-dev/docusaurus-plugin-typedoc 支持 ESM 还是 CommonJS？ 以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。 ### @convex-dev/docusaurus-plugin-typedoc 可以商用吗？ @convex-dev/docusaurus-plugin-typedoc 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @convex-dev/docusaurus-plugin-typedoc 的下载量有多少？ 根据 npm 官方下载统计，@convex-dev/docusaurus-plugin-typedoc 在 2026/10/11 – 2026/11/09 这 30 天内被下载 10,415 次，日均约 347 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @convex-dev/docusaurus-plugin-typedoc 还在维护吗？ 最新版本 0\.19\.2 发布于 2023/05/03（3 年前）；至今共发布 5 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/03/03。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。