chore(docs): fixing indentation of typedoc and TOC depth/padding (#8657)

electron-userland · Nov 3, 2024 · b06c5ef · b06c5ef
1 parent 2593a1f
commit b06c5ef
Show file tree

Hide file tree

Showing 21 changed files with 37 additions and 40 deletions.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -68,9 +68,12 @@ markdown_extensions:
   - pymdownx.tilde
   - toc:
       permalink: true
+      toc_depth: 5
   - markdown_include.include:
       base_path      : './docs/'
       encoding       : 'utf-8'
+      # headingOffset  : 2
+      inheritHeadingDepth : true
 
 plugins:
   - search

diff --git a/pages/appimage.md b/pages/appimage.md
@@ -5,4 +5,4 @@ The top-level [appImage](configuration.md#appImage) key contains set of options
 
 ## Configuration
 
-{!./app-builder-lib.Interface.AppImageOptions.md!}
+  {!./app-builder-lib.Interface.AppImageOptions.md!}
diff --git a/pages/appx.md b/pages/appx.md
@@ -52,4 +52,4 @@ If you use self-signed certificate, you need to add it to "Trusted People". See
 
 ## Configuration
 
-{!./app-builder-lib.Interface.AppXOptions.md!}
+  {!./app-builder-lib.Interface.AppXOptions.md!}
diff --git a/pages/auto-update.md b/pages/auto-update.md
@@ -213,4 +213,4 @@ Emitted on progress.
 
 ## UpdateInfo
 
-{!./electron-updater.Interface.UpdateInfo.md!}
+  {!./electron-updater.Interface.UpdateInfo.md!}
diff --git a/pages/configuration.md b/pages/configuration.md
@@ -36,7 +36,7 @@ Env file `electron-builder.env` in the current dir ([example](https://github.com
 
 ### Common Configuration
 
-{!./app-builder-lib.Interface.CommonConfiguration.md!}
+  {!./app-builder-lib.Interface.CommonConfiguration.md!}
 
 ---
 
@@ -46,12 +46,12 @@ Following options can be set also per platform (top-level keys [mac](mac.md), [l
 
 ## Base Configuration
 
-{!./app-builder-lib.Interface.PlatformSpecificBuildOptions.md!}
+  {!./app-builder-lib.Interface.PlatformSpecificBuildOptions.md!}
 
 ## Metadata
 Some standard fields should be defined in the `package.json`.
 
-{!./app-builder-lib.Interface.Metadata.md!}
+  {!./app-builder-lib.Interface.Metadata.md!}
 
 ## Proton Native
 
@@ -61,4 +61,6 @@ Currently, only macOS and Linux supported.
 ## Build Version Management
 `CFBundleVersion` (macOS) and `FileVersion` (Windows) will be set automatically to `version.build_number` on CI server (Travis, AppVeyor, CircleCI and Bamboo supported).
 
-{!./hooks.md!}
+## Build Hooks
+
+  {!./hooks.md!}
diff --git a/pages/contents.md b/pages/contents.md
@@ -1,7 +1,7 @@
 ## File Contents
 
-#{!./app-builder-lib.Interface.FilesBuildOptions.md!}
+  {!./app-builder-lib.Interface.FilesBuildOptions.md!}
 
 ## FileSet Configuration
 
-#{!./app-builder-lib.Interface.FileSet.md!}
+  {!./app-builder-lib.Interface.FileSet.md!}
diff --git a/pages/dmg.md b/pages/dmg.md
@@ -20,4 +20,4 @@ The contain file should have the following format:
 
 ## Configuration
 
-{!./app-builder-lib.Interface.DmgOptions.md!}
+  {!./app-builder-lib.Interface.DmgOptions.md!}
diff --git a/pages/linux.md b/pages/linux.md
@@ -2,19 +2,19 @@ The top-level [linux](configuration.md#linux) key contains set of options instru
 
 ## Base Linux Configuration
 
-{!./app-builder-lib.Interface.LinuxConfiguration.md!}
+  {!./app-builder-lib.Interface.LinuxConfiguration.md!}
 
 ## Debian Package Options
 
 The top-level [deb](configuration.md#deb) key contains set of options instructing electron-builder on how it should build Debian package.
 
-{!./app-builder-lib.Interface.DebOptions.md!}
+  {!./app-builder-lib.Interface.DebOptions.md!}
 
 All [LinuxTargetSpecificOptions](linux.md#linuxtargetspecificoptions-apk-freebsd-pacman-p5p-and-rpm-options) can be also specified in the `deb` to customize Debian package.
 
 ## `LinuxTargetSpecificOptions` APK, FreeBSD, Pacman, P5P and RPM Options
 
 The top-level `apk`, `freebsd`, `pacman`, `p5p` and `rpm` keys contains set of options instructing electron-builder on how it should build corresponding Linux target.
 
-{!./app-builder-lib.Interface.LinuxTargetSpecificOptions.md!}
+  {!./app-builder-lib.Interface.LinuxTargetSpecificOptions.md!}
 
diff --git a/pages/mac.md b/pages/mac.md
@@ -2,8 +2,8 @@ The top-level [mac](configuration.md#mac) key contains set of options instructin
 
 ## Configuration
 
-{!./app-builder-lib.Interface.MacConfiguration.md!}
+  {!./app-builder-lib.Interface.MacConfiguration.md!}
 
 ## Notarize Configuration
 
-{!./app-builder-lib.Interface.NotarizeNotaryOptions.md!}
+  {!./app-builder-lib.Interface.NotarizeNotaryOptions.md!}
diff --git a/pages/mas.md b/pages/mas.md
@@ -3,5 +3,5 @@ Inherits [macOS options](mac.md).
 
 ## Configuration
 
-{!./app-builder-lib.Interface.MasConfiguration.md!}
+  {!./app-builder-lib.Interface.MasConfiguration.md!}
 
diff --git a/pages/msi-wrapped.md b/pages/msi-wrapped.md
@@ -1,3 +1,3 @@
 ## Configuration
 
-{!./app-builder-lib.Interface.MsiWrappedOptions.md!}
+  {!./app-builder-lib.Interface.MsiWrappedOptions.md!}
diff --git a/pages/msi.md b/pages/msi.md
@@ -1,3 +1,3 @@
 ## Configuration
 
-{!./app-builder-lib.Interface.MsiOptions.md!}
+  {!./app-builder-lib.Interface.MsiOptions.md!}
diff --git a/pages/nsis.md b/pages/nsis.md
@@ -151,4 +151,4 @@ For portable app, following environment variables are available:
 
 ## Configuration
 
-{!./app-builder-lib.Interface.NsisOptions.md!}
+  {!./app-builder-lib.Interface.NsisOptions.md!}
diff --git a/pages/pkg.md b/pages/pkg.md
@@ -2,4 +2,4 @@ The top-level [pkg](configuration.md#pkg) key contains set of options instructin
 
 ## Configuration
 
-{!./app-builder-lib.Interface.PkgOptions.md!}
+  {!./app-builder-lib.Interface.PkgOptions.md!}
diff --git a/pages/publish.md b/pages/publish.md
@@ -117,29 +117,23 @@ Detected automatically using:
 # Publishers
 
 ## Bitbucket
-{!./builder-util-runtime.Interface.BitbucketOptions.md!}
+  {!./builder-util-runtime.Interface.BitbucketOptions.md!}
 
 ## Github
-
-{!./builder-util-runtime.Interface.GithubOptions.md!}
+  {!./builder-util-runtime.Interface.GithubOptions.md!}
 
 ## Keygen
-
-{!./builder-util-runtime.Interface.KeygenOptions.md!}
+  {!./builder-util-runtime.Interface.KeygenOptions.md!}
 
 ## S3
-
-{!./builder-util-runtime.Interface.S3Options.md!}
+  {!./builder-util-runtime.Interface.S3Options.md!}
 
 ## Snap Store
-
-{!./builder-util-runtime.Interface.SnapStoreOptions.md!}
+  {!./builder-util-runtime.Interface.SnapStoreOptions.md!}
 
 ## Spaces
-
-{!./builder-util-runtime.Interface.SpacesOptions.md!}
+  {!./builder-util-runtime.Interface.SpacesOptions.md!}
 
 ## BYO Generic (create-your-own)
-
 (And maybe submit it upstream in a PR!)
-{!./builder-util-runtime.Interface.GenericServerOptions.md!}
+  {!./builder-util-runtime.Interface.GenericServerOptions.md!}
diff --git a/pages/snap.md b/pages/snap.md
@@ -2,4 +2,4 @@ The top-level [snap](configuration.md#snap) key contains set of options instruct
 
 ## Configuration
 
-{!./app-builder-lib.Interface.SnapOptions.md!}
+  {!./app-builder-lib.Interface.SnapOptions.md!}
diff --git a/pages/squirrel-windows.md b/pages/squirrel-windows.md
@@ -9,4 +9,4 @@ Your app must be able to handle Squirrel.Windows startup events that occur durin
 
 ## Configuration
 
-{!./app-builder-lib.Interface.SquirrelWindowsOptions.md!}
+  {!./app-builder-lib.Interface.SquirrelWindowsOptions.md!}
diff --git a/pages/stylesheets/autowidth.css b/pages/stylesheets/autowidth.css
@@ -7,4 +7,4 @@
 }
 
 /* Hide TOC elements less than h3 */
-.md-nav--secondary .md-nav__list .md-nav__list .md-nav__list { display: none }
+/* .md-nav--secondary .md-nav__list .md-nav__list .md-nav__list { display: none } */
diff --git a/pages/tutorials/adding-electron-fuses.md b/pages/tutorials/adding-electron-fuses.md
@@ -56,4 +56,4 @@ npx @electron/fuses read --app /Applications/Foo.app
 ```
 
 ## Typedoc
-{!./app-builder-lib.Interface.FuseOptionsV1.md!}
+  {!./app-builder-lib.Interface.FuseOptionsV1.md!}
diff --git a/pages/win.md b/pages/win.md
@@ -94,4 +94,4 @@ VirtualBox is not supported by electron-builder for now, so, you need to setup b
 
 ## Configuration
 
-{!./app-builder-lib.Interface.WindowsConfiguration.md!}
+  {!./app-builder-lib.Interface.WindowsConfiguration.md!}
diff --git a/typedoc.config.js b/typedoc.config.js
@@ -49,7 +49,5 @@ module.exports = {
     private: false,
     inherited: false,
     external: false,
-    "@alpha": false,
-    "@beta": false,
   },
 }