mkdocs.yml

site_name: IronCore / Libvirt Provider
repo_url: https://github.com/ironcore-dev/libvirt-provider/
edit_uri: edit/main/docs/
theme:
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.expand
    - navigation.indexes
    - navigation.top
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  font:
    text: 'Work Sans'

plugins:
  - search

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets
  - codehilite
  - admonition
  - abbr
  - toc:
      permalink: true

nav:
  - Home: README.md
  - Architecture: architecture.md
  - Concepts:
      - Console: concepts/console.md
      - Events: concepts/events.md
      - Plugins:
        - NIC: concepts/plugins/nic.md
        - Volume: concepts/plugins/volume.md
  - Usage: usage.md
  - Development Guide:
      - Local Setup: development/dev_setup.md
      - Documentation: development/dev_docs.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ironcore-dev/libvirt-provider