Skip to content

Commit b851699

Browse files
erickzhaogitbook-bot
authored andcommitted
GITBOOK-197: Update plugin documentation
1 parent 4f7404b commit b851699

File tree

3 files changed

+32
-3
lines changed

3 files changed

+32
-3
lines changed

.gitbook/assets/Vitejs-logo.svg

Lines changed: 15 additions & 0 deletions
Loading

.gitbook/assets/icon.png

76.3 KB
Loading

config/plugins/README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,22 @@
1+
---
2+
description: Modules to extend Forge's core functionality
3+
---
4+
15
# Plugins
26

3-
Electron Forge has a plugin system which allows easy extensibility of the core functionality of forge. By default, Forge takes a vanilla JS application and packages, makes and publishes it.
7+
Electron Forge has a plugin system which allows you to extend its core functionality.
8+
9+
By default, Forge takes a vanilla JS application and packages, makes and publishes it (see the [build-lifecycle.md](../../core-concepts/build-lifecycle.md "mention") document for more details). Plugins can execute custom logic during any of the Forge [hooks.md](../hooks.md "mention") during the build process, and can also override the [#start](../../cli.md#start "mention") command in development.
10+
11+
{% hint style="info" %}
12+
If you want to write your own Forge plugin, check out the [writing-plugins.md](../../advanced/extending-electron-forge/writing-plugins.md "mention") guide.
13+
{% endhint %}
14+
15+
## Bundler plugins
16+
17+
<table data-view="cards"><thead><tr><th data-type="content-ref"></th><th></th><th data-hidden data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><a href="webpack.md">webpack.md</a></td><td>Build your Electron app with webpack</td><td><a href="webpack.md">webpack.md</a></td><td></td><td><a href="webpack.md">webpack.md</a></td></tr><tr><td><a href="vite.md">vite.md</a></td><td>Build your Electron app with Vite</td><td><a href="vite.md">vite.md</a></td><td></td><td><a href="vite.md">vite.md</a></td></tr></tbody></table>
418

5-
Through the use of plugins, you can make Forge even more powerful. For instance integrating directly with industry standard build tooling like WebPack.
19+
## Utility plugins
620

7-
If you want to write your own plugin check out [Writing Plugins](../../advanced/extending-electron-forge/writing-plugins.md).
21+
<table data-view="cards"><thead><tr><th data-type="content-ref"></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><a href="auto-unpack-natives.md">auto-unpack-natives.md</a></td><td>Unpack native Node.js modules from your Forge app's ASAR archive.</td><td><a href="auto-unpack-natives.md">auto-unpack-natives.md</a></td></tr><tr><td><a href="local-electron.md">local-electron.md</a></td><td>Integrate a local build of Electron into your Forge app.</td><td><a href="local-electron.md">local-electron.md</a></td></tr><tr><td><a href="fuses.md">fuses.md</a></td><td>Toggle Electron functionality at package-time with Electron Fuses.</td><td><a href="fuses.md">fuses.md</a></td></tr><tr><td><a href="electronegativity.md">electronegativity.md</a></td><td>Check for misconfigurations and security anti-patterns with the Electronegativity tool.</td><td></td></tr></tbody></table>
822

0 commit comments

Comments
 (0)