Skip to content

Commit

Permalink
GITBOOK-197: Update plugin documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
erickzhao authored and gitbook-bot committed Feb 8, 2025
1 parent 4f7404b commit b851699
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 3 deletions.
15 changes: 15 additions & 0 deletions .gitbook/assets/Vitejs-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 17 additions & 3 deletions config/plugins/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
---
description: Modules to extend Forge's core functionality
---

# Plugins

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.
Electron Forge has a plugin system which allows you to extend its core functionality.

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.

{% hint style="info" %}
If you want to write your own Forge plugin, check out the [writing-plugins.md](../../advanced/extending-electron-forge/writing-plugins.md "mention") guide.
{% endhint %}

## Bundler plugins

<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>

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

If you want to write your own plugin check out [Writing Plugins](../../advanced/extending-electron-forge/writing-plugins.md).
<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>

0 comments on commit b851699

Please sign in to comment.