# @electron/docs-parser 中文文档

规范地址：https://npmcn.com/package/%40electron/docs-parser/

版本：3\.0\.3
npm 元数据更新时间：2026-10-28T17:43:51.274Z
中文译文更新时间：2026-11-13T12:02:06.179Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：126 kB，27 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.12\.0
- 运行依赖：7 个
- 首次发布：2019-04-25T20:23:52.682Z
- 最新版本发布：2026-10-28T17:43:50.826Z
- 近 30 天下载量：32018（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：51（近 12 个月 4 个）

## 中文简介

将电子文档解析为机器可读 JSON 文件

## 安装

```sh
npm install @electron/docs-parser
```

也可以使用：`pnpm add @electron/docs-parser`、`yarn add @electron/docs-parser`、`bun add @electron/docs-parser`

## README

# 电子多克解析器

![docs-parser-logo](https://npmcn.com/package/%40electron/docs-parser/design/logo.png)

[![Test](https://github.com/electron/docs-parser/actions/workflows/test.yml/badge.svg)](https://github.com/electron/docs-parser/actions/workflows/test.yml) [![npm version](http://img.shields.io/npm/v/@electron/docs-parser.svg)](https://npmjs.org/package/@electron/docs-parser)

> 从 Electron 的自由格式文档生成结构化的 JSON API 文件

## 使用量

```bash
yarn global add @electron/docs-parser
cd ~/projects/path/to/electron/repo
electron-docs-parser --dir ./

# You now have ./electron-api.json with the entire Electron API
```

选项 :

-   `--useReadme` - 假设所有文件都在模块的底部 `README.md` 文件
-   `--dir` - 文件所在的基础目录.
    -   API 文档必须位于 `/docs/api` 在指定的基础目录中.
    -   API 结构文档必须位于 `/docs/api/structures` 在指定的基础目录中.
-   `--packageMode` - 可能会 `single` 或者说 `multi`; 默认 `single`指定 `multi` 允许从一个API中导出多个软件包,而不是从一个单一软件包中导出多个模块.

## 如何运作

我们生成每个文档文件的 AST 标记和搜索 "摩诃衍""相克""相克""相克". 然后我们用文件记录 执行 [电子文档样式指南](https://github.com/electron/electron/blob/main/docs/development/style-guide.md) 调取所需信息 关于生成的 AST 中的方法、属性和事件.

要了解更多信息,请先输入密码 [`DocsParser.ts`](https://npmcn.com/package/%40electron/docs-parser/src/DocsParser.ts) 然后也许 [`block-parsers.ts`](https://npmcn.com/package/%40electron/docs-parser/src/block-parsers.ts)。 。 。 .

## 类型脚本定义

此模块的输出用于生成类型脚本定义 电动API. 此模块本身不用于生成这些 定义 [@ electron/ typescript- 定义](https://github.com/electron/typescript-definitions) 没错.

此外,如果你要找工具 自动地浮出水面 在GitHub PRs中输入,你可能在找 [考古学家](https://github.com/electron/archaeologist)。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @electron/docs-parser 是什么？

将电子文档解析为机器可读 JSON 文件

### 如何安装 @electron/docs-parser？

在项目目录运行 npm install @electron/docs-parser，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 electron-docs-linter、electron-docs-parser，可以用 npx electron-docs-linter 直接运行。

### @electron/docs-parser 支持 TypeScript 吗？

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

### @electron/docs-parser 支持 ESM 还是 CommonJS？

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

### @electron/docs-parser 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.12\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @electron/docs-parser 可以商用吗？

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

### @electron/docs-parser 的下载量有多少？

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

### @electron/docs-parser 还在维护吗？

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