doc: Separate pages into sub directories.

This commit is contained in:
Cheng Zhao 2013-09-09 15:49:13 +08:00
parent 6b81070f67
commit 92241b91ce
21 changed files with 20 additions and 20 deletions

View file

@ -0,0 +1,38 @@
# clipboard
An example of writing a string to clipboard:
```javascript
var clipboard = require('clipboard');
clipboard.writeText('Example String');
```
## clipboard.readText()
Returns the content in clipboard as plain text.
## clipboard.writeText(text)
* `text` String
Writes the `text` into clipboard as plain text.
## clipboard.clear()
Clears everything in clipboard.
## clipboard.has(type)
* `type` String
Returns whether clipboard has data in specified `type`.
**Note:** This API is experimental and could be removed in future.
## clipboard.read(type)
* `type` String
Reads the data in clipboard of the `type`.
**Note:** This API is experimental and could be removed in future.

39
docs/api/common/shell.md Normal file
View file

@ -0,0 +1,39 @@
# shell
The `shell` module provides functions related to desktop integration.
An example of opening a URL in default browser:
```javascript
var shell = require('shell');
shell.openExternal('https://github.com');
```
## shell.showItemInFolder(fullPath)
* `fullPath` String
Show the given file in a file manager. If possible, select the file.
## shell.openItem(fullPath)
* `fullPath` String
Open the given file in the desktop's default manner.
## shell.openExternal(url)
* `url` String
Open the given external protocol URL in the desktop's default manner. (For
example, mailto: URLs in the default mail user agent.)
## shell.moveItemToTrash(fullPath)
* `fullPath` String
Move the given file to trash.
## shell.beep()
Play the beep sound.