📝 Simpilify the structure of API references.

This commit is contained in:
Cheng Zhao 2014-05-05 14:24:57 +08:00
parent fae3cf9a55
commit 5933947000
19 changed files with 26 additions and 26 deletions

View file

@ -1,4 +1,4 @@
# Atom Shell Documentations
# Atom Shell documents
## Tutorials
@ -14,28 +14,28 @@
* [Build instructions (Windows)](development/build-instructions-windows.md)
* [Build instructions (Linux)](development/build-instructions-linux.md)
## API References
Renderer side modules:
* [ipc (renderer)](api/renderer/ipc-renderer.md)
* [remote](api/renderer/remote.md)
## API references
Browser side modules:
* [app](api/browser/app.md)
* [auto-updater](api/browser/auto-updater.md)
* [browser-window](api/browser/browser-window.md)
* [dialog](api/browser/dialog.md)
* [ipc (browser)](api/browser/ipc-browser.md)
* [menu](api/browser/menu.md)
* [menu-item](api/browser/menu-item.md)
* [power-monitor](api/browser/power-monitor.md)
* [protocol](api/browser/protocol.md)
* [app](api/app.md)
* [auto-updater](api/auto-updater.md)
* [browser-window](api/browser-window.md)
* [dialog](api/dialog.md)
* [ipc (browser)](api/ipc-browser.md)
* [menu](api/menu.md)
* [menu-item](api/menu-item.md)
* [power-monitor](api/power-monitor.md)
* [protocol](api/protocol.md)
Renderer side modules:
* [ipc (renderer)](api/ipc-renderer.md)
* [remote](api/remote.md)
Common modules:
* [clipboard](api/common/clipboard.md)
* [crash-reporter](api/common/crash-reporter.md)
* [screen](api/common/screen.md)
* [shell](api/common/shell.md)
* [clipboard](api/clipboard.md)
* [crash-reporter](api/crash-reporter.md)
* [screen](api/screen.md)
* [shell](api/shell.md)

View file

@ -346,7 +346,7 @@ You can write received `image` directly to a `.png` file, or you can base64
encode it and use data URL to embed the image in HTML.
**Note:** Be sure to read documents on remote buffer in
[remote](../renderer/remote.md) if you are going to use this API in renderer
[remote](remote.md) if you are going to use this API in renderer
process.
### BrowserWindow.loadUrl(url)

View file

@ -5,7 +5,7 @@ asynchronous messages to the browser, and also receive messages sent from
browser. If you want to make use of modules of browser from renderer, you
might consider using the [remote](remote.md) module.
See [ipc (browser)](../browser/ipc-browser.md) for examples.
See [ipc (browser)](ipc-browser.md) for examples.
## ipc.send(channel[, args...])

View file

@ -136,7 +136,7 @@ Returns the object returned by `require(module)` in the browser process.
## remote.getCurrentWindow()
Returns the [BrowserWindow](../browser/browser-window.md) object which
Returns the [BrowserWindow](browser-window.md) object which
represents current window.
## remote.getGlobal(name)

View file

@ -26,8 +26,8 @@ scripts.
In traditional node.js applications, communication between server side and
client side are usually done by web sockets. In atom-shell, we have provided
the [ipc](../api/renderer/ipc-renderer.md) module for browser side to client
communication, and the [remote](../api/renderer/remote.md) module for easy RPC
the [ipc](../api/ipc-renderer.md) module for browser side to client
communication, and the [remote](../api/remote.md) module for easy RPC
support.
### Web page and node.js
@ -39,7 +39,7 @@ in web pages so you could access native resources in web pages, just like
But unlike node-webkit, you could not do native GUI related operations in web
pages, instead you need to do them on the browser side by sending messages or
use the easy [remote](../api/renderer/remote.md) module.
use the easy [remote](../api/remote.md) module.
## Write your first atom-shell app