Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: reduce usage of markdown splicing #690

Merged
merged 20 commits into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
202 changes: 101 additions & 101 deletions docs/latest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,144 +21,144 @@ that matches your version.
There are questions that are asked quite often. Check this out before creating
an issue:

* [Electron FAQ](latest/faq.md)
* [Electron FAQ](faq.md)

## Guides and Tutorials

### Getting started

* [Introduction](latest/tutorial/introduction.md)
* [Quick Start](latest/tutorial/quick-start.md)
* [Process Model](latest/tutorial/process-model.md)
* [Introduction](tutorial/introduction.md)
* [Quick Start](tutorial/quick-start.md)
* [Process Model](tutorial/process-model.md)

### Learning the basics

* Adding Features to Your App
* [Notifications](latest/tutorial/notifications.md)
* [Recent Documents](latest/tutorial/recent-documents.md)
* [Application Progress](latest/tutorial/progress-bar.md)
* [Custom Dock Menu](latest/tutorial/macos-dock.md)
* [Custom Windows Taskbar](latest/tutorial/windows-taskbar.md)
* [Custom Linux Desktop Actions](latest/tutorial/linux-desktop-actions.md)
* [Keyboard Shortcuts](latest/tutorial/keyboard-shortcuts.md)
* [Offline/Online Detection](latest/tutorial/online-offline-events.md)
* [Represented File for macOS BrowserWindows](latest/tutorial/represented-file.md)
* [Native File Drag & Drop](latest/tutorial/native-file-drag-drop.md)
* [Navigation History](latest/tutorial/navigation-history.md)
* [Offscreen Rendering](latest/tutorial/offscreen-rendering.md)
* [Dark Mode](latest/tutorial/dark-mode.md)
* [Web embeds in Electron](latest/tutorial/web-embeds.md)
* [Boilerplates and CLIs](latest/tutorial/boilerplates-and-clis.md)
* [Boilerplate vs CLI](latest/tutorial/boilerplates-and-clis.md#boilerplate-vs-cli)
* [Electron Forge](latest/tutorial/boilerplates-and-clis.md#electron-forge)
* [electron-builder](latest/tutorial/boilerplates-and-clis.md#electron-builder)
* [electron-react-boilerplate](latest/tutorial/boilerplates-and-clis.md#electron-react-boilerplate)
* [Other Tools and Boilerplates](latest/tutorial/boilerplates-and-clis.md#other-tools-and-boilerplates)
* [Notifications](tutorial/notifications.md)
* [Recent Documents](tutorial/recent-documents.md)
* [Application Progress](tutorial/progress-bar.md)
* [Custom Dock Menu](tutorial/macos-dock.md)
* [Custom Windows Taskbar](tutorial/windows-taskbar.md)
* [Custom Linux Desktop Actions](tutorial/linux-desktop-actions.md)
* [Keyboard Shortcuts](tutorial/keyboard-shortcuts.md)
* [Offline/Online Detection](tutorial/online-offline-events.md)
* [Represented File for macOS BrowserWindows](tutorial/represented-file.md)
* [Native File Drag & Drop](tutorial/native-file-drag-drop.md)
* [Navigation History](tutorial/navigation-history.md)
* [Offscreen Rendering](tutorial/offscreen-rendering.md)
* [Dark Mode](tutorial/dark-mode.md)
* [Web embeds in Electron](tutorial/web-embeds.md)
* [Boilerplates and CLIs](tutorial/boilerplates-and-clis.md)
* [Boilerplate vs CLI](tutorial/boilerplates-and-clis.md#boilerplate-vs-cli)
* [Electron Forge](tutorial/boilerplates-and-clis.md#electron-forge)
* [electron-builder](tutorial/boilerplates-and-clis.md#electron-builder)
* [electron-react-boilerplate](tutorial/boilerplates-and-clis.md#electron-react-boilerplate)
* [Other Tools and Boilerplates](tutorial/boilerplates-and-clis.md#other-tools-and-boilerplates)

### Advanced steps

* Application Architecture
* [Using Native Node.js Modules](latest/tutorial/using-native-node-modules.md)
* [Performance Strategies](latest/tutorial/performance.md)
* [Security Strategies](latest/tutorial/security.md)
* [Process Sandboxing](latest/tutorial/sandbox.md)
* [Accessibility](latest/tutorial/accessibility.md)
* [Manually Enabling Accessibility Features](latest/tutorial/accessibility.md#manually-enabling-accessibility-features)
* [Testing and Debugging](latest/tutorial/application-debugging.md)
* [Debugging the Main Process](latest/tutorial/debugging-main-process.md)
* [Debugging with Visual Studio Code](latest/tutorial/debugging-vscode.md)
* [Testing on Headless CI Systems (Travis, Jenkins)](latest/tutorial/testing-on-headless-ci.md)
* [DevTools Extension](latest/tutorial/devtools-extension.md)
* [Automated Testing](latest/tutorial/automated-testing.md)
* [REPL](latest/tutorial/repl.md)
* [Distribution](latest/tutorial/application-distribution.md)
* [Code Signing](latest/tutorial/code-signing.md)
* [Mac App Store](latest/tutorial/mac-app-store-submission-guide.md)
* [Windows Store](latest/tutorial/windows-store-guide.md)
* [Snapcraft](latest/tutorial/snapcraft.md)
* [ASAR Archives](latest/tutorial/asar-archives.md)
* [Updates](latest/tutorial/updates.md)
* [Getting Support](latest/tutorial/support.md)
* [Using Native Node.js Modules](tutorial/using-native-node-modules.md)
* [Performance Strategies](tutorial/performance.md)
* [Security Strategies](tutorial/security.md)
* [Process Sandboxing](tutorial/sandbox.md)
* [Accessibility](tutorial/accessibility.md)
* [Manually Enabling Accessibility Features](tutorial/accessibility.md#manually-enabling-accessibility-features)
* [Testing and Debugging](tutorial/application-debugging.md)
* [Debugging the Main Process](tutorial/debugging-main-process.md)
* [Debugging with Visual Studio Code](tutorial/debugging-vscode.md)
* [Testing on Headless CI Systems (Travis, Jenkins)](tutorial/testing-on-headless-ci.md)
* [DevTools Extension](tutorial/devtools-extension.md)
* [Automated Testing](tutorial/automated-testing.md)
* [REPL](tutorial/repl.md)
* [Distribution](tutorial/application-distribution.md)
* [Code Signing](tutorial/code-signing.md)
* [Mac App Store](tutorial/mac-app-store-submission-guide.md)
* [Windows Store](tutorial/windows-store-guide.md)
* [Snapcraft](tutorial/snapcraft.md)
* [ASAR Archives](tutorial/asar-archives.md)
* [Updates](tutorial/updates.md)
* [Getting Support](tutorial/support.md)

## Detailed Tutorials

These individual tutorials expand on topics discussed in the guide above.

* [Installing Electron](latest/tutorial/installation.md)
* [Proxies](latest/tutorial/installation.md#proxies)
* [Custom Mirrors and Caches](latest/tutorial/installation.md#custom-mirrors-and-caches)
* [Troubleshooting](latest/tutorial/installation.md#troubleshooting)
* [Installing Electron](tutorial/installation.md)
* [Proxies](tutorial/installation.md#proxies)
* [Custom Mirrors and Caches](tutorial/installation.md#custom-mirrors-and-caches)
* [Troubleshooting](tutorial/installation.md#troubleshooting)
* Electron Releases & Developer Feedback
* [Versioning Policy](latest/tutorial/electron-versioning.md)
* [Release Timelines](latest/tutorial/electron-timelines.md)
* [Versioning Policy](tutorial/electron-versioning.md)
* [Release Timelines](tutorial/electron-timelines.md)

---

* [Glossary of Terms](latest/glossary.md)
* [Glossary of Terms](glossary.md)

## API References

* [Process Object](latest/api/process.md)
* [Supported Command Line Switches](latest/api/command-line-switches.md)
* [Environment Variables](latest/api/environment-variables.md)
* [Chrome Extensions Support](latest/api/extensions.md)
* [Breaking API Changes](latest/breaking-changes.md)
* [Process Object](api/process.md)
* [Supported Command Line Switches](api/command-line-switches.md)
* [Environment Variables](api/environment-variables.md)
* [Chrome Extensions Support](api/extensions.md)
* [Breaking API Changes](breaking-changes.md)

### Custom DOM Elements:

* [`<webview>` Tag](latest/api/webview-tag.md)
* [`window.open` Function](latest/api/window-open.md)
* [`<webview>` Tag](api/webview-tag.md)
* [`window.open` Function](api/window-open.md)

### Modules for the Main Process:

* [app](latest/api/app.md)
* [autoUpdater](latest/api/auto-updater.md)
* [BaseWindow](latest/api/base-window.md)
* [BrowserWindow](latest/api/browser-window.md)
* [contentTracing](latest/api/content-tracing.md)
* [desktopCapturer](latest/api/desktop-capturer.md)
* [dialog](latest/api/dialog.md)
* [globalShortcut](latest/api/global-shortcut.md)
* [inAppPurchase](latest/api/in-app-purchase.md)
* [ipcMain](latest/api/ipc-main.md)
* [Menu](latest/api/menu.md)
* [MenuItem](latest/api/menu-item.md)
* [MessageChannelMain](latest/api/message-channel-main.md)
* [MessagePortMain](latest/api/message-port-main.md)
* [nativeTheme](latest/api/native-theme.md)
* [net](latest/api/net.md)
* [netLog](latest/api/net-log.md)
* [Notification](latest/api/notification.md)
* [powerMonitor](latest/api/power-monitor.md)
* [powerSaveBlocker](latest/api/power-save-blocker.md)
* [protocol](latest/api/protocol.md)
* [pushNotifications](latest/api/push-notifications.md)
* [safeStorage](latest/api/safe-storage.md)
* [screen](latest/api/screen.md)
* [session](latest/api/session.md)
* [ShareMenu](latest/api/share-menu.md)
* [systemPreferences](latest/api/system-preferences.md)
* [TouchBar](latest/api/touch-bar.md)
* [Tray](latest/tutorial/tray.md)
* [utilityProcess](latest/api/utility-process.md)
* [View](latest/api/view.md)
* [webContents](latest/api/web-contents.md)
* [webFrameMain](latest/api/web-frame-main.md)
* [WebContentsView](latest/api/web-contents-view.md)
* [app](api/app.md)
* [autoUpdater](api/auto-updater.md)
* [BaseWindow](api/base-window.md)
* [BrowserWindow](api/browser-window.md)
* [contentTracing](api/content-tracing.md)
* [desktopCapturer](api/desktop-capturer.md)
* [dialog](api/dialog.md)
* [globalShortcut](api/global-shortcut.md)
* [inAppPurchase](api/in-app-purchase.md)
* [ipcMain](api/ipc-main.md)
* [Menu](api/menu.md)
* [MenuItem](api/menu-item.md)
* [MessageChannelMain](api/message-channel-main.md)
* [MessagePortMain](api/message-port-main.md)
* [nativeTheme](api/native-theme.md)
* [net](api/net.md)
* [netLog](api/net-log.md)
* [Notification](api/notification.md)
* [powerMonitor](api/power-monitor.md)
* [powerSaveBlocker](api/power-save-blocker.md)
* [protocol](api/protocol.md)
* [pushNotifications](api/push-notifications.md)
* [safeStorage](api/safe-storage.md)
* [screen](api/screen.md)
* [session](api/session.md)
* [ShareMenu](api/share-menu.md)
* [systemPreferences](api/system-preferences.md)
* [TouchBar](api/touch-bar.md)
* [Tray](api/tray.md)
* [utilityProcess](api/utility-process.md)
* [View](api/view.md)
* [webContents](api/web-contents.md)
* [webFrameMain](api/web-frame-main.md)
* [WebContentsView](api/web-contents-view.md)

### Modules for the Renderer Process (Web Page):

* [contextBridge](latest/api/context-bridge.md)
* [ipcRenderer](latest/api/ipc-renderer.md)
* [webFrame](latest/api/web-frame.md)
* [contextBridge](api/context-bridge.md)
* [ipcRenderer](api/ipc-renderer.md)
* [webFrame](api/web-frame.md)

### Modules for Both Processes:

* [clipboard](latest/api/clipboard.md) (non-sandboxed renderers only)
* [crashReporter](latest/api/crash-reporter.md)
* [nativeImage](latest/api/native-image.md)
* [shell](latest/api/shell.md) (non-sandboxed renderers only)
* [clipboard](api/clipboard.md) (non-sandboxed renderers only)
* [crashReporter](api/crash-reporter.md)
* [nativeImage](api/native-image.md)
* [shell](api/shell.md) (non-sandboxed renderers only)

## Development

See [development/README.md](latest/development/README.md)
See [development/README.md](development/README.md)
4 changes: 2 additions & 2 deletions docs/latest/api/accelerator.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Examples:
* `CommandOrControl+A`
* `CommandOrControl+Shift+Z`

Shortcuts are registered with the [`globalShortcut`](latest/api/global-shortcut.md) module
using the [`register`](latest/api/global-shortcut.md#globalshortcutregisteraccelerator-callback)
Shortcuts are registered with the [`globalShortcut`](global-shortcut.md) module
using the [`register`](global-shortcut.md#globalshortcutregisteraccelerator-callback)
method, i.e.

```js
Expand Down
Loading
Loading