electron

英文原文正文为项目原始 README（英文），本站后续会翻译为中文，当前仅剔除图片与无关章节并统一排版。

:memo: 可用翻译：🇨🇳 🇧🇷 🇪🇸 🇯🇵 🇷🇺 🇫🇷 🇺🇸 🇩🇪。您可以在我们的 Crowdin 项目中查看其他语言的文档。

Electron 框架允许您使用 JavaScript、HTML 和 CSS 编写跨平台桌面应用程序。它基于 Node.js 和 Chromium，并被 Visual Studio Code 以及许多其他 应用程序 使用。

在 Twitter 上关注 @electronjs 以获取重要公告。

本项目遵循 Contributor Covenant 的 行为准则。参与项目时，您需要遵守此准则。请将不可接受的行为报告至 coc@electronjs.org。

安装

要安装预构建的 Electron 二进制文件，请使用 npm。推荐的方法是在你的应用中将 Electron 作为开发依赖安装：

npm install electron --save-dev

有关更多安装选项和故障排除技巧，请参阅 安装。有关如何在应用中管理 Electron 版本的信息，请参阅 Electron 版本管理。

平台支持

每个 Electron 版本都提供适用于 macOS、Windows 和 Linux 的二进制文件。

• macOS（Ventura 及以上版本）：Electron 为 macOS 提供 64 位 Intel 和 Apple Silicon/ARM 二进制文件。
• Windows（Windows 10 及以上版本）：Electron 为 Windows 提供 x64（amd64）和 arm64 二进制文件。
• Linux：Electron 为 Linux 提供 x64（amd64）和 arm64 二进制文件。Electron 支持主要的 Linux 发行版（例如 Ubuntu、Fedora、Debian），这些版本仍然受到 Chromium 和发行版开发者的支持（无需付费订阅）。预构建的二进制文件是在 Ubuntu 上构建的。

一般来说，Electron 尝试与 Chromium 在平台支持上保持一致 。

电子小提琴

使用 Electron Fiddle 来构建、运行和打包小型 Electron 实验，查看所有 Electron API 的代码示例，并尝试不同版本的 Electron。它旨在让你更轻松地开始 Electron 之旅。

Electron 学习资源

• electronjs.org/docs - 所有 Electron 文档
• electron/fiddle - 一个用于构建、运行和打包小型 Electron 实验的工具

编程使用

大多数人通过命令行使用 Electron，但如果你在你的 Node 应用（不是你的 Electron 应用）中使用 electron，它将返回二进制文件的路径。使用这个路径可以从 Node 脚本生成 Electron:

const electron = require('electron')
const proc = require('node:child_process')

// will print something similar to /Users/maf/.../Electron
console.log(electron)

// spawn Electron
const child = proc.spawn(electron)

镜像

• 中国

请参阅高级安装说明以了解如何使用自定义镜像。

文档翻译

我们通过 Crowdin 众包我们的文档翻译。目前我们接受中文（简体）、法语、德语、日语、葡萄牙语、俄语和西班牙语的翻译。

贡献

如果您有兴趣报告/修复问题并直接为代码库做出贡献，请参阅 CONTRIBUTING.md 以获取有关我们所需内容及如何开始的更多信息。

社区

有关报告错误、获取帮助、寻找第三方工具和示例应用程序等信息，可以在社区页面上找到。

许可证

MIT

使用 Electron 标志时，请确保遵循 OpenJS 基金会商标政策。