Merge pull request #4963 from preco21/document-fixes-2

Docs: Improve docs styles
This commit is contained in:
Kevin Sawicki 2016-03-31 15:44:31 -07:00
commit 389b2b5cdd
9 changed files with 20 additions and 18 deletions

View file

@ -361,16 +361,16 @@ Clears the recent documents list.
### `app.setAsDefaultProtocolClient(protocol)` _OS X_ _Windows_
* `protocol` String - The name of your protocol, without `://`. If you want your
app to handle `electron://` links, call this method with `electron` as the
parameter.
* `protocol` String - The name of your protocol, without `://`. If you want your
app to handle `electron://` links, call this method with `electron` as the
parameter.
This method sets the current executable as the default handler for a protocol
(aka URI scheme). It allows you to integrate your app deeper into the operating
system. Once registered, all links with `your-protocol://` will be openend with
the current executable. The whole link, including protocol, will be passed to
your application as a parameter.
**Note:** On OS X, you can only register protocols that have been added to
your app's `info.plist`, which can not be modified at runtime. You can however
change the file with a simple text editor or script during build time.
@ -380,11 +380,11 @@ The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme internally
### `app.removeAsDefaultProtocolClient(protocol)` _Windows_
* `protocol` String - The name of your protocol, without `://`.
* `protocol` String - The name of your protocol, without `://`.
This method checks if the current executable as the default handler for a protocol
(aka URI scheme). If so, it will remove the app as the default handler.
**Note:** On OS X, removing the app will automatically remove the app as the
default protocol handler.

View file

@ -2,7 +2,8 @@
This module provides an interface for the `Squirrel` auto-updater framework.
You can quickly launch a multi-platform release server for distributing your application by forking [electron-release-server](https://github.com/ArekSredzki/electron-release-server).
You can quickly launch a multi-platform release server for distributing your
application by forking [electron-release-server][electron-release-server].
## Platform notices
@ -101,3 +102,4 @@ should only be called after `update-downloaded` has been emitted.
[squirrel-windows]: https://github.com/Squirrel/Squirrel.Windows
[installer]: https://github.com/atom/grunt-electron-installer
[app-user-model-id]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx
[electron-release-server]: https://github.com/ArekSredzki/electron-release-server

View file

@ -69,7 +69,7 @@ hence no functions or prototype chain will be included.
The main process handles it by listening for `channel` with `ipcMain` module,
and replies by setting `event.returnValue`.
__Note:__ Sending a synchronous message will block the whole renderer process,
**Note:** Sending a synchronous message will block the whole renderer process,
unless you know what you are doing you should never use it.
### `ipcRenderer.sendToHost(channel[, arg1][, arg2][, ...])`

View file

@ -75,7 +75,7 @@ labeled as such.
Emitted when the tray icon is clicked.
__Note:__ The `bounds` payload is only implemented on OS X and Windows.
**Note:** The `bounds` payload is only implemented on OS X and Windows.
### Event: 'right-click' _OS X_ _Windows_

View file

@ -25,7 +25,7 @@ appropriate cache directory on your machine.
The Windbg symbol path is configured with a string value delimited with asterisk
characters. To use only the Electron symbol server, add the following entry to
your symbol path (__Note:__ you can replace `c:\code\symbols` with any writable
your symbol path (**Note:** you can replace `c:\code\symbols` with any writable
directory on your computer, if you'd prefer a different location for downloaded
symbols):

View file

@ -19,7 +19,7 @@ Like `--debug` but pauses the script on the first line.
## Use node-inspector for Debugging
__Note:__ Electron doesn't currently work very well
**Note:** Electron doesn't currently work very well
with node-inspector, and the main process will crash if you inspect the
`process` object under node-inspector's console.

View file

@ -15,7 +15,7 @@ to the user. Electron conveniently allows developers to send notifications with
the [HTML5 Notification API](https://notifications.spec.whatwg.org/), using
the currently running operating system's native notification APIs to display it.
__Note:__ Since this is an HTML5 API it is only available in the renderer process.
**Note:** Since this is an HTML5 API it is only available in the renderer process.
```javascript
var myNotification = new Notification('Title', {

View file

@ -4,11 +4,11 @@ Since v0.34.0, Electron allows submitting packaged apps to the Mac App Store
(MAS). This guide provides information on: how to submit your app and the
limitations of the MAS build.
__Note:__ From v0.36.0 there was a bug preventing GPU process to start after
**Note:** From v0.36.0 there was a bug preventing GPU process to start after
the app being sandboxed, so it is recommended to use v0.35.x before this bug
gets fixed. You can find more about this in [issue #3871][issue-3871].
__Note:__ Submitting an app to Mac App Store requires enrolling [Apple Developer
**Note:** Submitting an app to Mac App Store requires enrolling [Apple Developer
Program][developer-program], which costs money.
## How to Submit Your App

View file

@ -8,7 +8,7 @@ Electron doesn't ship with the Widevine CDM plugin for license reasons, to get
it, you need to install the official Chrome browser first, which should match
the architecture and Chrome version of the Electron build you use.
__Note:__ The major version of Chrome browser has to be the same with the Chrome
**Note:** The major version of Chrome browser has to be the same with the Chrome
version used by Electron, otherwise the plugin will not work even though
`navigator.plugins` would show it has been loaded.
@ -41,7 +41,7 @@ After getting the plugin files, you should pass the `widevinecdmadapter`'s path
to Electron with `--widevine-cdm-path` command line switch, and the plugin's
version with `--widevine-cdm-version` switch.
__Note:__ Though only the `widevinecdmadapter` binary is passed to Electron, the
**Note:** Though only the `widevinecdmadapter` binary is passed to Electron, the
`widevinecdm` binary has to be put aside it.
The command line switches have to be passed before the `ready` event of `app`