docs: use relative links within docs (#29651)
This commit is contained in:
parent
86ff4a9836
commit
7019713126
5 changed files with 8 additions and 8 deletions
|
@ -698,7 +698,7 @@ Overrides the current application's name.
|
||||||
Returns `String` - The current application locale, fetched using Chromium's `l10n_util` library.
|
Returns `String` - The current application locale, fetched using Chromium's `l10n_util` library.
|
||||||
Possible return values are documented [here](https://source.chromium.org/chromium/chromium/src/+/master:ui/base/l10n/l10n_util.cc).
|
Possible return values are documented [here](https://source.chromium.org/chromium/chromium/src/+/master:ui/base/l10n/l10n_util.cc).
|
||||||
|
|
||||||
To set the locale, you'll want to use a command line switch at app startup, which may be found [here](https://github.com/electron/electron/blob/master/docs/api/command-line-switches.md).
|
To set the locale, you'll want to use a command line switch at app startup, which may be found [here](command-line-switches.md).
|
||||||
|
|
||||||
**Note:** When distributing your packaged app, you have to also ship the
|
**Note:** When distributing your packaged app, you have to also ship the
|
||||||
`locales` folder.
|
`locales` folder.
|
||||||
|
|
|
@ -405,4 +405,4 @@ Menu:
|
||||||
```
|
```
|
||||||
|
|
||||||
[AboutInformationPropertyListFiles]: https://developer.apple.com/library/ios/documentation/general/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html
|
[AboutInformationPropertyListFiles]: https://developer.apple.com/library/ios/documentation/general/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html
|
||||||
[setMenu]: https://github.com/electron/electron/blob/master/docs/api/browser-window.md#winsetmenumenu-linux-windows
|
[setMenu]: browser-window.md#winsetmenumenu-linux-windows
|
||||||
|
|
|
@ -33,7 +33,7 @@ For more detailed information see [#18397](https://github.com/electron/electron/
|
||||||
|
|
||||||
The optional parameter `frameName` will no longer set the title of the window. This now follows the specification described by the [native documentation](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#parameters) under the corresponding parameter `windowName`.
|
The optional parameter `frameName` will no longer set the title of the window. This now follows the specification described by the [native documentation](https://developer.mozilla.org/en-US/docs/Web/API/Window/open#parameters) under the corresponding parameter `windowName`.
|
||||||
|
|
||||||
If you were using this parameter to set the title of a window, you can instead use [win.setTitle(title)](https://www.electronjs.org/docs/api/browser-window#winsettitletitle).
|
If you were using this parameter to set the title of a window, you can instead use [win.setTitle(title)](api/browser-window.md#winsettitletitle).
|
||||||
|
|
||||||
### Removed: `worldSafeExecuteJavaScript`
|
### Removed: `worldSafeExecuteJavaScript`
|
||||||
|
|
||||||
|
@ -246,7 +246,7 @@ value.
|
||||||
In Electron 12, `contextIsolation` will be enabled by default. To restore
|
In Electron 12, `contextIsolation` will be enabled by default. To restore
|
||||||
the previous behavior, `contextIsolation: false` must be specified in WebPreferences.
|
the previous behavior, `contextIsolation: false` must be specified in WebPreferences.
|
||||||
|
|
||||||
We [recommend having contextIsolation enabled](https://github.com/electron/electron/blob/master/docs/tutorial/security.md#3-enable-context-isolation-for-remote-content) for the security of your application.
|
We [recommend having contextIsolation enabled](tutorial/security.md#3-enable-context-isolation-for-remote-content) for the security of your application.
|
||||||
|
|
||||||
Another implication is that `require()` cannot be used in the renderer process unless
|
Another implication is that `require()` cannot be used in the renderer process unless
|
||||||
`nodeIntegration` is `true` and `contextIsolation` is `false`.
|
`nodeIntegration` is `true` and `contextIsolation` is `false`.
|
||||||
|
@ -809,7 +809,7 @@ In Electron 7, this now returns a `FileList` with a `File` object for:
|
||||||
|
|
||||||
Note that `webkitdirectory` no longer exposes the path to the selected folder.
|
Note that `webkitdirectory` no longer exposes the path to the selected folder.
|
||||||
If you require the path to the selected folder rather than the folder contents,
|
If you require the path to the selected folder rather than the folder contents,
|
||||||
see the `dialog.showOpenDialog` API ([link](https://github.com/electron/electron/blob/master/docs/api/dialog.md#dialogshowopendialogbrowserwindow-options)).
|
see the `dialog.showOpenDialog` API ([link](api/dialog.md#dialogshowopendialogbrowserwindow-options)).
|
||||||
|
|
||||||
### API Changed: Callback-based versions of promisified APIs
|
### API Changed: Callback-based versions of promisified APIs
|
||||||
|
|
||||||
|
|
|
@ -45,7 +45,7 @@ Here is a pre-configured project that you can download and directly debug in VSC
|
||||||
|
|
||||||
If you want to build Electron from source and modify the native Electron codebase, this section will help you in testing your modifications.
|
If you want to build Electron from source and modify the native Electron codebase, this section will help you in testing your modifications.
|
||||||
|
|
||||||
For those unsure where to acquire this code or how to build it, [Electron's Build Tools](https://github.com/electron/build-tools) automates and explains most of this process. If you wish to manually set up the environment, you can instead use these [build instructions](https://www.electronjs.org/docs/development/build-instructions-gn).
|
For those unsure where to acquire this code or how to build it, [Electron's Build Tools](https://github.com/electron/build-tools) automates and explains most of this process. If you wish to manually set up the environment, you can instead use these [build instructions](../development/build-instructions-gn.md).
|
||||||
|
|
||||||
### Windows (C++)
|
### Windows (C++)
|
||||||
|
|
||||||
|
@ -89,7 +89,7 @@ $ code electron-quick-start
|
||||||
* `cppvsdbg` requires the [built-in C/C++ extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) be enabled.
|
* `cppvsdbg` requires the [built-in C/C++ extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) be enabled.
|
||||||
* `${workspaceFolder}` is the full path to Chromium's `src` directory.
|
* `${workspaceFolder}` is the full path to Chromium's `src` directory.
|
||||||
* `your-executable-location` will be one of the following depending on a few items:
|
* `your-executable-location` will be one of the following depending on a few items:
|
||||||
* `Testing`: If you are using the default settings of [Electron's Build-Tools](https://github.com/electron/build-tools) or the default instructions when [building from source](https://www.electronjs.org/docs/development/build-instructions-gn#building).
|
* `Testing`: If you are using the default settings of [Electron's Build-Tools](https://github.com/electron/build-tools) or the default instructions when [building from source](../development/build-instructions-gn.md#building).
|
||||||
* `Release`: If you built a Release build rather than a Testing build.
|
* `Release`: If you built a Release build rather than a Testing build.
|
||||||
* `your-directory-name`: If you modified this during your build process from the default, this will be whatever you specified.
|
* `your-directory-name`: If you modified this during your build process from the default, this will be whatever you specified.
|
||||||
* The `args` array string `"your-electron-project-path"` should be the absolute path to either the directory or `main.js` file of the Electron project you are using for testing. In this example, it should be your path to `electron-quick-start`.
|
* The `args` array string `"your-electron-project-path"` should be the absolute path to either the directory or `main.js` file of the Electron project you are using for testing. In this example, it should be your path to `electron-quick-start`.
|
||||||
|
|
|
@ -162,7 +162,7 @@ client
|
||||||
## Workflow
|
## Workflow
|
||||||
|
|
||||||
To test your application without rebuilding Electron,
|
To test your application without rebuilding Electron,
|
||||||
[place](https://github.com/electron/electron/blob/master/docs/tutorial/application-distribution.md)
|
[place](application-distribution.md)
|
||||||
your app source into Electron's resource directory.
|
your app source into Electron's resource directory.
|
||||||
|
|
||||||
Alternatively, pass an argument to run with your Electron binary that points to
|
Alternatively, pass an argument to run with your Electron binary that points to
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue