mkdocs.yml

site_name: Asahi Linux Documentation
site_url: https://asahilinux.org/docs/

repo_url: https://github.com/AsahiLinux/docs
repo_name: AsahiLinux/docs

nav:
  - Overview: index.md
  - Feature Support:
    - Overview: Feature-Support.md
    - M1 Series Feature Support: M1-Series-Feature-Support.md
    - M2 Series Feature Support: M2-Series-Feature-Support.md
    - M3 Series Feature Support: M3-Series-Feature-Support.md
    - M4 Series Feature Support: M4-Series-Feature-Support.md
  - Project related:
    - Glossary: Glossary.md
    - FAQ: FAQ.md
    - When will Asahi Linux be done?: When-will-Asahi-Linux-be-done.md
    - References: Project-References.md
  - Platform documentation:
    - Apple Silicon Subsystems: Apple-Silicon-Subsystems.md
    - Apple Platform Security Crash Course: Apple-Platform-Security-Crash-Course.md
    - Devices: Devices.md
    - Codenames: Codenames.md
    - Display Controllers: Display-Controllers.md
  - For users:
    - Fedora Asahi Remix Documentation <i class="fa-solid fa-arrow-up-right-from-square"></i>: https://docs.fedoraproject.org/en-US/fedora-asahi-remix/
    - Broken Software: Broken-Software.md
    - Alternative Distros: SW-Alternative-Distros.md
  - For developers:
    - Yaks in need of shaving (HELP WANTED!): Yaks-in-need-of-shaving.md
    - Tethered Boot Setup (For Developers): Tethered-Boot-Setup-For-Developers.md
    - m1n1:User Guide Boot loader: m1n1-User-Guide.md
    - Hypervisor: SW-Hypervisor.md
    - U-Boot: U-Boot.md
    - Devicetree bindings: SW-DT-bindings.md
    - Open OS ecosystem on Apple Silicon Macs: Open-OS-Ecosystem-on-Apple-Silicon-Macs.md

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.png
  palette:
    - media: "(prefers-color-scheme)"
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    - media: "(prefers-color-scheme: light)"
      primary: custom
      accent: custom
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      primary: custom
      accent: custom
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  features:
    - navigation.expand
    - navigation.instant
    - navigation.sections
    - navigation.tracking
    - navigation.top
    - toc.integrate
  custom_dir: overrides

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - toc:
      baselevel: 4
      permalink: true
  - admonition
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: true
  - pymdownx.tilde

plugins:
  - redirects:
      redirect_maps:
        Software-known-to-have-issues-with-16k-page-size.md: Broken-Software.md
  - search
  - social:
      cards_layout_options:
        background_color: '#F4EAEA'
        color: '#2C2C2C'