让开源，少一点语言距离。
npm包中文文档

@electron/docs-parser

中文文档
3.0.3发布于 2026/10/29MITTypeScriptES Module构建来源已验证近 30 天下载 3.2万

Parse Electron documentation into a machine readable JSON file

原始使用文档
中文原文
文档目录4 节
  1. Usage
  2. How it Works
  3. TypeScript Definitions
  4. License

Electron Docs Parser

docs-parser-logo

Test npm version

Generate a structured JSON API file from Electron's free-form documentation

Usage

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

Options:

  • --useReadme - Assume all documentation is in the module's base README.md file
  • --dir - The base directory where documentation is located.
    • API documentation must be located in /docs/api within the specified base directory.
    • API structures documentation must be located in /docs/api/structures within the specified base directory.
  • --packageMode - Can be single or multi; default single. Specifying multi allows exporting multiple packages from an API instead of multiple modules from a single package.

How it Works

We generate a markdown AST for every documentation file and search for "Modules", "Classes" and "Structures". We then use the well documented and enforced Electron docs style guide to pull the required information about methods, properties and events from the generated AST.

For more information you should start your code dive in DocsParser.ts and then probably block-parsers.ts.

TypeScript Definitions

The output of this module is used to generate TypeScript definitions for the Electron API. This module itself is not used to generate those definitions - @electron/typescript-definitions is.

Further, if you're looking for tooling that automatically surfaces typings in GitHub PRs, you're probably looking for Archaeologist.

License

MIT

版本与发布记录

@electron/docs-parser 共发布 51 个版本，首次发布于 2019/04/26；过去 12 个月发布了 4 个版本。最新版本附带 npm provenance 构建来源证明，可追溯到公开的 CI 构建记录。

版本发布日期距今
3.0.3latest2026/10/2915 天前
3.0.22026/09/251 个月前
3.0.12026/06/184 个月前
3.0.02025/11/1411 个月前
2.0.02024/09/242 年前
1.2.42024/09/232 年前

关于 @electron/docs-parser 的常见问题

@electron/docs-parser 是什么？

Parse Electron documentation into a machine readable JSON file

如何安装 @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 和提交记录判断。