electron/docs

Please make sure that you use the documents that match your Electron version. The version number should be a part of the page 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. If that's the case, you can switch to a different version of the documentation at the available versions list on atom.io, or if you're using the GitHub interface, open the "Switch branches/tags" dropdown and select the tag that matches your version.

FAQ

There are questions that are asked quite often, check this out before creating an issue:

• Electron FAQ

Guides

• Supported Platforms
• Security
• Electron Versioning
• Application Distribution
• Mac App Store Submission Guide
• Windows Store Guide
• Application Packaging
• Using Native Node Modules
• Debugging Main Process
• Using Selenium and WebDriver
• DevTools Extension
• Using Pepper Flash Plugin
• Using Widevine CDM Plugin
• Testing on Headless CI Systems (Travis, Jenkins)

Tutorials

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

API References

• Synopsis
• Process Object
• Supported Chrome Command Line Switches
• Environment Variables

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
• systemPreferences
• Tray
• webContents

Modules for the Renderer Process (Web Page):

• desktopCapturer
• 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 (macOS)
• Build Instructions (Windows)
• Build Instructions (Linux)
• Debug Instructions (Windows)
• Setting Up Symbol Server in debugger