electron/docs

Please make sure that you use the documents that match your Electron version. The version number should be a part of the URL. If it's not, you are probably using the documentation of a development branch which may contain API changes that are not compatible with your Electron version. When in doubt, run Electron without supplying an app path, and click on the docs link.

Guides

• Supported Platforms
• Application Distribution
• Mac App Store Submission Guide
• Application Packaging
• Using Native Node Modules
• Debugging Main Process
• Using Selenium and WebDriver
• DevTools Extension
• Using Pepper Flash Plugin

Tutorials

• Quick Start
• Desktop Environment Integration
• Online/Offline Event Detection

API References

• Synopsis
• Process Object
• Supported Chrome Command Line Switches

Custom DOM Elements:

• File Object
• <webview> Tag
• window.open Function

Modules for the Main Process:

• app
• autoUpdater
• BrowserWindow
• contentTracing
• dialog
• globalShortcut
• ipcMain
• Menu
• MenuItem
• powerMonitor
• powerSaveBlocker
• protocol
• session
• webContents
• Tray

Modules for the Renderer Process (Web Page):

• ipcRenderer
• remote
• webFrame

Modules for Both Processes:

• clipboard
• crashReporter
• nativeImage
• screen
• shell

Development

• Coding Style
• Source Code Directory Structure
• Technical Differences to NW.js (formerly node-webkit)
• Build System Overview
• Build Instructions (OS X)
• Build Instructions (Windows)
• Build Instructions (Linux)
• Setting Up Symbol Server in debugger