| .. | ||
| 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. 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:
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