From 24cba12dbc748e524b1cc072ab5ccd2e8c72b34b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ant=C3=B3n=20Molleda?= Date: Thu, 7 Oct 2021 15:56:54 -0700 Subject: [PATCH] docs: update source --- docs/latest/api/menu.md | 2 +- docs/latest/api/native-theme.md | 9 ++++++--- docs/latest/api/touch-bar.md | 2 +- docs/latest/api/tray.md | 2 +- docs/latest/api/web-contents.md | 1 + docs/latest/api/webview-tag.md | 4 +++- .../development/debugging-instructions-macos-xcode.md | 2 +- docs/latest/development/issues.md | 2 +- docs/latest/development/pull-requests.md | 3 ++- docs/latest/faq.md | 2 +- docs/latest/styleguide.md | 1 + docs/latest/tutorial/application-distribution.md | 2 +- docs/latest/tutorial/context-isolation.md | 2 +- docs/latest/tutorial/dark-mode.md | 2 +- docs/latest/tutorial/in-app-purchases.md | 2 +- docs/latest/tutorial/keyboard-shortcuts.md | 2 +- .../tutorial/launch-app-from-url-in-another-app.md | 3 +++ docs/latest/tutorial/linux-desktop-actions.md | 2 +- docs/latest/tutorial/mac-app-store-submission-guide.md | 1 + docs/latest/tutorial/message-ports.md | 3 +++ docs/latest/tutorial/native-file-drag-drop.md | 2 +- docs/latest/tutorial/notifications.md | 2 +- docs/latest/tutorial/offscreen-rendering.md | 2 +- docs/latest/tutorial/online-offline-events.md | 2 +- docs/latest/tutorial/process-model.md | 1 + docs/latest/tutorial/progress-bar.md | 2 +- docs/latest/tutorial/quick-start.md | 5 +++++ docs/latest/tutorial/recent-documents.md | 2 +- docs/latest/tutorial/represented-file.md | 2 +- docs/latest/tutorial/sandbox.md | 2 ++ docs/latest/tutorial/security.md | 8 ++++++++ docs/latest/tutorial/support.md | 2 +- docs/latest/tutorial/tray.md | 1 + docs/latest/tutorial/web-embeds.md | 2 +- docs/latest/tutorial/windows-taskbar.md | 2 +- 35 files changed, 59 insertions(+), 27 deletions(-) diff --git a/docs/latest/api/menu.md b/docs/latest/api/menu.md index 8dcd823f5..de3053de8 100644 --- a/docs/latest/api/menu.md +++ b/docs/latest/api/menu.md @@ -1,6 +1,6 @@ --- title: "Menu" -description: "" +description: "Create native application menus and context menus." slug: menu hide_title: false --- diff --git a/docs/latest/api/native-theme.md b/docs/latest/api/native-theme.md index 1bbd838be..4ccf3b4f0 100644 --- a/docs/latest/api/native-theme.md +++ b/docs/latest/api/native-theme.md @@ -59,9 +59,12 @@ Settings this property to `light` will have the following effects: The usage of this property should align with a classic "dark mode" state machine in your application where the user has three options. -* `Follow OS` --> `themeSource = 'system'` -* `Dark Mode` --> `themeSource = 'dark'` -* `Light Mode` --> `themeSource = 'light'` +* `Follow OS` --> + `themeSource = 'system'` +* `Dark Mode` --> + `themeSource = 'dark'` +* `Light Mode` --> + `themeSource = 'light'` Your application should then always use `shouldUseDarkColors` to determine what CSS to apply. diff --git a/docs/latest/api/touch-bar.md b/docs/latest/api/touch-bar.md index bf044cc77..cf459f1ed 100644 --- a/docs/latest/api/touch-bar.md +++ b/docs/latest/api/touch-bar.md @@ -1,6 +1,6 @@ --- title: "TouchBar" -description: "" +description: "Create TouchBar layouts for native macOS applications" slug: touch-bar hide_title: false --- diff --git a/docs/latest/api/tray.md b/docs/latest/api/tray.md index a2dd75b80..a0115cefe 100644 --- a/docs/latest/api/tray.md +++ b/docs/latest/api/tray.md @@ -1,6 +1,6 @@ --- title: "Tray" -description: "" +description: "Add icons and context menus to the system's notification area." slug: tray hide_title: false --- diff --git a/docs/latest/api/web-contents.md b/docs/latest/api/web-contents.md index 1058db84b..017410e2a 100644 --- a/docs/latest/api/web-contents.md +++ b/docs/latest/api/web-contents.md @@ -1703,6 +1703,7 @@ app.whenReady().then(() => { ```html + diff --git a/docs/latest/tutorial/recent-documents.md b/docs/latest/tutorial/recent-documents.md index 66f8bc88e..65ad0cd54 100644 --- a/docs/latest/tutorial/recent-documents.md +++ b/docs/latest/tutorial/recent-documents.md @@ -1,6 +1,6 @@ --- title: "Recent Documents (Windows & macOS)" -description: "" +description: "Windows and macOS provide access to a list of recent documents opened by the application via JumpList or dock menu, respectively." slug: recent-documents hide_title: false --- diff --git a/docs/latest/tutorial/represented-file.md b/docs/latest/tutorial/represented-file.md index 339986bbd..c97792891 100644 --- a/docs/latest/tutorial/represented-file.md +++ b/docs/latest/tutorial/represented-file.md @@ -1,6 +1,6 @@ --- title: "Representing Files in a BrowserWindow (macOS)" -description: "" +description: "On macOS, you can set a represented file for any window in your application. The represented file's icon will be shown in the title bar, and when users Command-Click or Control-Click, a popup with a path to the file will be shown." slug: represented-file hide_title: false --- diff --git a/docs/latest/tutorial/sandbox.md b/docs/latest/tutorial/sandbox.md index 5e7292b51..ae362e20d 100644 --- a/docs/latest/tutorial/sandbox.md +++ b/docs/latest/tutorial/sandbox.md @@ -39,6 +39,7 @@ websites, just to name a few. For this reason, we recommend enabling renderer sa for the vast majority of cases under an abundance of caution. + Note that there is an active discussion in the issue tracker to enable renderer sandboxing by default. See [#28466][issue-28466]) for details. @@ -54,6 +55,7 @@ regular Chrome renderer would. A sandboxed renderer won't have a Node.js environment initialized. + Therefore, when the sandbox is enabled, renderer processes can only perform privileged tasks (such as interacting with the filesystem, making changes to the system, or spawning subprocesses) by delegating these tasks to the main process via inter-process diff --git a/docs/latest/tutorial/security.md b/docs/latest/tutorial/security.md index c1f01a410..940255093 100644 --- a/docs/latest/tutorial/security.md +++ b/docs/latest/tutorial/security.md @@ -147,10 +147,12 @@ browserWindow.loadURL('https://example.com') ```html + + ``` @@ -206,9 +208,11 @@ mainWindow.loadURL('https://example.com') ```html + + ``` @@ -339,9 +343,11 @@ const mainWindow = new BrowserWindow() ```html + + ``` @@ -519,9 +525,11 @@ you know it needs that feature. ```html + + ``` diff --git a/docs/latest/tutorial/support.md b/docs/latest/tutorial/support.md index 711e3b7b7..be225fa94 100644 --- a/docs/latest/tutorial/support.md +++ b/docs/latest/tutorial/support.md @@ -1,6 +1,6 @@ --- title: "Electron Support" -description: "" +description: "If you have a security concern, please see the security document." slug: support hide_title: false --- diff --git a/docs/latest/tutorial/tray.md b/docs/latest/tutorial/tray.md index 7840e454a..b6a5a9bd2 100644 --- a/docs/latest/tutorial/tray.md +++ b/docs/latest/tutorial/tray.md @@ -12,6 +12,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 its own context menu to the system's notification area. diff --git a/docs/latest/tutorial/web-embeds.md b/docs/latest/tutorial/web-embeds.md index 087df51c7..3629a31ea 100644 --- a/docs/latest/tutorial/web-embeds.md +++ b/docs/latest/tutorial/web-embeds.md @@ -1,6 +1,6 @@ --- title: "Web Embeds" -description: "" +description: "If you want to embed (third-party) web content in an Electron BrowserWindow, there are three options available to you: