From d17507e3f690cab21495b71bb4e08b4212099618 Mon Sep 17 00:00:00 2001 From: David Sanders Date: Tue, 7 Feb 2023 02:28:24 -0800 Subject: [PATCH] docs: use relative links within docs (#37042) --- docs/tutorial/forge-overview.md | 2 +- docs/tutorial/launch-app-from-url-in-another-app.md | 2 +- docs/tutorial/tray.md | 10 +++++----- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/tutorial/forge-overview.md b/docs/tutorial/forge-overview.md index 8851d4733e..66a0700258 100644 --- a/docs/tutorial/forge-overview.md +++ b/docs/tutorial/forge-overview.md @@ -33,4 +33,4 @@ template and submit a new issue. [(publish)]: https://www.electronforge.io/cli#publish [GitHub issue tracker]: https://github.com/electron/forge/issues [discord]: https://discord.gg/APGC3k5yaH -[tutorial]: https://www.electronjs.org/docs/latest/tutorial/tutorial-prerequisites +[tutorial]: ./tutorial-1-prerequisites.md diff --git a/docs/tutorial/launch-app-from-url-in-another-app.md b/docs/tutorial/launch-app-from-url-in-another-app.md index 33b08ea772..7ed98d3454 100644 --- a/docs/tutorial/launch-app-from-url-in-another-app.md +++ b/docs/tutorial/launch-app-from-url-in-another-app.md @@ -12,7 +12,7 @@ hide_title: true This guide will take you through the process of setting your Electron app as the default -handler for a specific [protocol](https://www.electronjs.org/docs/api/protocol). +handler for a specific [protocol](../api/protocol.md). By the end of this tutorial, we will have set our app to intercept and handle any clicked URLs that start with a specific protocol. In this guide, the protocol diff --git a/docs/tutorial/tray.md b/docs/tutorial/tray.md index 1f0c8e6b6f..efa7e2e7a2 100644 --- a/docs/tutorial/tray.md +++ b/docs/tutorial/tray.md @@ -13,7 +13,7 @@ hide_title: true This guide will take you through the process of creating a -[Tray](https://www.electronjs.org/docs/api/tray) icon with +[Tray](../api/tray.md) icon with its own context menu to the system's notification area. On MacOS and Ubuntu, the Tray will be located on the top @@ -31,11 +31,11 @@ const { app, Tray, Menu, nativeImage } = require('electron') ``` Next we will create our Tray. To do this, we will use a -[`NativeImage`](https://www.electronjs.org/docs/api/native-image) icon, +[`NativeImage`](../api/native-image.md) icon, which can be created through any one of these -[methods](https://www.electronjs.org/docs/api/native-image#methods). +[methods](../api/native-image.md#methods). Note that we wrap our Tray creation code within an -[`app.whenReady`](https://www.electronjs.org/docs/api/app#appwhenready) +[`app.whenReady`](../api/app.md#appwhenready) as we will need to wait for our electron app to finish initializing. ```js title='main.js' @@ -64,7 +64,7 @@ tray.setContextMenu(contextMenu) The code above will create 4 separate radio-type items in the context menu. To read more about constructing native menus, click -[here](https://www.electronjs.org/docs/api/menu#menubuildfromtemplatetemplate). +[here](../api/menu.md#menubuildfromtemplatetemplate). Finally, let's give our tray a tooltip and a title.