| .. | ||
| api | ||
| development | ||
| tutorial | ||
| faq.md | ||
| README.md | ||
| styleguide.md | ||
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. To view older versions of the documentation, you can browse by tag on GitHub by opening the "Switch branches/tags" dropdown and selecting the tag that matches your version.
FAQ
There are questions that are asked quite often. Check this out before creating an issue:
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)
- Offscreen Rendering
Tutorials
API References
Custom DOM Elements:
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):
Modules for Both Processes:
Development
- Coding Style
- Using clang-format on C++ Code
- 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 (macOS)
- Debug Instructions (Windows)
- Setting Up Symbol Server in debugger
- Documentation Styleguide