# @api-viewer/docs 中文文档
规范地址：https://npmcn.com/package/%40api-viewer/docs/
版本：1\.0\.0-pre\.10
npm 元数据更新时间：2024-04-05T11:17:19.867Z
中文译文更新时间：2026-11-06T09:53:38.011Z
软件包许可：MIT
本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。
原始 npm 页面：https://www.npmjs.com/package/%40api-viewer/docs
原文对照：https://npmcn.com/package/%40api-viewer/docs/?lang=original
项目主页：https://github.com/open-wc/api-viewer-element#readme
源码仓库：https://github.com/open-wc/api-viewer-element
## 关键信息（来自 npm 元数据）
- 包体积（解压后）：45.1 kB，23 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：8 个
- 首次发布：2021-12-31T16:32:04.154Z
- 最新版本发布：2024-04-05T11:17:19.675Z
- 近 30 天下载量：14757（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 0 个）
## 中文简介
Web 组件的 API 文档查看器
## 安装
```sh
npm install @api-viewer/docs
```
也可以使用：`pnpm add @api-viewer/docs`、`yarn add @api-viewer/docs`、`bun add @api-viewer/docs`
## README
# `@api-viewer/docs`
Web 组件的 API 文档 。 依据 [自定义元素显示](https://github.com/webcomponents/custom-elements-manifest) JSON格式.
```html
```
[文 件 ∗∗](https://api-viewer.open-wc.org/docs/guide/intro/)
[生活节日](https://api-viewer.open-wc.org/docs/examples/api-docs/)
[](https://api-viewer.open-wc.org/)
## 安装
```sh
npm install @api-viewer/docs
```
看看这个 [开始](https://api-viewer.open-wc.org/docs/guide/intro/#usage) 向导.
## 特征
- [属性](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#properties) - 部分公开披露JS财产.
- [属性](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#attributes) - HTML 属性(与属性相匹配的属性除外).
- [活动](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#events) - 部门派出的DOM活动.
- [槽数](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#slots) - 默认 `` 和/或指定空档,如果有的话.
- [CSS 自定义属性](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#css-custom-properties) - 组件的造型API.
- [CSS 阴影部件](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#css-shadow-parts) - 可以使用的元素 `::part()`。 。 。 .
## 常见问题
### @api-viewer/docs 是什么？
Web 组件的 API 文档查看器
### 如何安装 @api-viewer/docs？
在项目目录运行 npm install @api-viewer/docs，或使用 pnpm add / yarn add / bun add。
### @api-viewer/docs 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
### @api-viewer/docs 支持 ESM 还是 CommonJS？
以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。
### @api-viewer/docs 可以商用吗？
@api-viewer/docs 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
### @api-viewer/docs 的下载量有多少？
根据 npm 官方下载统计，@api-viewer/docs 在 2026/10/06 – 2026/11/04 这 30 天内被下载 14,757 次，日均约 492 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
### @api-viewer/docs 还在维护吗？
最新版本 1\.0\.0-pre\.10 发布于 2024/04/05（2 年前）；至今共发布 10 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/01/01。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。