electron-builder/mkdocs.yml

139 lines
3.6 KiB
YAML

site_name: electron-builder
site_url: https://www.electron.build
use_directory_urls: false
extra_css:
- stylesheets/autowidth.css
theme:
name: material
features:
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.code.select
- content.tooltips
- header.autohide
- navigation.expand
- navigation.sections
# - navigation.prune
# - search.highlight
# - search.share
# - search.suggest
- toc.follow
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue
accent: blue
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-night
name: Switch to system preference
font:
text: Roboto
code: Roboto Mono
repo_name: electron-userland/electron-builder
repo_url: 'https://github.com/electron-userland/electron-builder'
edit_uri: ""
strict: false
extra:
analytics:
provider: google
property: UA-105592680-1
extra_javascript:
- extra.js
markdown_extensions:
- admonition
- smarty
- pymdownx.smartsymbols
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- toc:
permalink: true
toc_depth: 5
- markdown_include.include:
base_path : './docs/'
encoding : 'utf-8'
# headingOffset : 2
inheritHeadingDepth : true
plugins:
- search
nav:
- Introduction: README.md
- Command Line Interface (CLI): cli.md
- Donate: donate.md
- Programmatic API:
- Example: programmatic-usage.md
- Main Modules:
- electron-builder: electron-builder/globals.md
- app-builder-lib: app-builder-lib/globals.md
- electron-updater: electron-updater/globals.md
- electron-publish: electron-publish/globals.md
- Configuration:
- Common Configuration: configuration.md
- Application Contents: contents.md
- File Patterns: file-patterns.md
- macOS:
- Any macOS Target: mac.md
- DMG: dmg.md
- MAS: mas.md
- PKG: pkg.md
- Windows:
- Any Windows Target: win.md
- NSIS: nsis.md
- AppX: appx.md
- MSI: msi.md
- MSI Wrapped: msi-wrapped.md
- Squirrel.Windows: squirrel-windows.md
- Linux:
- Any Linux Target: linux.md
- AppImage: appimage.md
- Flatpak: flatpak.md
- Snap: snap.md
- Publish: publish.md
- Guides:
- Build Hooks: hooks.md
- Icons: icons.md
- Auto Update: auto-update.md
- Code Signing:
- Setup: code-signing.md
- Windows: code-signing-win.md
- MacOS: code-signing-mac.md
- Multi Platform Build: multi-platform-build.md
- Tutorials:
- Configuring Electron Fuses: tutorials/adding-electron-fuses.md
- Loading App Dependencies Manually: tutorials/loading-app-dependencies-manually.md
- Two package.json Structure: tutorials/two-package-structure.md
- macOS Kernel Extensions: tutorials/macos-kernel-extensions.md
- Sign a Windows app on macOS/Linux: tutorials/code-signing-windows-apps-on-unix.md
- Release Using Channels: tutorials/release-using-channels.md
- Test Update on s3 Locally: tutorials/test-update-on-s3-locally.md