mkdocs.yml

# CQtDeployer documentation site (GitHub Pages)
#
# A classic Markdown documentation site built with MkDocs + the Material
# theme. The content is the md/ wiki (the English and Russian
# documentation of the project), so the site is generated straight from
# Markdown without Doxygen. Before `mkdocs build` runs, the
# "Deploy Documentation (GitHub Pages)" workflow copies the root
# README.md to docs/index.md (the site home page) and mirrors the md/
# tree and the banner image into docs/, because the README references
# them with relative links.

site_name: CQtDeployer
site_description: CQtDeployer helps you to extract all libraries your executable depends on and to create a launch script for your application.
site_url: https://quasarapp.github.io/CQtDeployer/

repo_name: QuasarApp/CQtDeployer
repo_url: https://github.com/QuasarApp/CQtDeployer
edit_uri: https://github.com/QuasarApp/CQtDeployer/edit/main/

docs_dir: docs
site_dir: site

theme:
  name: material
  palette:
    - scheme: default
      # Orange brand palette derived from the project banner
      # (res/CQtDeployer banner.png, dominant burnt orange ~#b06030),
      # expressed through Material's named "orange" color so the site
      # needs no custom CSS. The palette is intentionally different
      # from the sibling documentation sites (Heart: maroon,
      # OpenSimplex2: teal). Orange top bar, orange links.
      primary: orange
      accent: orange
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
    - scheme: slate
      # Same orange top bar on the slate neutrals. The slate links are
      # derived from the primary color by the theme, so the same orange
      # accent keeps both schemes consistent (Material ships prebuilt
      # accent rules for the base color names only).
      primary: orange
      accent: orange
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - content.code.copy
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.suggest
    - toc

markdown_extensions:
  - admonition
  - attr_list
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  # index.md is copied from the root README.md by the documentation
  # workflow before the MkDocs build, so the README stays the single
  # source of truth and the generated copy is not committed.
  - Home: index.md
  # The wiki landing page (md/README.md) offers the language choice.
  - Documentation: md/Home.md
  # The English documentation (md/).
  - English:
      - Welcome: md/Home.md
      - What is CQtDeployer: md/Description.md
      - Quick guide: md/QuickGuide.md
      - How to deploy: md/Guide.md
      - Install CQtDeployer: md/Build-and-Install.md
      - GitHub Actions: md/GitHubActions.md
      - Options: md/Options.md
      - Deployment file: md/DeployConfigFile.md
      - Qt Installer Framework: md/QIF.md
      - Environment variables: md/EnvironmentVariables.md
      - Custom scripts: md/CustomScripts.md
      - Code signing of the QtIFW installer: md/Signing.md
      - Extra files: md/ExtraFiles.md
      - Default templates: md/ExtractDefaultsTemplates.md
      - Disabling shortcuts: md/DisableShortcats.md
      - Packaging: md/Packing.md
      - ZIP: md/ZIP.md
      - DEB: md/DEB.md
      - AppImage: md/AppImage.md
      - DMG: md/DMG.md
      - arm machines: md/arm.md
      - macOS: md/macOS.md
      - Compare features: md/CompareFeatures.md
      - Release reviews: md/ReleaseReviews.md
      - Change log: md/Changelog.md
      - Releases:
          - 1.6: md/1_6.md
          - 1.5: md/1_5.md
          - 1.4: md/1_4.md

  # The Marketplace page (md/Marketplace/) describes how to obtain the
  # application.
  - Marketplace: md/Marketplace/Marketplace.md