mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

docs: update links (#36657)

Browse source
This commit is contained in:
David Sanders 2023-01-02 02:52:18 -08:00 • committed by GitHub
parent 20ac617c03
commit 20cff64282
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/README.md
View file

@ -42,7 +42,7 @@ an issue:
* [Web embeds in Electron](tutorial/web-embeds.md) * [Web embeds in Electron](tutorial/web-embeds.md)
* [Boilerplates and CLIs](tutorial/boilerplates-and-clis.md) * [Boilerplates and CLIs](tutorial/boilerplates-and-clis.md)
* [Boilerplate vs CLI](tutorial/boilerplates-and-clis.md#boilerplate-vs-cli) * [Boilerplate vs CLI](tutorial/boilerplates-and-clis.md#boilerplate-vs-cli)
* [electron-forge](tutorial/boilerplates-and-clis.md#electron-forge) * [Electron Forge](tutorial/boilerplates-and-clis.md#electron-forge)
* [electron-builder](tutorial/boilerplates-and-clis.md#electron-builder) * [electron-builder](tutorial/boilerplates-and-clis.md#electron-builder)
* [electron-react-boilerplate](tutorial/boilerplates-and-clis.md#electron-react-boilerplate) * [electron-react-boilerplate](tutorial/boilerplates-and-clis.md#electron-react-boilerplate)
* [Other Tools and Boilerplates](tutorial/boilerplates-and-clis.md#other-tools-and-boilerplates) * [Other Tools and Boilerplates](tutorial/boilerplates-and-clis.md#other-tools-and-boilerplates)

6
docs/api/auto-updater.md
View file

@ -32,9 +32,9 @@ This is a requirement of `Squirrel.Mac`.
On Windows, you have to install your app into a user's machine before you can On Windows, you have to install your app into a user's machine before you can
use the `autoUpdater`, so it is recommended that you use the use the `autoUpdater`, so it is recommended that you use the
[electron-winstaller][installer-lib], [electron-forge][electron-forge-lib] or the [grunt-electron-installer][installer] package to generate a Windows installer. [electron-winstaller][installer-lib], [Electron Forge][electron-forge-lib] or the [grunt-electron-installer][installer] package to generate a Windows installer.
When using [electron-winstaller][installer-lib] or [electron-forge][electron-forge-lib] make sure you do not try to update your app [the first time it runs](https://github.com/electron/windows-installer#handling-squirrel-events) (Also see [this issue for more info](https://github.com/electron/electron/issues/7155)). It's also recommended to use [electron-squirrel-startup](https://github.com/mongodb-js/electron-squirrel-startup) to get desktop shortcuts for your app. When using [electron-winstaller][installer-lib] or [Electron Forge][electron-forge-lib] make sure you do not try to update your app [the first time it runs](https://github.com/electron/windows-installer#handling-squirrel-events) (Also see [this issue for more info](https://github.com/electron/electron/issues/7155)). It's also recommended to use [electron-squirrel-startup](https://github.com/mongodb-js/electron-squirrel-startup) to get desktop shortcuts for your app.
The installer generated with Squirrel will create a shortcut icon with an The installer generated with Squirrel will create a shortcut icon with an
[Application User Model ID][app-user-model-id] in the format of [Application User Model ID][app-user-model-id] in the format of
@ -139,6 +139,6 @@ application starts.
[squirrel-windows]: https://github.com/Squirrel/Squirrel.Windows [squirrel-windows]: https://github.com/Squirrel/Squirrel.Windows
[installer]: https://github.com/electron/grunt-electron-installer [installer]: https://github.com/electron/grunt-electron-installer
[installer-lib]: https://github.com/electron/windows-installer [installer-lib]: https://github.com/electron/windows-installer
[electron-forge-lib]: https://github.com/electron-userland/electron-forge [electron-forge-lib]: https://github.com/electron/forge
[app-user-model-id]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx [app-user-model-id]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx
[event-emitter]: https://nodejs.org/api/events.html#events_class_eventemitter [event-emitter]: https://nodejs.org/api/events.html#events_class_eventemitter

2
docs/api/utility-process.md
View file

@ -132,7 +132,7 @@ Returns:
Emitted when the child process sends a message using [`process.parentPort.postMessage()`](process.md#processparentport). Emitted when the child process sends a message using [`process.parentPort.postMessage()`](process.md#processparentport).
[`child_process.fork`]: https://nodejs.org/dist/latest-v16.x/docs/api/child_process.html#child_processforkmodulepath-args-options [`child_process.fork`]: https://nodejs.org/dist/latest-v16.x/docs/api/child_process.html#child_processforkmodulepath-args-options
[Services API]: https://chromium.googlesource.com/chromium/src/+/master/docs/mojo_and_services.md [Services API]: https://chromium.googlesource.com/chromium/src/+/main/docs/mojo_and_services.md
[stdio]: https://nodejs.org/dist/latest/docs/api/child_process.html#optionsstdio [stdio]: https://nodejs.org/dist/latest/docs/api/child_process.html#optionsstdio
[event-emitter]: https://nodejs.org/api/events.html#events_class_eventemitter [event-emitter]: https://nodejs.org/api/events.html#events_class_eventemitter
[`MessagePortMain`]: message-port-main.md [`MessagePortMain`]: message-port-main.md

2
docs/tutorial/boilerplates-and-clis.md
View file

@ -24,7 +24,7 @@ development and release. They are more helpful and supportive but enforce
guidelines on how your code should be structured and built. *Especially for guidelines on how your code should be structured and built. *Especially for
beginners, using a command line tool is likely to be helpful*. beginners, using a command line tool is likely to be helpful*.
## electron-forge ## Electron Forge
Electron Forge is a tool for packaging and publishing Electron applications. It unifies Electron's tooling ecosystem Electron Forge is a tool for packaging and publishing Electron applications. It unifies Electron's tooling ecosystem
into a single extensible interface so that anyone can jump right into making Electron apps. into a single extensible interface so that anyone can jump right into making Electron apps.

2
docs/tutorial/forge-overview.md
View file

@ -31,6 +31,6 @@ template and submit a new issue.
[(package)]: https://www.electronforge.io/cli#package [(package)]: https://www.electronforge.io/cli#package
[(make)]: https://www.electronforge.io/cli#make [(make)]: https://www.electronforge.io/cli#make
[(publish)]: https://www.electronforge.io/cli#publish [(publish)]: https://www.electronforge.io/cli#publish
[GitHub issue tracker]: https://github.com/electron-userland/electron-forge/issues [GitHub issue tracker]: https://github.com/electron/forge/issues
[discord]: https://discord.gg/APGC3k5yaH [discord]: https://discord.gg/APGC3k5yaH
[tutorial]: https://www.electronjs.org/docs/latest/tutorial/tutorial-prerequisites [tutorial]: https://www.electronjs.org/docs/latest/tutorial/tutorial-prerequisites

2
docs/tutorial/notifications.md
View file

@ -138,4 +138,4 @@ GNOME, KDE.
[notification-spec]: https://developer-old.gnome.org/notification-spec/ [notification-spec]: https://developer-old.gnome.org/notification-spec/
[app-user-model-id]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx [app-user-model-id]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx
[set-app-user-model-id]: ../api/app.md#appsetappusermodelidid-windows [set-app-user-model-id]: ../api/app.md#appsetappusermodelidid-windows
[squirrel-events]: https://github.com/electron/windows-installer/blob/master/README.md#handling-squirrel-events [squirrel-events]: https://github.com/electron/windows-installer/blob/main/README.md#handling-squirrel-events

2
docs/tutorial/performance.md
View file

@ -438,7 +438,7 @@ Call `Menu.setApplicationMenu(null)` before `app.on("ready")`. This will prevent
[request-idle-callback]: https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback [request-idle-callback]: https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback
[multithreading]: ./multithreading.md [multithreading]: ./multithreading.md
[caniuse]: https://caniuse.com/ [caniuse]: https://caniuse.com/
[jquery-need]: http://youmightnotneedjquery.com/ [jquery-need]: https://youmightnotneedjquery.com/
[service-workers]: https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API [service-workers]: https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API
[webpack]: https://webpack.js.org/ [webpack]: https://webpack.js.org/
[parcel]: https://parceljs.org/ [parcel]: https://parceljs.org/

6
docs/tutorial/snapcraft.md
View file

@ -13,7 +13,7 @@ system modification.
There are three ways to create a `.snap` file: There are three ways to create a `.snap` file:
1) Using [`electron-forge`][electron-forge] or 1) Using [Electron Forge][electron-forge] or
[`electron-builder`][electron-builder], both tools that come with `snap` [`electron-builder`][electron-builder], both tools that come with `snap`
support out of the box. This is the easiest option. support out of the box. This is the easiest option.
2) Using `electron-installer-snap`, which takes `electron-packager`'s output. 2) Using `electron-installer-snap`, which takes `electron-packager`'s output.
@ -162,7 +162,7 @@ building blocks.
If you do not already have a `.deb` package, using `electron-installer-snap` If you do not already have a `.deb` package, using `electron-installer-snap`
might be an easier path to create snap packages. However, multiple solutions might be an easier path to create snap packages. However, multiple solutions
for creating Debian packages exist, including [`electron-forge`][electron-forge], for creating Debian packages exist, including [Electron Forge][electron-forge],
[`electron-builder`][electron-builder] or [`electron-builder`][electron-builder] or
[`electron-installer-debian`][electron-installer-debian]. [`electron-installer-debian`][electron-installer-debian].
@ -239,7 +239,7 @@ apps:
[snapcraft-syntax]: https://docs.snapcraft.io/build-snaps/syntax [snapcraft-syntax]: https://docs.snapcraft.io/build-snaps/syntax
[electron-packager]: https://github.com/electron/electron-packager [electron-packager]: https://github.com/electron/electron-packager
[electron-forge]: https://github.com/electron-userland/electron-forge [electron-forge]: https://github.com/electron/forge
[electron-builder]: https://github.com/electron-userland/electron-builder [electron-builder]: https://github.com/electron-userland/electron-builder
[electron-installer-debian]: https://github.com/unindented/electron-installer-debian [electron-installer-debian]: https://github.com/unindented/electron-installer-debian
[electron-winstaller]: https://github.com/electron/windows-installer [electron-winstaller]: https://github.com/electron/windows-installer

2
docs/tutorial/tutorial-4-adding-features.md
View file

@ -63,7 +63,7 @@ into end users' hands.
<!-- Link labels --> <!-- Link labels -->
[discord]: https://discord.gg/electronjs [discord]: https://discord.gg/electronjs
[github]: https://github.com/electron/electronjs.org-new/issues/new [github]: https://github.com/electron/website/issues/new
[how-to]: ./examples.md [how-to]: ./examples.md
[node-platform]: https://nodejs.org/api/process.html#process_process_platform [node-platform]: https://nodejs.org/api/process.html#process_process_platform

4
docs/tutorial/tutorial-6-publishing-updating.md
View file

@ -222,8 +222,8 @@ rest of our docs and happy developing! If you have questions, please stop by our
[code-signed]: ./code-signing.md [code-signed]: ./code-signing.md
[discord server]: https://discord.gg/electronjs [discord server]: https://discord.gg/electronjs
[electron fiddle]: https://electronjs.org/fiddle [electron fiddle]: https://electronjs.org/fiddle
[fiddle-build]: https://github.com/electron/fiddle/blob/master/.github/workflows/build.yaml [fiddle-build]: https://github.com/electron/fiddle/blob/main/.github/workflows/build.yaml
[fiddle-forge-config]: https://github.com/electron/fiddle/blob/master/forge.config.js [fiddle-forge-config]: https://github.com/electron/fiddle/blob/main/forge.config.js
[github actions]: https://github.com/features/actions [github actions]: https://github.com/features/actions
[github publisher]: https://www.electronforge.io/config/publishers/github [github publisher]: https://www.electronforge.io/config/publishers/github
[github releases]: https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository [github releases]: https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository