Skip to content

Commit

Permalink
GITBOOK-200: Update Makers prose
Browse files Browse the repository at this point in the history
  • Loading branch information
erickzhao authored and gitbook-bot committed Feb 13, 2025
1 parent 4f52218 commit fdbaab2
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions config/makers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ description: >-

# Makers

Makers are Electron Forge's way of taking your packaged application and making platform specific distributables like DMG, EXE, or Flatpak files \(amongst others\).
Makers are Electron Forge's way of taking your packaged application and generating platform-specific distributable formats like [dmg.md](dmg.md "mention"), [appx.md](appx.md "mention"), or [flatpak.md](flatpak.md "mention") files (amongst others).

Each maker has to be configured in the `makers` section of your forge configuration with which platforms to run for and the maker specific config. E.g.
Each maker has to be configured in the `makers` section of your Forge configuration. For example:

{% tabs %}
{% tab title="forge.config.js" %}
Expand All @@ -33,9 +33,9 @@ module.exports = {
};
```
{% endtab %}

{% tab title="package.json" %}
```jsonc
// If your config is only in package.json:
```json
// Only showing the relevant configuration for brevity
{
"config": {
Expand All @@ -56,5 +56,7 @@ module.exports = {
{% endtab %}
{% endtabs %}

Please note that all makers have logical defaults for the `platforms` value so you normally don't need to specify that property.
{% hint style="info" %}
If a Maker supports multiple platforms, you may specify which platforms you want to target. Note that all Makers have logical defaults for the `platforms` value so you normally don't need to specify that property.
{% endhint %}

0 comments on commit fdbaab2

Please sign in to comment.