mkdocs.yml

# The user guide website (GitHub Pages), built from the pages in docs by .github/workflows/pages.yml.
# Preview locally: pip install -r docs/requirements.txt, then python -m mkdocs serve (http://127.0.0.1:8000).
site_name: OrthoStreamXP user guide
site_description: Streamed photo scenery for X-Plane 12
site_url: https://flysimdev.github.io/OrthoStreamXP/
repo_url: https://github.com/flysimdev/OrthoStreamXP
repo_name: flysimdev/OrthoStreamXP
edit_uri: edit/main/docs/

docs_dir: docs
# The PDF's stylesheet and the site's build requirements are not pages.
exclude_docs: |
  user-guide.css
  requirements.txt

# The same order as the guide's contents (docs/README.md) and build-user-guide.ps1.
nav:
  - Home: README.md
  - installation.md
  - first-setup.md
  - flying.md
  - settings.md
  - cache.md
  - packages.md
  - troubleshooting.md
  - Questions and answers: faq.md
  - User guide (PDF): OrthoStreamXP-UserGuide.pdf

theme:
  name: material
  features:
    - navigation.instant
    - navigation.top
    - toc.follow
    - search.highlight
    - content.action.edit
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-night
        name: Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Light mode

markdown_extensions:
  - admonition
  - attr_list
  # Code blocks inside list items (the default fenced_code only handles them at the start of a line).
  - pymdownx.superfences
  - toc:
      permalink: true