From fdcad1066e48698c716d98cba5b32cafd50d8dbf Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 20 Aug 2014 10:53:20 +0800 Subject: [PATCH] docs: Fix typos. --- docs/api/chrome-command-line-switches.md | 10 +++++----- docs/api/tray.md | 2 +- docs/api/web-security.md | 4 ++-- docs/tutorial/debugging-browser-process.md | 10 +++++----- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/api/chrome-command-line-switches.md b/docs/api/chrome-command-line-switches.md index e374398cc9ae..ad0549ddbc09 100644 --- a/docs/api/chrome-command-line-switches.md +++ b/docs/api/chrome-command-line-switches.md @@ -1,8 +1,8 @@ # Supported Chrome command line switches Following command lines switches in Chrome browser are also Supported in -atom-shell, 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) +atom-shell, 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 emitted: ```javascript @@ -40,6 +40,6 @@ connection, and the endpoint host in a `SOCKS` proxy connection). Like `--host-rules` but these `rules` only apply to the host resolver. -[app](app.md) -[append-switch](app.md#appcommandlineappendswitchswitch-value) -[ready](app.md##event-ready) +[app]: app.md +[append-switch]: app.md#appcommandlineappendswitchswitch-value +[ready]: app.md#event-ready diff --git a/docs/api/tray.md b/docs/api/tray.md index ebdeae3d0dcc..c72963e26c32 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -36,7 +36,7 @@ rely on `clicked` event and always attach a context menu to the tray icon. ## Class: Tray -`Tray` is an [EventEmitter](event-emitter). +`Tray` is an [EventEmitter][event-emitter]. ### new Tray(image) diff --git a/docs/api/web-security.md b/docs/api/web-security.md index fa78342dd1de..cdff3bc41ebd 100644 --- a/docs/api/web-security.md +++ b/docs/api/web-security.md @@ -7,7 +7,7 @@ convenient. ## Overriding `X-Frame-Options` header May websites (including Google and Youtube) use the -[X-Frame-Options](x-frame-options) header to disable access to their websites +[X-Frame-Options][x-frame-options] header to disable access to their websites in `iframe`s. In atom-shell you can add a `disable-x-frame-options` string in the `iframe`'s name to disable this: @@ -59,4 +59,4 @@ An example of enable node integration in `iframe` with `node-integration` set to ``` -[x-frame-options](https://developer.mozilla.org/en-US/docs/Web/HTTP/X-Frame-Options) +[x-frame-options]: https://developer.mozilla.org/en-US/docs/Web/HTTP/X-Frame-Options diff --git a/docs/tutorial/debugging-browser-process.md b/docs/tutorial/debugging-browser-process.md index 34957312b0d3..bdfb8323faf9 100644 --- a/docs/tutorial/debugging-browser-process.md +++ b/docs/tutorial/debugging-browser-process.md @@ -9,10 +9,10 @@ the browser side (e.g. the browser process), atom-shell has provided the ### `--debug=[port]` -When this switch is used atom-shell would listen for V8 debugger protocol on -`port`, the `port` is `5858` by default. +When this switch is used atom-shell would listen for V8 debugger protocol +messages on `port`, the `port` is `5858` by default. -### `debug-brk=[port]` +### `--debug-brk=[port]` Like `--debug` but pauses the script on the first line. @@ -22,7 +22,7 @@ __Note:__ Atom Shell uses node v0.11.13, which currently doesn't work very well with node-inspector, and the browser process would crash if you inspect the `process` object under node-inspector's console. -### 1. Start the [node-inspector](node-inspector) server +### 1. Start the [node-inspector][node-inspector] server ```bash $ node-inspector @@ -46,4 +46,4 @@ $ atom-shell --debug-brk your/app Open http://127.0.0.1:8080/debug?port=5858 in the Chrome browser. -[node-inspector](https://github.com/node-inspector/node-inspector) +[node-inspector]: https://github.com/node-inspector/node-inspector