# @clean-jsdoc-theme/typedoc 中文文档

规范地址：https://npmcn.com/package/%40clean-jsdoc-theme/typedoc/

版本：5\.2\.1
npm 元数据更新时间：2026-10-24T11:22:50.294Z
中文译文更新时间：2026-11-10T00:49:20.597Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40clean-jsdoc-theme/typedoc
原文对照：https://npmcn.com/package/%40clean-jsdoc-theme/typedoc/?lang=original
项目主页：https://ankdev.me/clean-jsdoc-theme/theme/typedoc-getting-started
源码仓库：https://github.com/ankitskvmdam/clean-jsdoc-theme

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

- 包体积（解压后）：246 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：10 个
- peer 依赖：typedoc ^0\.28\.0
- 首次发布：2026-06-10T15:31:38.313Z
- 最新版本发布：2026-10-24T11:22:49.940Z
- 近 30 天下载量：9014（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 18 个）

## 中文简介

TypeDoc 支持清洁-jsdoc-主题( 通过 setu = dwar )

## 安装

```sh
npm install @clean-jsdoc-theme/typedoc
```

也可以使用：`pnpm add @clean-jsdoc-theme/typedoc`、`yarn add @clean-jsdoc-theme/typedoc`、`bun add @clean-jsdoc-theme/typedoc`

## README

[![clean-jsdoc-theme](https://raw.githubusercontent.com/ankitskvmdam/clean-jsdoc-theme/master/packages/clean-jsdoc-theme/media/clean-jsdoc-theme-light.svg)](https://ankdev.me/clean-jsdoc-theme)

一个快速、现代、LLM的文档网站,供您使用 **类型脚本** 项目,由TypeDoc提供动力.

[![npm version](https://img.shields.io/npm/v/@clean-jsdoc-theme/typedoc)](https://www.npmjs.com/package/@clean-jsdoc-theme/typedoc) [![npm downloads](https://img.shields.io/npm/dm/@clean-jsdoc-theme/typedoc)](https://www.npmjs.com/package/@clean-jsdoc-theme/typedoc) [![license](https://img.shields.io/npm/l/@clean-jsdoc-theme/typedoc)](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/LICENSE) [![docs](https://img.shields.io/badge/docs-ankdev.me-005bff)](https://ankdev.me/clean-jsdoc-theme/theme/typedoc-getting-started) [![live demo](https://img.shields.io/badge/live%20demo-api--docs-7c3aed)](https://ankdev.me/clean-jsdoc-theme/api-docs) [![stars](https://img.shields.io/github/stars/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme) [![forks](https://img.shields.io/github/forks/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/fork) [![issues](https://img.shields.io/github/issues/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/issues) [![contributors](https://img.shields.io/github/contributors/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/graphs/contributors) [![sponsor](https://img.shields.io/badge/sponsor-%E2%9D%A4-db61a2?logo=githubsponsors&logoColor=white)](https://github.com/sponsors/ankitskvmdam) [![socket](https://socket.dev/api/badge/npm/package/@clean-jsdoc-theme/typedoc)](https://socket.dev/npm/package/@clean-jsdoc-theme/typedoc)

![clean-jsdoc-theme — light theme](https://raw.githubusercontent.com/ankitskvmdam/clean-jsdoc-theme/master/packages/clean-jsdoc-theme/media/screenshot.png) ![clean-jsdoc-theme — dark theme](https://raw.githubusercontent.com/ankitskvmdam/clean-jsdoc-theme/master/packages/clean-jsdoc-theme/media/screenshot-dark.png)

TypeDoc 插件, 将项目反射变成快速的现代静态 站点: 服务器提交 HTML, 懒惰水分互动岛屿, 模糊 + 全文 搜索、 轻而易举和黑暗的主题, 以及同伴 `.md` 的每页.

## 要点

-   **为类型脚本所建** ——您的 TypeDoc 反射成为结构化的 API 模型,然后是被打磨过的静态站点. 没有 CSS 或构建配置开始 .
-   **无框架快速( F)** ——服务器上带有懒惰水分的页面 岛屿;每页只装上它实际使用的JS.
-   **搜索构建于** 模糊的命令调色板(`Ctrl K`关于头衔, 描述、内容和每个成员的深层链接。 总是这样,没什么 配置 .
-   **一个站点中的指南 + API** 手写Markdown指南和 自动生成的引用共享一个侧边栏和一个搜索.
-   **正在本地化** - 那个 `clean-jsdoc` i18n 工具已经提取 typeDoc 工程的可变字符串; 完整的每地建置( 有 语言切换器,每个语言字体,以及 `hreflang`下一个降落.
-   **方便LLM** 每页都有一个干净的同伴 `.md`外加一个 复制页面按钮可以将任意一页交给克洛德 / ChatGPT / 困惑. A 类 可下载 [技能](https://ankdev.me/clean-jsdoc-theme/theme/llm-skill) 转弯 任何编码助理都变成设置专家.
-   **默认波兰文** ——轻/暗的OKLCH主题,Google字体,shiki语法 摩纳哥源浏览器,以及 `Source: file:line` 链接.

## 快开始

```sh
npm install --save-dev typedoc @clean-jsdoc-theme/typedoc
```

`typedoc` 是同伴的依赖性——你带来自己的。 装入插件并选择 其输出在 `typedoc.json`; 主题选项位于 `cleanJsdocTheme`数字 :

```jsonc
{
  "entryPoints": ["src/index.ts"],
  "plugin": ["@clean-jsdoc-theme/typedoc"],
  "outputs": [{ "name": "clean-jsdoc-theme", "path": "dist" }],
  "cleanJsdocTheme": {
    "siteName": "My Library",
    // Optional: a directory of hand-written Markdown/HTML guides rendered
    // alongside the API (folder layout → URL + sidebar group; per-file
    // frontmatter overrides; a root `index.md` becomes the home page).
    "docs": "docs"
  }
}
```

> 主页来自TypeDoc自己的顶级 `"readme"` 选项(或根) `docs/index.md`) (中文(简体) ). 两者 `readme` 和主题块坐落在顶层 `typedoc.json` —— 说 `readme` 是 TypeDoc 的, 主题选项在 `cleanJsdocTheme`。 。 。 .

构建,然后在 HTTP 之上服务(获取岛屿块和搜索索引) `file://` 块 :

```sh
npx typedoc
npx serve dist
```

## 文档

-   **设置完整引用( F)** —— 说 [**akdev.me/ clean-jsdoc-主题/主题/类型doc-得到-启动**](https://ankdev.me/clean-jsdoc-theme/theme/typedoc-getting-started): 安装,即 `cleanJsdocTheme` 选项和主题——所有配置在 `cleanJsdocTheme` 在你身边 `typedoc.json`。 。 。 .
-   **改用联署文件?** 安装 [`clean-jsdoc-theme`](https://www.npmjs.com/package/clean-jsdoc-theme) ——JSDoc模板,外观和功能设定相同.
-   **FAQ 食谱( C)** —— 说 [**akdev.me/ clean-jsdoc-主题/指南/faq**](https://ankdev.me/clean-jsdoc-theme/guides/faq):如何嵌入 CodePen / YouTube / 站点,写出丰富的Doc评论(callouts, steps),以及常见的配置tweaks.
-   **现场演示** —— 说 [**akdev.me/ clean-jsdoc-主题/api-docs**](https://ankdev.me/clean-jsdoc-theme/api-docs): 一个真实生成的 API 引用, 这样您可以在安装前看到输出 .

## 捐款额

反馈直接塑造此插件, 欢迎贡献者 :

-   🐛 **击出错误还是奇数输出?** [打开一个问题](https://github.com/ankitskvmdam/clean-jsdoc-theme/issues/new) 小小的复制——这是你所能做的最有用的一件事.
-   💡 **错过了什么还是有什么想法?** 专题请求和问题可在 [问题跟踪器](https://github.com/ankitskvmdam/clean-jsdoc-theme/issues)。 。 。 .
-   🛠️ **想挖进去吗? 公关是真正受欢迎的.** 适配器住在这里 [`packages/typedoc/`](https://github.com/ankitskvmdam/clean-jsdoc-theme/tree/master/packages/typedoc) (数量) `NOTES.md` 记录它所依赖的经过核实的TypeDoc API事实。 方便开始的区域:类型渲染,反射边缘外壳,以及局部构造. 见 [捐款额](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/CONTRIBUTING.md)。 。 。 .

任何贡献都不算太小——一个打字法、一个复写法,或者一个docs tweak all help. 对照类型文件验证 **0.28.x (中文(简体) )**。谢谢帮助制作 TypeScript 记录故事的精彩

## 贡献者

感谢所有帮助建立干净的jsdoc主题的人.

[![Contributors](https://contrib.rocks/image?repo=ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/graphs/contributors)

## 许可证

[麻省理工学院](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/LICENSE) © [安基特·库马尔](https://ankdev.me/)

## 常见问题

### @clean-jsdoc-theme/typedoc 是什么？

TypeDoc 支持清洁-jsdoc-主题\( 通过 setu = dwar \)

### 如何安装 @clean-jsdoc-theme/typedoc？

在项目目录运行 npm install @clean-jsdoc-theme/typedoc，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typedoc（^0\.28\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @clean-jsdoc-theme/typedoc 支持 TypeScript 吗？

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

### @clean-jsdoc-theme/typedoc 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @clean-jsdoc-theme/typedoc 可以商用吗？

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

### @clean-jsdoc-theme/typedoc 的下载量有多少？

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

### @clean-jsdoc-theme/typedoc 还在维护吗？

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