Update docs for new org
This commit is contained in:
parent
5ffa30a563
commit
102f7e8e33
64 changed files with 88 additions and 88 deletions
|
@ -38,7 +38,7 @@ var win = new BrowserWindow({ transparent: true, frame: false });
|
|||
### Limitations
|
||||
|
||||
* You can not click through the transparent area. We are going to introduce an
|
||||
API to set window shape to solve this, see [our issue](https://github.com/atom/electron/issues/1335) for details.
|
||||
API to set window shape to solve this, see [our issue](https://github.com/electron/electron/issues/1335) for details.
|
||||
* Transparent windows are not resizable. Setting `resizable` to `true` may make
|
||||
a transparent window stop working on some platforms.
|
||||
* The `blur` filter only applies to the web page, so there is no way to apply
|
||||
|
|
|
@ -387,4 +387,4 @@ Menu:
|
|||
```
|
||||
|
||||
[AboutInformationPropertyListFiles]: https://developer.apple.com/library/ios/documentation/general/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html
|
||||
[setMenu]: https://github.com/atom/electron/blob/master/docs/api/browser-window.md#winsetmenumenu-linux-windows
|
||||
[setMenu]: https://github.com/electron/electron/blob/master/docs/api/browser-window.md#winsetmenumenu-linux-windows
|
||||
|
|
|
@ -80,4 +80,4 @@ require('electron').hideInternalModules()
|
|||
|
||||
[gui]: https://en.wikipedia.org/wiki/Graphical_user_interface
|
||||
[destructuring-assignment]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment
|
||||
[issue-387]: https://github.com/atom/electron/issues/387
|
||||
[issue-387]: https://github.com/electron/electron/issues/387
|
||||
|
|
|
@ -47,4 +47,4 @@ By using the [multi-context](http://strongloop.com/strongblog/whats-new-node-js-
|
|||
feature of Node, Electron doesn't introduce a new JavaScript context in web
|
||||
pages.
|
||||
|
||||
[node-bindings]: https://github.com/atom/electron/tree/master/atom/common
|
||||
[node-bindings]: https://github.com/electron/electron/tree/master/atom/common
|
||||
|
|
|
@ -41,7 +41,7 @@ device container of at least 25 gigabytes in size.
|
|||
## Getting the Code
|
||||
|
||||
```bash
|
||||
$ git clone https://github.com/atom/electron.git
|
||||
$ git clone https://github.com/electron/electron.git
|
||||
```
|
||||
|
||||
## Bootstrapping
|
||||
|
|
|
@ -16,7 +16,7 @@ following python modules:
|
|||
## Getting the Code
|
||||
|
||||
```bash
|
||||
$ git clone https://github.com/atom/electron.git
|
||||
$ git clone https://github.com/electron/electron.git
|
||||
```
|
||||
|
||||
## Bootstrapping
|
||||
|
|
|
@ -27,7 +27,7 @@ building with Visual Studio will come in the future.
|
|||
## Getting the Code
|
||||
|
||||
```powershell
|
||||
$ git clone https://github.com/atom/electron.git
|
||||
$ git clone https://github.com/electron/electron.git
|
||||
```
|
||||
|
||||
## Bootstrapping
|
||||
|
@ -84,7 +84,7 @@ $ python script\test.py
|
|||
```
|
||||
|
||||
Tests that include native modules (e.g. `runas`) can't be executed with the
|
||||
debug build (see [#2558](https://github.com/atom/electron/issues/2558) for
|
||||
debug build (see [#2558](https://github.com/electron/electron/issues/2558) for
|
||||
details), but they will work with the release build.
|
||||
|
||||
To run the tests with the release build use:
|
||||
|
|
|
@ -44,4 +44,4 @@ etc.
|
|||
When creating a new API, we should prefer getters and setters instead of
|
||||
jQuery's one-function style. For example, `.getText()` and `.setText(text)`
|
||||
are preferred to `.text([text])`. There is a
|
||||
[discussion](https://github.com/atom/electron/issues/46) on this.
|
||||
[discussion](https://github.com/electron/electron/issues/46) on this.
|
||||
|
|
|
@ -40,7 +40,7 @@ To add another set (or partial set):
|
|||
- Translate the files.
|
||||
- Update the `README.md` within your language directory to link to the files
|
||||
you have translated.
|
||||
- Add a link to your translation directory on the main Electron [README](https://github.com/atom/electron#documentation-translations).
|
||||
- Add a link to your translation directory on the main Electron [README](https://github.com/electron/electron#documentation-translations).
|
||||
|
||||
## Reading Electron Documentation
|
||||
|
||||
|
|
|
@ -8,7 +8,7 @@ the `BrowserWindow.addDevToolsExtension` API to load them. The loaded extensions
|
|||
will be remembered so you don't need to call the API every time when creating
|
||||
a window.
|
||||
|
||||
** NOTE: React DevTools does not work, follow the issue here https://github.com/atom/electron/issues/915 **
|
||||
** NOTE: React DevTools does not work, follow the issue here https://github.com/electron/electron/issues/915 **
|
||||
|
||||
For example, to use the [React DevTools Extension](https://github.com/facebook/react-devtools)
|
||||
, first you need to download its source code:
|
||||
|
|
|
@ -163,5 +163,5 @@ ERN)][ern-tutorial].
|
|||
[create-record]: https://developer.apple.com/library/ios/documentation/LanguagesUtilities/Conceptual/iTunesConnect_Guide/Chapters/CreatingiTunesConnectRecord.html
|
||||
[submit-for-review]: https://developer.apple.com/library/ios/documentation/LanguagesUtilities/Conceptual/iTunesConnect_Guide/Chapters/SubmittingTheApp.html
|
||||
[app-sandboxing]: https://developer.apple.com/app-sandboxing/
|
||||
[issue-3871]: https://github.com/atom/electron/issues/3871
|
||||
[issue-3871]: https://github.com/electron/electron/issues/3871
|
||||
[ern-tutorial]: https://carouselapps.com/2015/12/15/legally-submit-app-apples-app-store-uses-encryption-obtain-ern/
|
||||
|
|
|
@ -184,7 +184,7 @@ $ ./Electron.app/Contents/MacOS/Electron your-app/
|
|||
```
|
||||
|
||||
`Electron.app` here is part of the Electron's release package, you can download
|
||||
it from [here](https://github.com/atom/electron/releases).
|
||||
it from [here](https://github.com/electron/electron/releases).
|
||||
|
||||
### Run as a distribution
|
||||
|
||||
|
@ -194,14 +194,14 @@ and then executing the packaged app.
|
|||
|
||||
### Try this Example
|
||||
|
||||
Clone and run the code in this tutorial by using the [`atom/electron-quick-start`](https://github.com/atom/electron-quick-start)
|
||||
Clone and run the code in this tutorial by using the [`atom/electron-quick-start`](https://github.com/electron/electron-quick-start)
|
||||
repository.
|
||||
|
||||
**Note**: Running this requires [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which includes [npm](https://npmjs.org)) on your system.
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
$ git clone https://github.com/atom/electron-quick-start
|
||||
$ git clone https://github.com/electron/electron-quick-start
|
||||
# Go into the repository
|
||||
$ cd electron-quick-start
|
||||
# Install dependencies and run the app
|
||||
|
|
|
@ -10,8 +10,8 @@ Native modules might break when Node starts using a new version of V8.
|
|||
To make sure the module you're interested in will work with Electron, you should
|
||||
check if it supports the internal Node version used by Electron.
|
||||
You can check what version of Node is used in Electron by looking it up in
|
||||
the [releases](https://github.com/atom/electron/releases) page or by using
|
||||
`process.version` (see [Quick Start](https://github.com/atom/electron/blob/master/docs/tutorial/quick-start.md)
|
||||
the [releases](https://github.com/electron/electron/releases) page or by using
|
||||
`process.version` (see [Quick Start](https://github.com/electron/electron/blob/master/docs/tutorial/quick-start.md)
|
||||
for example).
|
||||
|
||||
Consider using [NAN](https://github.com/nodejs/nan/) for your own modules, since
|
||||
|
|
|
@ -122,7 +122,7 @@ client
|
|||
## Workflow
|
||||
|
||||
To test your application without rebuilding Electron, simply
|
||||
[place](https://github.com/atom/electron/blob/master/docs/tutorial/application-distribution.md)
|
||||
[place](https://github.com/electron/electron/blob/master/docs/tutorial/application-distribution.md)
|
||||
your app source into Electron's resource directory.
|
||||
|
||||
Alternatively, pass an argument to run with your electron binary that points to
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue