From 62366aeb95f0ec352abd4fdf320d8fc4e65d7bf7 Mon Sep 17 00:00:00 2001 From: Erick Zhao Date: Thu, 3 Mar 2022 09:56:00 -0800 Subject: [PATCH] docs: remove platform notices from tutorial titles (#32937) * docs: remove platform notices from tutorial titles * Update docs/tutorial/launch-app-from-url-in-another-app.md Co-authored-by: Mark Lee Co-authored-by: Mark Lee --- docs/tutorial/in-app-purchases.md | 9 ++++++++- .../launch-app-from-url-in-another-app.md | 6 +++--- docs/tutorial/linux-desktop-actions.md | 11 +++++++++-- docs/tutorial/macos-dock.md | 15 ++++++++------- docs/tutorial/progress-bar.md | 9 ++++++++- docs/tutorial/recent-documents.md | 9 ++++++++- docs/tutorial/represented-file.md | 9 ++++++++- docs/tutorial/windows-taskbar.md | 9 ++++++++- 8 files changed, 60 insertions(+), 17 deletions(-) diff --git a/docs/tutorial/in-app-purchases.md b/docs/tutorial/in-app-purchases.md index d4a27c854f6..ced192ba296 100644 --- a/docs/tutorial/in-app-purchases.md +++ b/docs/tutorial/in-app-purchases.md @@ -1,4 +1,11 @@ -# In-App Purchases (macOS) +--- +title: In-App Purchases +description: Add in-app purchases to your Mac App Store (MAS) application +slug: in-app-purchases +hide_title: true +--- + +# In-App Purchases ## Preparing 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 d02b28075d5..d99c1f95033 100644 --- a/docs/tutorial/launch-app-from-url-in-another-app.md +++ b/docs/tutorial/launch-app-from-url-in-another-app.md @@ -1,11 +1,11 @@ --- -title: Launching Your Electron App From a URL In Another App -description: This guide will take you through the process of setting your electron app as the default handler for a specific protocol. +title: Deep Links +description: Set your Electron app as the default handler for a specific protocol. slug: launch-app-from-url-in-another-app hide_title: true --- -# Launching Your Electron App From A URL In Another App +# Deep Links ## Overview diff --git a/docs/tutorial/linux-desktop-actions.md b/docs/tutorial/linux-desktop-actions.md index 5fa3c5abeda..7f09d0a4e52 100644 --- a/docs/tutorial/linux-desktop-actions.md +++ b/docs/tutorial/linux-desktop-actions.md @@ -1,4 +1,11 @@ -# Desktop Launcher Actions (Linux) +--- +title: Desktop Launcher Actions +description: Add actions to the system launcher on Linux environments. +slug: linux-desktop-actions +hide_title: true +--- + +# Desktop Launcher Actions ## Overview @@ -42,4 +49,4 @@ parameters. You can find them in your application in the global variable [unity-launcher]: https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles#Adding_shortcuts_to_a_launcher [audacious-launcher]: https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles?action=AttachFile&do=get&target=shortcuts.png -[spec]: https://specifications.freedesktop.org/desktop-entry-spec/1.1/ar01s11.html +[spec]: https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html diff --git a/docs/tutorial/macos-dock.md b/docs/tutorial/macos-dock.md index 0a080e763d0..38cfcb48e62 100644 --- a/docs/tutorial/macos-dock.md +++ b/docs/tutorial/macos-dock.md @@ -1,4 +1,11 @@ -# Dock (macOS) +--- +title: Dock +description: Configure your application's Dock presence on macOS. +slug: macos-dock +hide_title: true +--- + +# Dock Electron has APIs to configure the app's icon in the macOS Dock. A macOS-only API exists to create a custom dock menu, but Electron also uses the app dock @@ -16,12 +23,6 @@ To set your custom dock menu, you need to use the [`app.dock.setMenu`](../api/dock.md#docksetmenumenu-macos) API, which is only available on macOS. -## Example - -Starting with a working application from the - [Quick Start Guide](quick-start.md), update the `main.js` file with the - following lines: - ```javascript fiddle='docs/fiddles/features/macos-dock-menu' const { app, BrowserWindow, Menu } = require('electron') diff --git a/docs/tutorial/progress-bar.md b/docs/tutorial/progress-bar.md index 58bdab8e8de..9df75ab96e8 100644 --- a/docs/tutorial/progress-bar.md +++ b/docs/tutorial/progress-bar.md @@ -1,4 +1,11 @@ -# Taskbar Progress Bar (Windows & macOS) +--- +title: Progress Bars +description: Provide progress information to users outside of a BrowserWindow. +slug: progress-bar +hide_title: true +--- + +# Progress Bars ## Overview diff --git a/docs/tutorial/recent-documents.md b/docs/tutorial/recent-documents.md index 8923b177806..f1ca0c3251c 100644 --- a/docs/tutorial/recent-documents.md +++ b/docs/tutorial/recent-documents.md @@ -1,4 +1,11 @@ -# Recent Documents (Windows & macOS) +--- +title: Recent Documents +description: Provide a list of recent documents via Windows JumpList or macOS Dock +slug: recent-documents +hide_title: true +--- + +# Recent Documents ## Overview diff --git a/docs/tutorial/represented-file.md b/docs/tutorial/represented-file.md index 7d703a37b4f..a4d94d20154 100644 --- a/docs/tutorial/represented-file.md +++ b/docs/tutorial/represented-file.md @@ -1,4 +1,11 @@ -# Representing Files in a BrowserWindow (macOS) +--- +title: Representing Files in a BrowserWindow +description: Set a represented file in the macOS title bar. +slug: represented-file +hide_title: true +--- + +# Representing Files in a BrowserWindow ## Overview diff --git a/docs/tutorial/windows-taskbar.md b/docs/tutorial/windows-taskbar.md index 1d88846a13a..444c712b360 100644 --- a/docs/tutorial/windows-taskbar.md +++ b/docs/tutorial/windows-taskbar.md @@ -1,4 +1,11 @@ -# Taskbar Customization (Windows) +--- +title: Taskbar Customization +description: Customize the look and feel of your app's Windows taskbar presence. +slug: windows-taskbar +hide_title: true +--- + +# Taskbar Customization ## Overview