diff --git a/.gitbook/assets/Vitejs-logo.svg b/.gitbook/assets/Vitejs-logo.svg new file mode 100644 index 0000000..de4aedd --- /dev/null +++ b/.gitbook/assets/Vitejs-logo.svg @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/.gitbook/assets/icon.png b/.gitbook/assets/icon.png new file mode 100644 index 0000000..b74b839 Binary files /dev/null and b/.gitbook/assets/icon.png differ diff --git a/config/plugins/README.md b/config/plugins/README.md index 2d0f2e1..a8c00b6 100644 --- a/config/plugins/README.md +++ b/config/plugins/README.md @@ -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 + +
webpack.mdBuild your Electron app with webpackwebpack.mdwebpack.md
vite.mdBuild your Electron app with Vitevite.mdvite.md
-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). +
auto-unpack-natives.mdUnpack native Node.js modules from your Forge app's ASAR archive.auto-unpack-natives.md
local-electron.mdIntegrate a local build of Electron into your Forge app.local-electron.md
fuses.mdToggle Electron functionality at package-time with Electron Fuses.fuses.md
electronegativity.mdCheck for misconfigurations and security anti-patterns with the Electronegativity tool.