2015-11-21 01:31:52 +00:00
|
|
|
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.
|
|
|
|
|
|
2015-03-17 10:37:18 +00:00
|
|
|
## Guides
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2015-10-03 05:42:34 +00:00
|
|
|
* [Supported Platforms](tutorial/supported-platforms.md)
|
2015-09-04 20:50:26 +00:00
|
|
|
* [Application Distribution](tutorial/application-distribution.md)
|
2015-10-16 09:15:23 +00:00
|
|
|
* [Mac App Store Submission Guide](tutorial/mac-app-store-submission-guide.md)
|
2015-09-04 20:50:26 +00:00
|
|
|
* [Application Packaging](tutorial/application-packaging.md)
|
|
|
|
|
* [Using Native Node Modules](tutorial/using-native-node-modules.md)
|
|
|
|
|
* [Debugging Main Process](tutorial/debugging-main-process.md)
|
2014-09-12 16:14:24 +00:00
|
|
|
* [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md)
|
2015-09-04 20:50:26 +00:00
|
|
|
* [DevTools Extension](tutorial/devtools-extension.md)
|
|
|
|
|
* [Using Pepper Flash Plugin](tutorial/using-pepper-flash-plugin.md)
|
2015-03-17 10:37:18 +00:00
|
|
|
|
2015-03-19 03:25:53 +00:00
|
|
|
## Tutorials
|
2015-03-17 10:37:18 +00:00
|
|
|
|
2015-09-04 20:50:26 +00:00
|
|
|
* [Quick Start](tutorial/quick-start.md)
|
|
|
|
|
* [Desktop Environment Integration](tutorial/desktop-environment-integration.md)
|
|
|
|
|
* [Online/Offline Event Detection](tutorial/online-offline-events.md)
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2015-09-04 20:50:26 +00:00
|
|
|
## API References
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2014-05-05 06:49:05 +00:00
|
|
|
* [Synopsis](api/synopsis.md)
|
2015-09-04 20:50:26 +00:00
|
|
|
* [Process Object](api/process.md)
|
|
|
|
|
* [Supported Chrome Command Line Switches](api/chrome-command-line-switches.md)
|
2014-05-05 06:49:05 +00:00
|
|
|
|
2015-09-04 21:31:33 +00:00
|
|
|
### Custom DOM Elements:
|
2014-10-25 06:58:32 +00:00
|
|
|
|
2015-09-04 20:50:26 +00:00
|
|
|
* [`File` Object](api/file-object.md)
|
|
|
|
|
* [`<webview>` Tag](api/web-view-tag.md)
|
|
|
|
|
* [`window.open` Function](api/window-open.md)
|
2014-10-25 06:58:32 +00:00
|
|
|
|
2015-09-04 21:31:33 +00:00
|
|
|
### Modules for the Main Process:
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2014-05-05 06:24:57 +00:00
|
|
|
* [app](api/app.md)
|
2015-11-12 13:20:09 +00:00
|
|
|
* [autoUpdater](api/auto-updater.md)
|
|
|
|
|
* [BrowserWindow](api/browser-window.md)
|
|
|
|
|
* [contentTracing](api/content-tracing.md)
|
2014-05-05 06:24:57 +00:00
|
|
|
* [dialog](api/dialog.md)
|
2015-11-12 13:20:09 +00:00
|
|
|
* [globalShortcut](api/global-shortcut.md)
|
|
|
|
|
* [ipcMain](api/ipc-main.md)
|
|
|
|
|
* [Menu](api/menu.md)
|
|
|
|
|
* [MenuItem](api/menu-item.md)
|
|
|
|
|
* [powerMonitor](api/power-monitor.md)
|
|
|
|
|
* [powerSaveBlocker](api/power-save-blocker.md)
|
2014-05-05 06:24:57 +00:00
|
|
|
* [protocol](api/protocol.md)
|
2015-08-20 13:25:22 +00:00
|
|
|
* [session](api/session.md)
|
2015-11-12 13:20:09 +00:00
|
|
|
* [webContents](api/web-contents.md)
|
|
|
|
|
* [Tray](api/tray.md)
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2015-09-04 21:31:33 +00:00
|
|
|
### Modules for the Renderer Process (Web Page):
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2015-11-12 13:20:09 +00:00
|
|
|
* [ipcRenderer](api/ipc-renderer.md)
|
2014-05-05 06:24:57 +00:00
|
|
|
* [remote](api/remote.md)
|
2015-11-12 13:20:09 +00:00
|
|
|
* [webFrame](api/web-frame.md)
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2015-09-04 21:31:33 +00:00
|
|
|
### Modules for Both Processes:
|
2013-08-14 22:43:35 +00:00
|
|
|
|
2014-05-05 06:24:57 +00:00
|
|
|
* [clipboard](api/clipboard.md)
|
2015-11-12 13:20:09 +00:00
|
|
|
* [crashReporter](api/crash-reporter.md)
|
|
|
|
|
* [nativeImage](api/native-image.md)
|
2014-05-05 06:24:57 +00:00
|
|
|
* [screen](api/screen.md)
|
|
|
|
|
* [shell](api/shell.md)
|
2014-05-05 06:49:05 +00:00
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|
|
2015-09-04 20:50:26 +00:00
|
|
|
* [Coding Style](development/coding-style.md)
|
|
|
|
|
* [Source Code Directory Structure](development/source-code-directory-structure.md)
|
|
|
|
|
* [Technical Differences to NW.js (formerly node-webkit)](development/atom-shell-vs-node-webkit.md)
|
|
|
|
|
* [Build System Overview](development/build-system-overview.md)
|
2015-10-16 20:03:47 +00:00
|
|
|
* [Build Instructions (OS X)](development/build-instructions-osx.md)
|
2015-09-04 20:50:26 +00:00
|
|
|
* [Build Instructions (Windows)](development/build-instructions-windows.md)
|
|
|
|
|
* [Build Instructions (Linux)](development/build-instructions-linux.md)
|
|
|
|
|
* [Setting Up Symbol Server in debugger](development/setting-up-symbol-server.md)
|
