docs: update source

electron · Oct 7, 2021 · 9d9a968 · 9d9a968
1 parent b4e995b
commit 9d9a968
Show file tree

Hide file tree

Showing 24 changed files with 24 additions and 24 deletions.
diff --git 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/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
@@ -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/webview-tag.md b/docs/latest/api/webview-tag.md
@@ -1,6 +1,6 @@
 ---
 title: "`<webview>` Tag"
-description: ""
+description: "Electron's webview tag is based on Chromium's webview, which is undergoing dramatic architectural changes. This impacts the stability of webviews, including rendering, navigation, and event routing. We currently recommend to not use the webview tag and to consider alternatives, like iframe, Electron's BrowserView, or an architecture that avoids embedded content altogether."
 slug: webview-tag
 hide_title: false
 ---

diff --git a/docs/latest/development/debugging-instructions-macos-xcode.md b/docs/latest/development/debugging-instructions-macos-xcode.md
@@ -1,6 +1,6 @@
 ---
 title: "Debugging with XCode"
-description: ""
+description: "Run gn gen with the --ide=xcode argument."
 slug: debugging-instructions-macos-xcode
 hide_title: false
 ---

diff --git a/docs/latest/development/issues.md b/docs/latest/development/issues.md
@@ -1,6 +1,6 @@
 ---
 title: "Issues In Electron"
-description: ""
+description: "For any issue, there are fundamentally three ways an individual can contribute:"
 slug: issues
 hide_title: false
 ---

diff --git a/docs/latest/development/pull-requests.md b/docs/latest/development/pull-requests.md
@@ -1,6 +1,6 @@
 ---
 title: "Pull Requests"
-description: ""
+description: "Fork the project on GitHub and clone your fork locally."
 slug: pull-requests
 hide_title: false
 ---

diff --git a/docs/latest/faq.md b/docs/latest/faq.md
@@ -1,6 +1,6 @@
 ---
 title: "Electron FAQ"
-description: ""
+description: "When running npm install electron, some users occasionally encounter installation errors."
 slug: faq
 hide_title: false
 ---

diff --git a/docs/latest/tutorial/application-distribution.md b/docs/latest/tutorial/application-distribution.md
@@ -1,6 +1,6 @@
 ---
 title: "Application Distribution"
-description: ""
+description: "To distribute your app with Electron, you need to package and rebrand it. To do this, you can either use specialized tooling or manual approaches."
 slug: application-distribution
 hide_title: false
 ---

diff --git a/docs/latest/tutorial/context-isolation.md b/docs/latest/tutorial/context-isolation.md
@@ -1,6 +1,6 @@
 ---
 title: "Context Isolation"
-description: ""
+description: "Context Isolation is a feature that ensures that both your preload scripts and Electron's internal logic run in a separate context to the website you load in a webContents.  This is important for security purposes as it helps prevent the website from accessing Electron internals or the powerful APIs your preload script has access to."
 slug: context-isolation
 hide_title: false
 ---

diff --git a/docs/latest/tutorial/dark-mode.md b/docs/latest/tutorial/dark-mode.md
@@ -1,6 +1,6 @@
 ---
 title: "Dark Mode"
-description: ""
+description: "\"Native interfaces\" include the file picker, window border, dialogs, context menus, and more - anything where the UI comes from your operating system and not from your app. The default behavior is to opt into this automatic theming from the OS."
 slug: dark-mode
 hide_title: false
 ---

diff --git a/docs/latest/tutorial/in-app-purchases.md b/docs/latest/tutorial/in-app-purchases.md
@@ -1,6 +1,6 @@
 ---
 title: "In-App Purchases (macOS)"
-description: ""
+description: "If you haven't already, you’ll need to sign the Paid Applications Agreement and set up your banking and tax information in iTunes Connect."
 slug: in-app-purchases
 hide_title: false
 ---

diff --git a/docs/latest/tutorial/keyboard-shortcuts.md b/docs/latest/tutorial/keyboard-shortcuts.md
@@ -1,6 +1,6 @@
 ---
 title: "Keyboard Shortcuts"
-description: ""
+description: "This feature allows you to configure local and global keyboard shortcuts for your Electron application."
 slug: keyboard-shortcuts
 hide_title: false
 ---

diff --git a/docs/latest/tutorial/linux-desktop-actions.md b/docs/latest/tutorial/linux-desktop-actions.md
@@ -1,6 +1,6 @@
 ---
 title: "Desktop Launcher Actions (Linux)"
-description: ""
+description: "On many Linux environments, you can add custom entries to the system launcher by modifying the .desktop file. For Canonical's Unity documentation, see Adding Shortcuts to a Launcher. For details on a more generic implementation, see the freedesktop.org Specification."
 slug: linux-desktop-actions
 hide_title: false
 ---

diff --git a/docs/latest/tutorial/native-file-drag-drop.md b/docs/latest/tutorial/native-file-drag-drop.md
@@ -1,6 +1,6 @@
 ---
 title: "Native File Drag & Drop"
-description: ""
+description: "Certain kinds of applications that manipulate files might want to support the operating system's native file drag & drop feature. Dragging files into web content is common and supported by many websites. Electron additionally supports dragging files and content out from web content into the operating system's world."
 slug: native-file-drag-drop
 hide_title: false
 ---

diff --git a/docs/latest/tutorial/notifications.md b/docs/latest/tutorial/notifications.md
@@ -1,6 +1,6 @@
 ---
 title: "Notifications"
-description: ""
+description: "All three operating systems provide means for applications to send notifications to the user. The technique of showing notifications is different for the Main and Renderer processes."
 slug: notifications
 hide_title: false
 ---

diff --git a/docs/latest/tutorial/offscreen-rendering.md b/docs/latest/tutorial/offscreen-rendering.md
@@ -1,6 +1,6 @@
 ---
 title: "Offscreen Rendering"
-description: ""
+description: "Offscreen rendering lets you obtain the content of a BrowserWindow in a bitmap, so it can be rendered anywhere, for example, on texture in a 3D scene. The offscreen rendering in Electron uses a similar approach to that of the Chromium Embedded Framework project."
 slug: offscreen-rendering
 hide_title: false
 ---

diff --git a/docs/latest/tutorial/online-offline-events.md b/docs/latest/tutorial/online-offline-events.md
@@ -1,6 +1,6 @@
 ---
 title: "Online/Offline Event Detection"
-description: ""
+description: "Online and offline event detection can be implemented in the Renderer process using the navigator.onLine attribute, part of standard HTML5 API."
 slug: online-offline-events
 hide_title: false
 ---

diff --git a/docs/latest/tutorial/progress-bar.md b/docs/latest/tutorial/progress-bar.md
@@ -1,6 +1,6 @@
 ---
 title: "Taskbar Progress Bar (Windows & macOS)"
-description: ""
+description: "A progress bar enables a window to provide progress information to the user without the need of switching to the window itself."
 slug: progress-bar
 hide_title: false
 ---

diff --git 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
@@ -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/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/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: <iframe> tags, <webview> tags, and BrowserViews. Each one offers slightly different functionality and is useful in different situations. To help you choose between these, this guide explains the differences and capabilities of each option."
 slug: web-embeds
 hide_title: false
 ---

diff --git a/docs/latest/tutorial/windows-taskbar.md b/docs/latest/tutorial/windows-taskbar.md
@@ -1,6 +1,6 @@
 ---
 title: "Taskbar Customization (Windows)"
-description: ""
+description: "Electron has APIs to configure the app's icon in the Windows taskbar. This API supports both Windows-only features like creation of a JumpList, custom thumbnails and toolbars, icon overlays, and the so-called \"Flash Frame\" effect, and cross-platform features like recent documents and application progress."
 slug: windows-taskbar
 hide_title: false
 ---