GITBOOK-189: correct heading levels

electron-forge · Jul 13, 2024 · a0dc887 · a0dc887
1 parent e476e4c
commit a0dc887
Show file tree

Hide file tree

Showing 10 changed files with 37 additions and 37 deletions.
diff --git a/config/makers/appx.md b/config/makers/appx.md
@@ -8,17 +8,17 @@ description: >-
 
 The AppX target builds `.appx` packages which are designed to target the [Microsoft Store](https://apps.microsoft.com/home).
 
-### Requirements
+## Requirements
 
 You can only build the AppX target on Windows 10 or 11 machines with the [Windows SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/) installed. Check the [`electron-windows-store` docs](https://github.com/electron-userland/electron-windows-store) for more information on platform requirements.
 
-### Installation
+## Installation
 
 ```bash
 npm install --save-dev @electron-forge/maker-appx
 ```
 
-### Usage
+## Usage
 
 To use `@electron-forge/maker-appx`, add it to the `makers` array in your [Forge configuration](../configuration.md):
 
@@ -41,6 +41,6 @@ module.exports = {
 
 Configuration options are documented in [`MakerAppXConfig`](https://js.electronforge.io/interfaces/\_electron\_forge\_maker\_appx.MakerAppXConfig.html).
 
-### Debugging
+## Debugging
 
 For advanced debug logging for this maker, add the `DEBUG=electron-windows-store*` environment variable.
diff --git a/config/makers/deb.md b/config/makers/deb.md
@@ -8,17 +8,17 @@ description: >-
 
 The deb target builds [`.deb` packages](https://www.debian.org/doc/manuals/debian-faq/pkg-basics.en.html), which are the standard package format for Debian-based Linux distributions such as [Ubuntu](https://ubuntu.com/).
 
-### Requirements
+## Requirements
 
 You can only build the deb target on Linux or macOS machines with the [`fakeroot`](https://wiki.debian.org/FakeRoot) and [`dpkg`](https://wiki.debian.org/dpkg) packages installed.
 
-### Installation
+## Installation
 
 ```bash
 npm install --save-dev @electron-forge/maker-deb
 ```
 
-### Usage
+## Usage
 
 To use `@electron-forge/maker-deb`, add it to the `makers` array in your [Forge configuration](../configuration.md):
 
@@ -42,6 +42,6 @@ module.exports = {
 
 Configuration options are documented in [`MakerDebConfig`](https://js.electronforge.io/interfaces/\_electron\_forge\_maker\_deb.MakerDebConfig.html).
 
-### Debugging
+## Debugging
 
 For advanced debug logging for this maker, add the `DEBUG=electron-installer-deb*` environment variable.
diff --git a/config/makers/dmg.md b/config/makers/dmg.md
@@ -6,17 +6,17 @@ description: Generate a DMG with Electron Forge to distribute your Electron app
 
 The DMG target builds Apple Disk Image (`.dmg`) files, which are the standard format for sharing macOS apps. The DMG acts like a ZIP file, but provides an easy way for users to take the app and put it in the `/Applications` directory.
 
-### Requirements
+## Requirements
 
 You can only build the DMG target on macOS machines.
 
-### Installation
+## Installation
 
 ```sh
 npm install --save-dev @electron-forge/maker-dmg
 ```
 
-### Usage
+## Usage
 
 To use `@electron-forge/maker-dmg`, add it to the `makers` array in your [Forge configuration](../configuration.md):
 
@@ -38,6 +38,6 @@ module.exports = {
 
 Configuration options are documented in [`MakerDMGConfig`](https://js.electronforge.io/interfaces/\_electron\_forge\_maker\_dmg.MakerDMGConfig.html).
 
-### Debugging
+## Debugging
 
 For advanced debug logging for this maker, add the `DEBUG=electron-installer-dmg*` environment variable.
diff --git a/config/makers/flatpak.md b/config/makers/flatpak.md
@@ -6,17 +6,17 @@ description: Create a Flatpak app for your Electron app using Electron Forge.
 
 The Flatpak target builds [`.flatpak` files](http://flatpak.org/), which is a packaging format for Linux distributions that allows for sandboxed installation of applications in isolation from the rest of their system. In contrast, typical [deb.md](deb.md "mention") or [rpm.md](rpm.md "mention") installation methods are not sandboxed.
 
-### Requirements
+## Requirements
 
 You can only build the Flatpak target if you have [`flatpak`](https://docs.flatpak.org/en/latest/flatpak-command-reference.html#flatpak), [`flatpak-builder`](https://docs.flatpak.org/en/latest/flatpak-builder-command-reference.html#flatpak-builder), and `eu-strip` _(usually part of the_ [_`elfutils`_](https://sourceware.org/elfutils/) _package)_ installed on your system.
 
-### Installation
+## Installation
 
 ```sh
 npm install --save-dev @electron-forge/maker-flatpak
 ```
 
-### Usage
+## Usage
 
 To use `@electron-forge/maker-flatpak`, add it to the `makers` array in your [Forge configuration](../configuration.md):
 
@@ -38,6 +38,6 @@ module.exports = {
 
 Configuration options are documented in [`MakerFlatpakConfig`](https://js.electronforge.io/classes/\_electron\_forge\_maker\_flatpak.MakerFlatpak-1.html#config).
 
-### Debugging
+## Debugging
 
 For advanced debug logging for this maker, add the `DEBUG=electron-installer-flatpak*` environment variable.
diff --git a/config/makers/pkg.md b/config/makers/pkg.md
@@ -15,17 +15,17 @@ The flat installer package format is sparsely documented by Apple. If you want t
 * [Flat Package Format - The missing documentation](http://s.sudre.free.fr/Stuff/Ivanhoe/FLAT.html) (Stéphane Sudre)
 * [The Flat Package - Examining a newer package format](https://preserve.mactech.com/articles/mactech/Vol.26/26.02/TheFlatPackage/index.html) (MacTech)
 
-### Requirements
+## Requirements
 
 You can only build the pkg target on macOS machines while targeting the `darwin` or `mas` platforms.
 
-### Installation
+## Installation
 
 ```bash
 npm install --save-dev @electron-forge/maker-pkg
 ```
 
-### Usage
+## Usage
 
 To use `@electron-forge/maker-pkg`, add it to the `makers` array in your [Forge configuration](../configuration.md):
 
@@ -84,7 +84,7 @@ module.exports = {
 
 </code></pre>
 
-### Debugging
+## Debugging
 
 All logs for your flat package installer can be found in macOS installation logs, which are stored in `/var/log/install.log`. They are also accessible within the [Console.app](https://support.apple.com/en-ca/guide/console/welcome/mac) utility.
 

diff --git a/config/makers/rpm.md b/config/makers/rpm.md
@@ -8,7 +8,7 @@ description: >-
 
 The RPM target builds `.rpm` files, which is the standard package format for Red Hat-based Linux distributions such as [Fedora](https://fedoraproject.org/) and [Red Hat Enterprise Linux](https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux) (RHEL).
 
-### Requirements
+## Requirements
 
 You can only build the RPM target on Linux machines with the `rpm` or `rpm-build` packages installed.
 
@@ -24,13 +24,13 @@ While on Debian or Ubuntu you'll need to do this:
 sudo apt-get install rpm
 ```
 
-### Installation
+## Installation
 
 ```shell
 npm install --save-dev @electron-forge/maker-rpm
 ```
 
-### Usage
+## Usage
 
 To use `@electron-forge/maker-rpm`, add it to the `makers` array in your [Forge configuration](../configuration.md):
 
@@ -53,6 +53,6 @@ module.exports = {
 
 Configuration options are documented in [`MakerRpmConfig`](https://js.electronforge.io/interfaces/\_electron\_forge\_maker\_rpm.MakerRpmConfig.html).
 
-### Debugging
+## Debugging
 
 For advanced debug logging for this maker, add the `DEBUG=electron-installer-redhat*` environment variable.
diff --git a/config/makers/snapcraft.md b/config/makers/snapcraft.md
@@ -6,17 +6,17 @@ description: Create a Snap package for your Electron app using Electron Forge.
 
 The [Snapcraft](https://snapcraft.io/) target builds `.snap` files, which is the packaging format created and sponsored by Canonical, the company behind Ubuntu. It is a sandboxed package format that lets users of various Linux distributions install your application in an isolated environment on their machine.
 
-### Requirements
+## Requirements
 
 You can only build the Snapcraft target on Linux systems with the [`snapcraft`](https://snapcraft.io/) package installed.
 
-### Installation
+## Installation
 
 ```bash
 npm install --save-dev @electron-forge/maker-snap
 ```
 
-### Usage
+## Usage
 
 To use `@electron-forge/maker-snap`, add it to the `makers` array in your [Forge configuration](../configuration.md):
 
@@ -42,6 +42,6 @@ module.exports = {
 
 Configuration options are documented in [`MakerSnapConfig`](https://js.electronforge.io/modules/\_electron\_forge\_maker\_snap.html#MakerSnapConfig).
 
-### Debugging
+## Debugging
 
 For advanced debug logging for this maker, add the `DEBUG=electron-installer-snap*` environment variable.
diff --git a/config/makers/squirrel.windows.md b/config/makers/squirrel.windows.md
@@ -10,17 +10,17 @@ The Squirrel.Windows target builds your application using the [Squirrel.Windows]
 
 Squirrel.Windows is a no-prompt, no-hassle, no-admin method of installing Windows applications, and is therefore the most user friendly you can get.
 
-### Requirements
+## Requirements
 
 You can only build the Squirrel.Windows target on a Windows machine or on a Linux machine with [`mono`](https://www.mono-project.com/) and [`wine`](https://www.winehq.org/) installed.
 
-### Installation
+## Installation
 
 ```bash
 npm install --save-dev @electron-forge/maker-squirrel
 ```
 
-### Usage
+## Usage
 
 Add this module to the [makers](./) section of your [Forge configuration](../configuration.md):
 
@@ -102,6 +102,6 @@ if (require('electron-squirrel-startup')) app.quit();
 ```
 {% endcode %}
 
-### Debugging
+## Debugging
 
 For advanced debug logging for this maker, add the `DEBUG=electron-windows-installer*` environment variable.
diff --git a/config/makers/wix-msi.md b/config/makers/wix-msi.md
@@ -10,21 +10,21 @@ The WiX MSI target builds `.msi` files, which are "traditional" Windows installe
 We generally recommend using the [squirrel.windows.md](squirrel.windows.md "mention") target over using this one. These MSI files are a worse user experience for installation but sometimes it is necessary to build MSI files to appease large-scale enterprise companies with internal application distribution policies.
 {% endhint %}
 
-### Requirements
+## Requirements
 
 You can only build the WiX MSI target on machines with [WiX Toolset v3](https://wixtoolset.org/docs/wix3/) installed. We recommend pinning your installation of WiX Toolset to a specific version. You can install WiX Toolset on Windows via [Chocolatey](https://chocolatey.org/).
 
 ```bash
 choco install wixtoolset  --version=3.14.0
 ```
 
-### Installation
+## Installation
 
 ```bash
 npm install --save-dev @electron-forge/maker-wix
 ```
 
-### Usage
+## Usage
 
 To use `@electron-forge/maker-wix`, add it to the `makers` array in your [Forge configuration](../configuration.md):
 

diff --git a/config/makers/zip.md b/config/makers/zip.md
@@ -6,13 +6,13 @@ description: Create a ZIP archive for your Electron app using Electron Forge.
 
 The ZIP target builds basic [.zip archives](https://en.wikipedia.org/wiki/ZIP\_\(file\_format\)) containing your packaged application. There are no platform-specific dependencies for using this maker and it will run on any platform.
 
-### Installation
+## Installation
 
 ```bash
 npm install --save-dev @electron-forge/maker-zip
 ```
 
-### Usage
+## Usage
 
 To use `@electron-forge/maker-zip`, add it to the `makers` array in your Forge configuration.