diff --git a/docs/api/accelerator.md b/docs/api/accelerator.md index ff2b8190a9..cf28e01037 100644 --- a/docs/api/accelerator.md +++ b/docs/api/accelerator.md @@ -1,6 +1,6 @@ # Accelerator -Define keyboard shortcuts. +> Define keyboard shortcuts. Accelerators can contain multiple modifiers and key codes, combined by the `+` character. diff --git a/docs/api/app.md b/docs/api/app.md index b06f8e6b6a..8a2cdcfd92 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -1,6 +1,6 @@ # app -Control your application's event lifecycle. +> Control your application's event lifecycle. The following example shows how to quit the application when the last window is closed: diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md index daea501210..8ad3f8f16e 100644 --- a/docs/api/auto-updater.md +++ b/docs/api/auto-updater.md @@ -1,6 +1,6 @@ # autoUpdater -Enable apps to update themselves automatically. +> Enable apps to update themselves automatically. The `autoUpdater` module provides and interface for the [Squirrel](https://github.com/Squirrel) framework. diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index b7536249f8..7289057b40 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1,6 +1,6 @@ # BrowserWindow -Create and control browser windows. +> Create and control browser windows. ```javascript // In the main process. diff --git a/docs/api/chrome-command-line-switches.md b/docs/api/chrome-command-line-switches.md index f7515a5f1f..71a5ce6a40 100644 --- a/docs/api/chrome-command-line-switches.md +++ b/docs/api/chrome-command-line-switches.md @@ -1,6 +1,6 @@ # Supported Chrome command line switches -Command line switches supported by Electron. +> Command line switches supported by Electron. You can use [app.commandLine.appendSwitch][append-switch] to append them in your app's main script before the [ready][ready] event of [app][app] module is diff --git a/docs/api/clipboard.md b/docs/api/clipboard.md index 2f9440f80e..58e5a1c1b0 100644 --- a/docs/api/clipboard.md +++ b/docs/api/clipboard.md @@ -1,6 +1,6 @@ # clipboard -Perform copy and paste operations on the system clipboard. +> Perform copy and paste operations on the system clipboard. The following example shows how to write a string to the clipboard: diff --git a/docs/api/content-tracing.md b/docs/api/content-tracing.md index 66c7679dd0..c69031850a 100644 --- a/docs/api/content-tracing.md +++ b/docs/api/content-tracing.md @@ -1,6 +1,6 @@ # contentTracing -Debug your application using Chromium's content module. +> Debug your application using Chromium's content module. This module does not include a web interface so you need to open `chrome://tracing/` in a Chrome browser and load the diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index 0ef2317db6..1f8229eaa7 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -1,6 +1,6 @@ # crashReporter -Submit crash reports to a remote server. +> Submit crash reports to a remote server. The following is an example of automatically submitting a crash report to a remote server: diff --git a/docs/api/desktop-capturer.md b/docs/api/desktop-capturer.md index c80928017a..505dd9596a 100644 --- a/docs/api/desktop-capturer.md +++ b/docs/api/desktop-capturer.md @@ -1,6 +1,6 @@ # desktopCapturer -Capture audio, video, and images from a microphone, camera, or +> Capture audio, video, and images from a microphone, camera, or screen using the `getUserMedia` API. ```javascript diff --git a/docs/api/dialog.md b/docs/api/dialog.md index e052f10dca..a5f61a53e3 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -1,6 +1,6 @@ # dialog -Display native system dialogs for opening and saving files, alerting, etc. +> Display native system dialogs for opening and saving files, alerting, etc. An example of showing a dialog to select multiple files and directories: diff --git a/docs/api/download-item.md b/docs/api/download-item.md index 02e5b39500..0f38ceedac 100644 --- a/docs/api/download-item.md +++ b/docs/api/download-item.md @@ -1,6 +1,6 @@ # DownloadItem -Trigger file downloads from remote sources. +> Trigger file downloads from remote sources. `DownloadItem` is an EventEmitter represents a download item in Electron. It is used in `will-download` event of `Session` module, and allows users to diff --git a/docs/api/environment-variables.md b/docs/api/environment-variables.md index 6186c06904..7339661b09 100644 --- a/docs/api/environment-variables.md +++ b/docs/api/environment-variables.md @@ -1,6 +1,6 @@ # Environment variables -Control application configuration and behavior without changing code. +> Control application configuration and behavior without changing code. Some behaviors of Electron are controlled by environment variables, because they are initialized earlier than command line and the app's code. diff --git a/docs/api/file-object.md b/docs/api/file-object.md index f1d3680eb8..31c6feddb5 100644 --- a/docs/api/file-object.md +++ b/docs/api/file-object.md @@ -1,6 +1,6 @@ # `File` object -Use the HTML5 `File` API to work natively with files on the filesystem. +> Use the HTML5 `File` API to work natively with files on the filesystem. The DOM's File interface provides abstraction around native files in order to let users work on native files directly with the HTML5 file API. Electron has diff --git a/docs/api/global-shortcut.md b/docs/api/global-shortcut.md index c1bce458c8..08453d68a4 100644 --- a/docs/api/global-shortcut.md +++ b/docs/api/global-shortcut.md @@ -1,6 +1,6 @@ # globalShortcut -Detect keyboard events when the application does not have keyboard focus. +> Detect keyboard events when the application does not have keyboard focus. The `globalShortcut` module can register/unregister a global keyboard shortcut with the operating system so that you can customize the operations for various diff --git a/docs/api/ipc-main.md b/docs/api/ipc-main.md index 1ddb0bb1c9..c8ba60ba31 100644 --- a/docs/api/ipc-main.md +++ b/docs/api/ipc-main.md @@ -1,6 +1,6 @@ # ipcMain -Communicate asynchronously from the main process to renderer processes. +> Communicate asynchronously from the main process to renderer processes. The `ipcMain` module is an instance of the [EventEmitter](https://nodejs.org/api/events.html) class. When used in the main diff --git a/docs/api/ipc-renderer.md b/docs/api/ipc-renderer.md index 8d18524d1c..9835e42b46 100644 --- a/docs/api/ipc-renderer.md +++ b/docs/api/ipc-renderer.md @@ -1,6 +1,6 @@ # ipcRenderer -Communicate asynchronously from a renderer process to the main process. +> Communicate asynchronously from a renderer process to the main process. The `ipcRenderer` module is an instance of the [EventEmitter](https://nodejs.org/api/events.html) class. It provides a few diff --git a/docs/api/menu-item.md b/docs/api/menu-item.md index 5c5532289a..0b5db94311 100644 --- a/docs/api/menu-item.md +++ b/docs/api/menu-item.md @@ -1,6 +1,6 @@ # MenuItem -Add items to application and context menus. +> Add items to application and context menus. See [`menu`](menu.md) for examples. diff --git a/docs/api/menu.md b/docs/api/menu.md index 6ac8a9ea1e..4106dfdd40 100644 --- a/docs/api/menu.md +++ b/docs/api/menu.md @@ -1,6 +1,6 @@ # Menu -Create native application menus and context menus. +> Create native application menus and context menus. This module is a main process module which can be used in a render process via the `remote` module. diff --git a/docs/api/native-image.md b/docs/api/native-image.md index ed3bbdacc9..1cbfcf4101 100644 --- a/docs/api/native-image.md +++ b/docs/api/native-image.md @@ -1,6 +1,6 @@ # nativeImage -Create tray, dock, and application icons using PNG or JPG files. +> Create tray, dock, and application icons using PNG or JPG files. In Electron, for the APIs that take images, you can pass either file paths or `nativeImage` instances. An empty image will be used when `null` is passed. diff --git a/docs/api/power-monitor.md b/docs/api/power-monitor.md index 72cfbca1f1..75546dc801 100644 --- a/docs/api/power-monitor.md +++ b/docs/api/power-monitor.md @@ -1,6 +1,6 @@ # powerMonitor -Monitor power state changes. +> Monitor power state changes. You can only use it in the main process. You should not use this module until the `ready` event of the `app` module is emitted. diff --git a/docs/api/power-save-blocker.md b/docs/api/power-save-blocker.md index 315bbdb9be..3ec0733864 100644 --- a/docs/api/power-save-blocker.md +++ b/docs/api/power-save-blocker.md @@ -1,6 +1,6 @@ # powerSaveBlocker -Block the system from entering low-power (sleep) mode. +> Block the system from entering low-power (sleep) mode. For example: diff --git a/docs/api/process.md b/docs/api/process.md index 1805337095..80f0e539d8 100644 --- a/docs/api/process.md +++ b/docs/api/process.md @@ -1,6 +1,6 @@ # process -Get information about the running application process. +> Get information about the running application process. The `process` object in Electron has the following differences from the one in upstream node: diff --git a/docs/api/protocol.md b/docs/api/protocol.md index ade04c1cc3..b3062bb632 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -1,6 +1,6 @@ # protocol -Register a custom protocol to intercept click events from other running +> Register a custom protocol to intercept click events from other running applications. An example of implementing a protocol that has the same effect as the diff --git a/docs/api/remote.md b/docs/api/remote.md index fb585a0fc3..65f58f01b0 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -1,6 +1,6 @@ # remote -Communicate between the renderer process and the main process. +> Communicate between the renderer process and the main process. The `remote` module provides a simple way to do inter-process communication (IPC) between the renderer process (web page) and the main process. diff --git a/docs/api/session.md b/docs/api/session.md index e7689c8e4b..390a9a5e4d 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -1,6 +1,6 @@ # session -Manage browser cookies, cache, and other session data. +> Manage browser cookies, cache, and other session data. The `session` module can be used to create new `Session` objects. diff --git a/docs/api/shell.md b/docs/api/shell.md index b340acaebf..8ede115f7c 100644 --- a/docs/api/shell.md +++ b/docs/api/shell.md @@ -1,6 +1,6 @@ # shell -Manage files and URLs using their default applications. +> Manage files and URLs using their default applications. The `shell` module provides functions related to desktop integration. diff --git a/docs/api/synopsis.md b/docs/api/synopsis.md index d79942531e..641df7e260 100644 --- a/docs/api/synopsis.md +++ b/docs/api/synopsis.md @@ -1,6 +1,6 @@ # Synopsis -Info about Node.js and the main and renderer processes. +> Info about Node.js and the main and renderer processes. All of [Node.js's built-in modules](http://nodejs.org/api/) are available in Electron and third-party node modules also fully supported as well (including diff --git a/docs/api/tray.md b/docs/api/tray.md index d6bf2b3c73..1ea0859f14 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -1,6 +1,6 @@ # Tray -Add icons and context menus to the system's notification area. +> Add icons and context menus to the system's notification area. ```javascript const electron = require('electron'); diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index e49e220dbb..5c0f457538 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -1,6 +1,6 @@ # webContents -Render and control web pages using lifecycle events. +> Render and control web pages using lifecycle events. `webContents` is an [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). diff --git a/docs/api/web-frame.md b/docs/api/web-frame.md index 109bfa103d..b2d8aa0f41 100644 --- a/docs/api/web-frame.md +++ b/docs/api/web-frame.md @@ -1,6 +1,6 @@ # webFrame -Customize the rendering of the current web page. +> Customize the rendering of the current web page. An example of zooming current page to 200%. diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 36b0513e55..5f4a422a13 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -1,6 +1,6 @@ # The `` tag -Display external web content in an isolated frame and process. +> Display external web content in an isolated frame and process. Use the `webview` tag to embed 'guest' content (such as web pages) in your Electron app. The guest content is contained within the `webview` container. diff --git a/docs/api/window-open.md b/docs/api/window-open.md index 14a0dce65f..b4f5057dae 100644 --- a/docs/api/window-open.md +++ b/docs/api/window-open.md @@ -1,6 +1,6 @@ # The `window.open` function -Create a new window in a web page. +> Create a new window in a web page. When `window.open` is called to create a new window in a web page, a new instance of `BrowserWindow` will be created for the `url` and a proxy will be returned