Restructure the docs to put more tutorials.
This commit is contained in:
parent
a85db2d780
commit
f7cf3ad867
4 changed files with 10 additions and 17 deletions
|
@ -1,9 +1,9 @@
|
||||||
# Atom-Shell Documentations
|
# Atom-Shell Documentations
|
||||||
|
|
||||||
## Guides
|
## Tutorials
|
||||||
|
|
||||||
* [Quick start](quick-start.md)
|
* [Quick start](tutorial/quick-start.md)
|
||||||
* [Use native modules](use-native-modules.md)
|
* [Use native node modules](tutorial/use-native-node-modules.md)
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
|
|
|
@ -113,14 +113,8 @@ window.onbeforeunload = function(e) {
|
||||||
|
|
||||||
### Event: 'closed'
|
### Event: 'closed'
|
||||||
|
|
||||||
Emitted when the window is closed. At the time of this event, window is not
|
Emitted when the window is closed. After you have received this event you should
|
||||||
destroyed yet so you can still do some operations to the window (but you
|
remove the reference to the window and avoid using it anymore.
|
||||||
shouldn't!).
|
|
||||||
|
|
||||||
### Event: 'destroyed'
|
|
||||||
|
|
||||||
Emitted when the memory taken by the native window is released. Usually you
|
|
||||||
should dereference the javascript object when received this event.
|
|
||||||
|
|
||||||
### Event: 'unresponsive'
|
### Event: 'unresponsive'
|
||||||
|
|
||||||
|
@ -159,12 +153,11 @@ Get the `WebContents` of devtools of this window.
|
||||||
|
|
||||||
### BrowserWindow.destroy()
|
### BrowserWindow.destroy()
|
||||||
|
|
||||||
Destroy the window and free the memory without closing it.
|
Force closing the window, the `unload` and `beforeunload` event won't be emitted
|
||||||
|
for the web page, and `close` event would also not be emitted for this window,
|
||||||
|
but it would gurrantee the `closed` event to be emitted.
|
||||||
|
|
||||||
**Note:** Usually you should always call `Window.close()` to close the window,
|
You should only use this method when the web page has crashed.
|
||||||
**which will emit `beforeunload` and `unload` events for DOM. Only use
|
|
||||||
**`Window.destroy()` when the window gets into a very bad state and you want
|
|
||||||
**to force closing it.
|
|
||||||
|
|
||||||
### BrowserWindow.close()
|
### BrowserWindow.close()
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Use native modules
|
# Use native node modules
|
||||||
|
|
||||||
Since atom-shell is using a different V8 version from the official node, you
|
Since atom-shell is using a different V8 version from the official node, you
|
||||||
need to build native module against atom-shell's headers to use them.
|
need to build native module against atom-shell's headers to use them.
|
Loading…
Reference in a new issue