d1207e9d8f
* Use "Breaking Changes" as the changes doc's title. Multiple people have commented that this important page is difficult to find, in part because people search for "Breaking" or "Changes" or "Breaking Changes" rather than "API Contract". This PR changes the name to "Breaking Changes" so that it'll show up on electronjs.org/docs/. It also adds a backwards-friendly link so people still searching for "API Contract" will get a redirect. I'm not sure if this is necessary -- the actual URL of https://electronjs.org/docs/api/breaking-changes is unchanged -- would especially welcome feedback on this part. * fixup! Use "Breaking Changes" as the changes doc's title. * fixup! Use "Breaking Changes" as the changes doc's title. |
||
|---|---|---|
| .. | ||
| api | ||
| development | ||
| images | ||
| tutorial | ||
| faq.md | ||
| glossary.md | ||
| README.md | ||
| styleguide.md | ||
Official Guides
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 and Tutorials
- Setting up the Development Environment
- Creating your First App
- Boilerplates and CLIs
- Application Architecture
- Adding Features to Your App
- Accessibility
- Testing and Debugging
- Packaging
- Distribution
- Security
- Updates
Detailed Tutorials
These individual tutorials expand on topics discussed in the guide above.
- In Detail: Installing Electron
- In Detail: Electron's Versioning Scheme
- In Detail: Packaging App Source Code with asar
- In Detail: Testing Widevine CDM
- In Detail: Using Pepper Flash Plugin
- Offscreen Rendering
API References
- Synopsis
- Process Object
- Supported Chrome Command Line Switches
- Environment Variables
- Breaking API Changes
Custom DOM Elements:
Modules for the Main Process:
- app
- autoUpdater
- BrowserView
- BrowserWindow
- contentTracing
- dialog
- globalShortcut
- inAppPurchase
- ipcMain
- Menu
- MenuItem
- net
- netLog
- powerMonitor
- powerSaveBlocker
- protocol
- session
- systemPreferences
- Tray
- webContents