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

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

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

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

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

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

- 包体积（解压后）：1.2 MB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：13 个
- peer 依赖：preact ^10\.22\.0
- 首次发布：2026-06-10T15:31:38.593Z
- 最新版本发布：2026-10-24T11:23:11.094Z
- 近 30 天下载量：21723（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 18 个）

## 中文简介

JSDoc doc 处理和 MDX 生成

## 安装

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

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

## README

# @ clean-jsdoc-主题/ setu

JSDoc – SiteManifest (英语). 验证一个咸的多克乐收藏,走走 可记录类型,并释放结构 `SiteManifest` 矮人会消耗. 0渲染知识——没有HTML,没有JSX,没有文件一/O.

完整的模块图、分层规则和更广泛的管道见 转帐 [`docs/ARCHITECTURE.md`](https://npmcn.com/package/docs/ARCHITECTURE.md)。 。 。 .

## 公共 API

```ts
import { generateSite } from '@clean-jsdoc-theme/setu';
import type { SiteManifest } from '@clean-jsdoc-theme/utils';

const manifest: SiteManifest = generateSite(saltyCollection, {
  pkg: { name: 'my-lib', version: '1.0.0' },
  readme: readmeHtml, // optional: rendered to the home page
  tutorials: tutorialTree, // optional: rendered as guide pages
  sources: sourceFiles, // optional: rendered as source-viewer pages
});
```

`generateSite(collection, opts?)` 列出每个记录的容器符号, 生成一个 `Page` 每个符号(前题、MDX正文、斜体 URL, 按类型组合导航,并返回完整 `SiteManifest` 准备向 `dwar.render`。 。 。 .

### 遗产入境点

```ts
import { generateMdx } from '@clean-jsdoc-theme/setu';

const bodies: string[] = generateMdx(collection);
```

一个薄的相容性包装器,它从它的数组物理字符串中产生 `generateSite`. 偏爱 `generateSite` 新代码.

### 低级助手

用于要检查或生成的工具的作曲部件导出 单个页面 :

-   `buildContainerPage(collection, longname, kind, sourceLink?, resolveLink?)` - 一个集装箱符号-一个 `Page`。 。 。 .
-   `buildGlobalsPage(collection, …)` ——汇总全局页面(或 `null`) (中文(简体) ).
-   `enumerateLongnamesByKind(collection, kind)` 一种独特的有文献记载的长名.
-   `extractHeadings(tree)` - 目标 `Root` → `Heading[]` 上面写着"身份证明".
-   `buildNav(pages)`, (中文(简体) ), `computeBuildId(pages)`, (中文(简体) ), `splitLongnameForSlug(longname)`。 。 。 .
-   `buildReadmePage`, (中文(简体) ), `buildTutorialPages`, (中文(简体) ), `buildSourceModel` ——出道人/出道人表面.

种类参数管道(`getContainerView`, (中文(简体) ), `containerViewToMdast`,则 mdast 构造器)是从同一个表面导出. 阶级时代的名称 (单位:千美元)`buildClassPage`, (中文(简体) ), `enumerateClassLongnames`, (中文(简体) ), `getClassView`, (中文(简体) ), `classViewToMdast`(中文(简体) ) 作为细的别名.

## 覆盖范围

setu使这5个集装箱类型—— **类、接口、混音、模块、, 命名空间** 通过一种参数路径(类保持其构造器) params special special; 阶级/界面行走继承链. 除此之外:

-   **类型def** 页面.
-   合计 **全球** 用于不拥有页面的全球范围符号的页面.
-   **事件/ 提示/ 常数** 在其母页内作为成员章节.
-   项目 **读取** 成为主页; **教程** 成为指导页; 文档 **源文件** 成为只读取的浏览器页面.
-   A 类 **文件目录** (单位:千美元)`opts.docs`Markdown/HTML——文件系统布局(加) 可选的 YAML 前题)驱动弹出和侧边栏组.
-   **点名、步骤、标签和嵌入** 低于资本化的 MDX JSX 节点 (单位:千美元)`<Callout>` 编号 : `<Steps>` 编号 : `<Tabs>` 编号 : `<Embed>`转来转去 组件; `@iframe` 标签和 ` ```iframe ` 栅栏共享一个配置语法.
-   **i18n 槽数** ——每个可变字符串(描述,摘要,示例) 标题、参数/返回描述) `SlotEntry` 阿迪什给 翻译 `stampSite` 重新交代一个有译名的地方.

### 链接分辨率

`{@link}` 编号 : `{@linkcode}` 编号 : `{@linkplain}` 财务报告和审定财务报表 `@see` 重写为真实 锚. 每个生成的页面(及其成员)先用双通式编成登记册 然后将每个有解析器的页面关闭,这样 ưμ㼯A 一个名道姓的人决定 符号的 sattle (+ a) `#member` 标题主机);外部 URLs 直接链接; 未解决的命名路径返回到内置代码 .

## 管道安装

```
salty collection ──► setu.generateSite ──► SiteManifest ──► dwar.render ──► HTML/CSS/JS
                          ▲                                        ▲
                          │                                        │
                    schema + slug rules                     components from
                @clean-jsdoc-theme/utils                @clean-jsdoc-theme/rang
```

堵塞规则( :`slugifyHeading` 编号 : `slugifyPath`住在这里 `@clean-jsdoc-theme/utils` 并被 setu(侧边栏/ TOC 生成) 和 dwar( 已放弃标题) 使用 锚. 相同的规则 – 匹配两侧的锚.

## 贡献者

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

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

## 许可证

麻省理工学院.

## 常见问题

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

JSDoc doc 处理和 MDX 生成

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

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

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

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

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

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

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

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

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

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

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

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