electron/docs/README.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](https://github.com/electron/electron/tree/v1.4.0)
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:

* [Electron FAQ](faq.md)

## Guides

* [Glossary of Terms](glossary.md)
* [Supported Platforms](tutorial/supported-platforms.md)
* [Security](tutorial/security.md)
* [Electron Versioning](tutorial/electron-versioning.md)
* [Application Distribution](tutorial/application-distribution.md)
* [Mac App Store Submission Guide](tutorial/mac-app-store-submission-guide.md)
* [Windows Store Guide](tutorial/windows-store-guide.md)
* [Application Packaging](tutorial/application-packaging.md)
* [Using Native Node Modules](tutorial/using-native-node-modules.md)
* [Debugging Main Process](tutorial/debugging-main-process.md)
* [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md)
* [DevTools Extension](tutorial/devtools-extension.md)
* [Using Pepper Flash Plugin](tutorial/using-pepper-flash-plugin.md)
* [Using Widevine CDM Plugin](tutorial/using-widevine-cdm-plugin.md)
* [Testing on Headless CI Systems (Travis, Jenkins)](tutorial/testing-on-headless-ci.md)
* [Offscreen Rendering](tutorial/offscreen-rendering.md)

## Tutorials

* [Quick Start](tutorial/quick-start.md)
* [Desktop Environment Integration](tutorial/desktop-environment-integration.md)
* [Online/Offline Event Detection](tutorial/online-offline-events.md)
* [REPL](tutorial/repl.md)

## API References

* [Synopsis](api/synopsis.md)
* [Process Object](api/process.md)
* [Supported Chrome Command Line Switches](api/chrome-command-line-switches.md)
* [Environment Variables](api/environment-variables.md)

### Custom DOM Elements:

* [`File` Object](api/file-object.md)
* [`<webview>` Tag](api/webview-tag.md)
* [`window.open` Function](api/window-open.md)

### Modules for the Main Process:

* [app](api/app.md)
* [autoUpdater](api/auto-updater.md)
* [BrowserWindow](api/browser-window.md)
* [contentTracing](api/content-tracing.md)
* [dialog](api/dialog.md)
* [globalShortcut](api/global-shortcut.md)
* [ipcMain](api/ipc-main.md)
* [Menu](api/menu.md)
* [MenuItem](api/menu-item.md)
* [net](api/net.md)
* [powerMonitor](api/power-monitor.md)
* [powerSaveBlocker](api/power-save-blocker.md)
* [protocol](api/protocol.md)
* [session](api/session.md)
* [systemPreferences](api/system-preferences.md)
* [Tray](api/tray.md)
* [webContents](api/web-contents.md)

### Modules for the Renderer Process (Web Page):

* [desktopCapturer](api/desktop-capturer.md)
* [ipcRenderer](api/ipc-renderer.md)
* [remote](api/remote.md)
* [webFrame](api/web-frame.md)

### Modules for Both Processes:

* [clipboard](api/clipboard.md)
* [crashReporter](api/crash-reporter.md)
* [nativeImage](api/native-image.md)
* [screen](api/screen.md)
* [shell](api/shell.md)

## Development

* [Coding Style](development/coding-style.md)
* [Using clang-format on C++ Code](development/clang-format.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)
* [Build Instructions (macOS)](development/build-instructions-osx.md)
* [Build Instructions (Windows)](development/build-instructions-windows.md)
* [Build Instructions (Linux)](development/build-instructions-linux.md)
* [Debug Instructions (macOS)](development/debugging-instructions-macos.md)
* [Debug Instructions (Windows)](development/debug-instructions-windows.md)
* [Setting Up Symbol Server in debugger](development/setting-up-symbol-server.md)
* [Documentation Styleguide](styleguide.md)
Add a note to readme about docs versioning Added a note to readme about using the correct docs version. Hopefully this will reduce users confusion. 2015-11-21 03:31:52 +02:00			`Please make sure that you use the documents that match your Electron version.`
Rephrased the note 2015-11-21 04:22:16 +02:00			`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`
website doesn't display docs for old versions any more 2016-09-19 21:09:02 -07:00			`changes that are not compatible with your Electron version. To view older`
			`versions of the documentation, you can`
			`[browse by tag](https://github.com/electron/electron/tree/v1.4.0)`
			`on GitHub by opening the "Switch branches/tags" dropdown and selecting the tag`
			`that matches your version.`
Add a note to readme about docs versioning Added a note to readme about using the correct docs version. Hopefully this will reduce users confusion. 2015-11-21 03:31:52 +02:00
Add FAQ 2016-01-05 19:52:57 +08:00			`## FAQ`

break up run-on sentence 2016-09-19 21:09:31 -07:00			`There are questions that are asked quite often. Check this out before creating`
Add FAQ 2016-01-05 19:52:57 +08:00			`an issue:`

Fixed broken FAQ link in docs/README.md 2016-07-09 16:14:42 +03:00			`* [Electron FAQ](faq.md)`
Add FAQ 2016-01-05 19:52:57 +08:00
docs: Separate guides and tutorials 2015-03-17 18:37:18 +08:00			`## Guides`
Move wiki content to docs dir 2013-08-14 15:43:35 -07:00
lint to glossary from docs readme 2016-11-04 11:32:53 -07:00			`* [Glossary of Terms](glossary.md)`
docs: Add "Supported Platforms" 2015-10-03 13:42:34 +08:00			`* [Supported Platforms](tutorial/supported-platforms.md)`
:memo: Add Security Tutorial Add basic information about Electron and Security, including an invitation to contribute to security features. Contains information by @zcbenz, @zeke, and @paulcbetts. 2016-05-06 11:23:18 +01:00			`* [Security](tutorial/security.md)`
:memo: Add Information about Versioning 2016-05-17 20:20:25 +02:00			`* [Electron Versioning](tutorial/electron-versioning.md)`
Title Case 2015-09-04 13:50:26 -07:00			`* [Application Distribution](tutorial/application-distribution.md)`
docs: Mac App Store Submission Guide 2015-10-16 17:15:23 +08:00			`* [Mac App Store Submission Guide](tutorial/mac-app-store-submission-guide.md)`
:memo: Add Windows Store Guide This commit adds a guide about how to compile your app as a Windows Store app, analog to the Mac App Store guide. 2016-05-11 10:48:33 +02:00			`* [Windows Store Guide](tutorial/windows-store-guide.md)`
Title Case 2015-09-04 13:50:26 -07: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)`
docs: use => using 2014-09-13 00:14:24 +08:00			`* [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md)`
Title Case 2015-09-04 13:50:26 -07:00			`* [DevTools Extension](tutorial/devtools-extension.md)`
			`* [Using Pepper Flash Plugin](tutorial/using-pepper-flash-plugin.md)`
docs: Using Widevine CDM Plugin 2015-12-30 16:10:00 +08:00			`* [Using Widevine CDM Plugin](tutorial/using-widevine-cdm-plugin.md)`
:memo: Add Headless CI Tutorial 2016-02-24 12:19:43 -08:00			`* [Testing on Headless CI Systems (Travis, Jenkins)](tutorial/testing-on-headless-ci.md)`
Add Offscreen Rendering to guides 2016-08-03 15:38:24 +09:00			`* [Offscreen Rendering](tutorial/offscreen-rendering.md)`
docs: Separate guides and tutorials 2015-03-17 18:37:18 +08:00
docs: Add a "s" 2015-03-19 11:25:53 +08:00			`## Tutorials`
docs: Separate guides and tutorials 2015-03-17 18:37:18 +08:00
Title Case 2015-09-04 13:50:26 -07:00			`* [Quick Start](tutorial/quick-start.md)`
			`* [Desktop Environment Integration](tutorial/desktop-environment-integration.md)`
			`* [Online/Offline Event Detection](tutorial/online-offline-events.md)`
repl-docs: move file to tutorials also add note for renderer processes. 2016-10-04 00:12:25 +05:30			`* [REPL](tutorial/repl.md)`
Move wiki content to docs dir 2013-08-14 15:43:35 -07:00
Title Case 2015-09-04 13:50:26 -07:00			`## API References`
Move wiki content to docs dir 2013-08-14 15:43:35 -07:00
:memo: Add Synopsis chapter. 2014-05-05 14:49:05 +08:00			`* [Synopsis](api/synopsis.md)`
Title Case 2015-09-04 13:50:26 -07:00			`* [Process Object](api/process.md)`
			`* [Supported Chrome Command Line Switches](api/chrome-command-line-switches.md)`
docs: Add Environment Variables 2015-11-26 20:37:48 +08:00			`* [Environment Variables](api/environment-variables.md)`
:memo: Add Synopsis chapter. 2014-05-05 14:49:05 +08:00
Use headers so titles are linkable 2015-09-04 14:31:33 -07:00			`### Custom DOM Elements:`
Add docs on our custom web elements 2014-10-25 14:58:32 +08:00
Title Case 2015-09-04 13:50:26 -07:00			* [`File` Object](api/file-object.md)
replace all web-view code with webview 2016-11-09 15:04:00 -08:00			* [`<webview>` Tag](api/webview-tag.md)
Title Case 2015-09-04 13:50:26 -07:00			* [`window.open` Function](api/window-open.md)
Add docs on our custom web elements 2014-10-25 14:58:32 +08:00
Use headers so titles are linkable 2015-09-04 14:31:33 -07:00			`### Modules for the Main Process:`
Move wiki content to docs dir 2013-08-14 15:43:35 -07:00
:memo: Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00			`* [app](api/app.md)`
docs: Update codes in docs to use require('electron') 2015-11-12 21:20:09 +08:00			`* [autoUpdater](api/auto-updater.md)`
			`* [BrowserWindow](api/browser-window.md)`
			`* [contentTracing](api/content-tracing.md)`
:memo: Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00			`* [dialog](api/dialog.md)`
docs: Update codes in docs to use require('electron') 2015-11-12 21:20:09 +08:00			`* [globalShortcut](api/global-shortcut.md)`
			`* [ipcMain](api/ipc-main.md)`
			`* [Menu](api/menu.md)`
			`* [MenuItem](api/menu-item.md)`
Add missing `net` document entry. 2016-11-01 16:50:55 +01:00			`* [net](api/net.md)`
docs: Update codes in docs to use require('electron') 2015-11-12 21:20:09 +08:00			`* [powerMonitor](api/power-monitor.md)`
			`* [powerSaveBlocker](api/power-save-blocker.md)`
:memo: Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00			`* [protocol](api/protocol.md)`
Add new files to readme 2015-08-20 15:25:22 +02:00			`* [session](api/session.md)`
docs: systemPreferences 2016-04-25 15:36:38 +09:00			`* [systemPreferences](api/system-preferences.md)`
docs: Update codes in docs to use require('electron') 2015-11-12 21:20:09 +08:00			`* [Tray](api/tray.md)`
One alphabetical reordering in the docs/README.md :memo: webContents, Tray -> Tray, webContents If I get it right, only API TOCs should be ordered alphabetically, so I've left other ones (Guides, Tutorials, Development) untouched. I'm not so sure about API TOC Intro (three links below the "Synopsis"), tell me if they should be sorted alphabetically too. [ci skip] 2016-07-08 03:33:22 +03:00			`* [webContents](api/web-contents.md)`
Move wiki content to docs dir 2013-08-14 15:43:35 -07:00
Use headers so titles are linkable 2015-09-04 14:31:33 -07:00			`### Modules for the Renderer Process (Web Page):`
Move wiki content to docs dir 2013-08-14 15:43:35 -07:00
Merge branch 'master' into desktop-capture-api 2015-12-08 12:43:44 +08:00			`* [desktopCapturer](api/desktop-capturer.md)`
docs: Update codes in docs to use require('electron') 2015-11-12 21:20:09 +08:00			`* [ipcRenderer](api/ipc-renderer.md)`
:memo: Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00			`* [remote](api/remote.md)`
docs: Update codes in docs to use require('electron') 2015-11-12 21:20:09 +08:00			`* [webFrame](api/web-frame.md)`
Move wiki content to docs dir 2013-08-14 15:43:35 -07:00
Use headers so titles are linkable 2015-09-04 14:31:33 -07:00			`### Modules for Both Processes:`
Move wiki content to docs dir 2013-08-14 15:43:35 -07:00
:memo: Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00			`* [clipboard](api/clipboard.md)`
docs: Update codes in docs to use require('electron') 2015-11-12 21:20:09 +08:00			`* [crashReporter](api/crash-reporter.md)`
			`* [nativeImage](api/native-image.md)`
:memo: Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00			`* [screen](api/screen.md)`
			`* [shell](api/shell.md)`
:memo: Add Synopsis chapter. 2014-05-05 14:49:05 +08:00
			`## Development`

Title Case 2015-09-04 13:50:26 -07:00			`* [Coding Style](development/coding-style.md)`
Minor edits to clang-format guide 2016-10-07 14:03:03 -07:00			`* [Using clang-format on C++ Code](development/clang-format.md)`
Title Case 2015-09-04 13:50:26 -07:00			`* [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)`
Replace OS X and Mac OS with macOS 2016-06-18 15:26:26 +02:00			`* [Build Instructions (macOS)](development/build-instructions-osx.md)`
Title Case 2015-09-04 13:50:26 -07:00			`* [Build Instructions (Windows)](development/build-instructions-windows.md)`
			`* [Build Instructions (Linux)](development/build-instructions-linux.md)`
fix link to Mac debug instructions 2016-10-28 14:32:48 -07:00			`* [Debug Instructions (macOS)](development/debugging-instructions-macos.md)`
:memo: Fix link to macOS Debugging Instructions 2016-08-01 19:15:03 -07:00			`* [Debug Instructions (Windows)](development/debug-instructions-windows.md)`
Title Case 2015-09-04 13:50:26 -07:00			`* [Setting Up Symbol Server in debugger](development/setting-up-symbol-server.md)`
update the zh-CN docs README.md and find a error in en docs README.md (#7676) * update the zh-CN readme and find a error in en readme * fix a style problem 2016-10-24 09:21:02 +08:00			`* [Documentation Styleguide](styleguide.md)`