Docs: separate electron installation into builder and forge sections

lovell · Nov 18, 2024 · eba82a8 · eba82a8
1 parent 06b08bf
commit eba82a8
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/docs/install.md b/docs/install.md
@@ -236,8 +236,10 @@ custom:
 
 ### electron
 
+#### electron-builder
+
 Ensure `sharp` is unpacked from the ASAR archive file using the
-[asarUnpack](https://www.electron.build/configuration/configuration.html)
+[asarUnpack](https://www.electron.build/app-builder-lib.interface.platformspecificbuildoptions#asarunpack)
 option.
 
 ```json
@@ -252,6 +254,22 @@ option.
 }
 ```
 
+#### electron-forge
+
+Ensure `sharp` is unpacked from the ASAR archive file using the
+[unpack](https://js.electronforge.io/interfaces/_electron_forge_maker_squirrel.InternalOptions.Options.html#asar)
+option.
+
+```json
+{
+  "packagerConfig": {
+    "asar": {
+      "unpack": "**/node_modules/{sharp,@img}/**/*"
+    }
+  }
+}
+```
+
 ### vite
 
 Ensure `sharp` is excluded from bundling via the