[skip ci] docs: adjust headers

Author: nklayman

docs/.vuepress/config.js

@@ -33,7 +33,6 @@ module.exports = {
         'upgrading'
       ]
     },
-    displayAllHeaders: true,
     repo: 'nklayman/vue-cli-plugin-electron-builder',
     docsDir: 'docs',
     editLinks: true,

docs/guide/README.md

@@ -3,7 +3,7 @@ title: Quick Start
 sidebarDepth: 2
 ---
 
-## Quick Start
+# Quick Start
 
 ::: warning Important
 Your app must be created with Vue-CLI 3 (vue create my-app), will not work with Vue-CLI 2 (vue init webpack my-app)!
@@ -13,7 +13,7 @@ Your app must be created with Vue-CLI 3 (vue create my-app), will not work with
 These docs are for the v1.0.0-beta release of VCP Electron Builder. If you were previously using an older version of vue-cli-plugin-electron-builder (<1.0.0), please see the [upgrade guide](./upgrading.md) or [view the old docs](https://github.com/nklayman/vue-cli-plugin-electron-builder/tree/legacy).
 :::
 
-### Installation
+## Installation
 
 Open a terminal in the directory of your app created with Vue-CLI 3.
 
@@ -23,7 +23,7 @@ Then, install and invoke the generator of vue-cli-plugin-electron-builder by run
 
 That's It! You're ready to go!
 
-### To start a development server
+## To start a development server
 
 If you use [Yarn](https://yarnpkg.com/en/) (strongly recommended):
 
@@ -33,7 +33,7 @@ or if you use NPM:
 
 `npm run serve:electron`
 
-### To build your app
+## To build your app
 
 With Yarn:
 

docs/guide/configuration.md

@@ -2,9 +2,9 @@
 sidebarDepth: 2
 ---
 
-## Configuration
+# Configuration
 
-### Configuring Electron Builder
+## Configuring Electron Builder
 
 To see available options, check out [Electron Builder Configuration Options](https://www.electron.build/configuration/configuration)
 
@@ -14,21 +14,21 @@ They can be placed under the `builderOptions` key in vue-cli-plugin-electron-bui
 // vue.config.js
 
 module.exports = {
-  pluginOptions: {
-    electronBuilder: {
-      builderOptions: {
-        // options placed here will be merged with default configuration and passed to electron-builder
-      }
+    pluginOptions: {
+        electronBuilder: {
+            builderOptions: {
+                // options placed here will be merged with default configuration and passed to electron-builder
+            }
+        }
     }
-  }
 }
 ```
 
 :::tip
 All CLI arguments passed to `build:electron` will be forwarded to electron-builder.
 :::
 
-### Webpack configuration
+## Webpack configuration
 
 Your regular config is used for bundling the renderer process (your app). To modify the webpack config for the electron main process only, use the `chainWebpackMainProcess` function under vue-cli-plugin-electron-builder's plugin options in `vue.config.js`. Use `chainWebpackRendererProcess` customize your app's webpack config for Electron builds only. To learn more about webpack chaining, see [webpack-chain](https://github.com/mozilla-neutrino/webpack-chain). The function should take a config argument, modify it through webpack-chain, and then return it.
 
@@ -38,32 +38,32 @@ Your regular config is used for bundling the renderer process (your app). To mod
 // vue.config.js
 
 module.exports = {
-  configureWebpack: {
-    // Configuration applied to all builds
-  },
-  pluginOptions: {
-    electronBuilder: {
-      chainWebpackMainProcess: config => {
-        // Chain webpack config for electron main process only
-      },
-      chainWebpackRendererProcess: config => {
-        // Chain webpack config for electron renderer process only
-        // The following example will set IS_ELECTRON to true in your app
-        config.plugin('define').tap(args => {
-          args[0]['IS_ELECTRON'] = true
-          return args
-        })
-        // If you do not return the config property, your app may break!
-        return config
-      },
-      // Use this to change the entrypoint of your app's main process
-      mainProcessFile: 'src/myBackgroundFile.js'
+    configureWebpack: {
+        // Configuration applied to all builds
+    },
+    pluginOptions: {
+        electronBuilder: {
+            chainWebpackMainProcess: config => {
+                // Chain webpack config for electron main process only
+            },
+            chainWebpackRendererProcess: config => {
+                // Chain webpack config for electron renderer process only
+                // The following example will set IS_ELECTRON to true in your app
+                config.plugin('define').tap(args => {
+                    args[0]['IS_ELECTRON'] = true
+                    return args
+                })
+                // If you do not return the config property, your app may break!
+                return config
+            },
+            // Use this to change the entrypoint of your app's main process
+            mainProcessFile: 'src/myBackgroundFile.js'
+        }
     }
-  }
 }
 ```
 
-### Changing the output directory
+## Changing the output directory
 
 If you don't want your files outputted into dist_electron, you can choose a custom folder in vue-cli-plugin-electron-builder's plugin options.
 
@@ -73,29 +73,29 @@ If you don't want your files outputted into dist_electron, you can choose a cust
 // vue.config.js
 
 module.exports = {
-  pluginOptions: {
-    electronBuilder: {
-      outputDir: 'electron-builder-output-dir'
+    pluginOptions: {
+        electronBuilder: {
+            outputDir: 'electron-builder-output-dir'
+        }
     }
-  }
 }
 ```
 
-### TypeScript Options
+## TypeScript Options
 
 Typescript support is automatic and requires no configuration, just add the `@vue/typescript` cli plugin. There are a few options for configuring typescript if necessary:
 
 ```javascript
 // vue.config.js
 
 module.exports = {
-  pluginOptions: {
-    electronBuilder: {
-      // option: default // description
-      disableMainProcessTypescript: false, // Manually disable typescript plugin for main process. Enable if you want to use regular js for the main process (src/background.js by default).
-      mainProcessTypeChecking: false // Manually enable type checking during webpck bundling for background file.
+    pluginOptions: {
+        electronBuilder: {
+            // option: default // description
+            disableMainProcessTypescript: false, // Manually disable typescript plugin for main process. Enable if you want to use regular js for the main process (src/background.js by default).
+            mainProcessTypeChecking: false // Manually enable type checking during webpck bundling for background file.
+        }
     }
-  }
 }
 ```
 

docs/guide/guide.md

@@ -2,24 +2,24 @@
 sidebarDepth: 2
 ---
 
-## Guide
+# Guide
 
-### Handling static assets
+## Handling static assets
 
-#### Renderer process (main app)
+### Renderer process (main app)
 
 In the renderer process, static assets work similarly to a regular app. Read Vue CLI's documentation [here](https://cli.vuejs.org/guide/html-and-static-assets.html) before continuing. However, there are a few changes made:
 
-- The `__static` global variable is added. It provides a path to your public directory in both development and production. Use this to read/write files in your app's public directory.
-- In production, the `process.env.BASE_URL` is replaced with the path to your app's files.
+-   The `__static` global variable is added. It provides a path to your public directory in both development and production. Use this to read/write files in your app's public directory.
+-   In production, the `process.env.BASE_URL` is replaced with the path to your app's files.
 
 **Note: `__static` is not available in regular build/serve. It should only be used in electron to read/write files on disk. To import a file (img, script, etc...) and not have it be transpiled by webpack, use the `process.env.BASE_URL` instead.**
 
-#### Main process (background.js)
+### Main process (background.js)
 
 The main process won't have access to `process.env.BASE_URL` or `src/assets`. However, you can still use `__static` to get a path to your public directory in development and production.
 
-#### Examples:
+### Examples:
 
 ```vue
 <!-- Renderer process only -->
@@ -43,7 +43,7 @@ console.log(fileContents)
 </script>
 ```
 
-### Folder Structure
+## Folder Structure
 
 ```
 ├── dist_electron/
@@ -61,24 +61,24 @@ console.log(fileContents)
 ├── ...
 ```
 
-### How it works
+## How it works
 
-#### Build command
+### Build command
 
 The build command consists of three main phases: render build, main build, and electron-builder build:
 
 1.  Render build: This phase calls `vue-cli-service build` with some custom configuration so it works properly with electron. (The render process is your standard app.)
 2.  Main build: This phase is where vue-cli-plugin-electron-builder bundles your background file for the main process (`src/background.js`).
 3.  Electron-builder build: This phase uses [electron-builder](https://www.electron.build) to turn your web app code into an desktop app powered by [Electron](https://electronjs.org).
 
-#### Serve command
+### Serve command
 
 The serve command also consists of 3 main phases: main build, dev server launch, and electron launch:
 
 1.  Dev server launch: This phase starts the built in dev server with a few modifications to work properly with electron.
 2.  Main build: This phase, like in the build command, bundles your app's main process, but in development mode.
 3.  Electron launch: This phase launches electron and tells it to load the url of the above dev server.
 
-### Is this plugin production ready?
+## Is this plugin production ready?
 
 This plugin is nearly production ready. It has test coverage for everything but the UI interface and proper logging of errors. It needs to be used a little bit more in large applications before it is considered safe to use in a large production environment. Please try it in your app and report any bugs or feature requests.

docs/guide/testingAndDebugging.md

@@ -2,23 +2,23 @@
 sidebarDepth: 2
 ---
 
-## Testing and Debugging
+# Testing and Debugging
 
-### Debugging
+## Debugging
 
-#### Renderer Process (Main App)
+### Renderer Process (Main App)
 
 You can debug the renderer process using [Vue Devtools](https://github.com/vuejs/vue-devtools). Vue Devtools are automatically installed for you (powered by [electron-devtools-installer](https://github.com/MarshallOfSound/electron-devtools-installer)).
 
-#### Main Process (Background File)
+### Main Process (Background File)
 
 First, read [Electron's instructions](https://electronjs.org/docs/tutorial/debugging-main-process#command-line-switches) for debugging the main process. Before launching Electron through your debugger, run `serve:electron` in debug mode with the `--debug` argument. This will prevent Electron from launching automatically and enable source map support. Make sure to set the background file `dist_electron/background.js`.
 
 ::: tip
 If you are testing with spectron, make sure to set `process.env.IS_TEST` to `true`. This will prevent dev tools from being loaded which results in errors.
 :::
 
-### Testing
+## Testing
 
 :::tip
 If you don't want to use Spectron, you can still use this function, just set `noSpectron` to `true`
@@ -34,15 +34,15 @@ vue-cli-plugin-electron-builder exports a `testWithSpectron` function. This func
 const { testWithSpectron } = require('vue-cli-plugin-electron-builder')
 
 test('a window is created', async () => {
-  const { stdout, url, stopServe, app } = await testWithSpectron()
-  // stdout is the log of serve:electron
-  console.log(`serve:electron returned: ${stdout}`)
-  // url is the url for the dev server created with serve:electron
-  console.log(`the dev server url is: ${url}`)
-  // app is a spectron instance. It is attached to the dev server, launched, and waited for to load.
-  expect(await app.client.getWindowCount()).toBe(1)
-  // Before your tests end, make sure to stop the dev server and spectron
-  await stopServe()
+    const { stdout, url, stopServe, app } = await testWithSpectron()
+    // stdout is the log of serve:electron
+    console.log(`serve:electron returned: ${stdout}`)
+    // url is the url for the dev server created with serve:electron
+    console.log(`the dev server url is: ${url}`)
+    // app is a spectron instance. It is attached to the dev server, launched, and waited for to load.
+    expect(await app.client.getWindowCount()).toBe(1)
+    // Before your tests end, make sure to stop the dev server and spectron
+    await stopServe()
 })
 ```