mkdocs.yml

site_name: DRE team docs
site_description: >-
  A collection of docs for the DRE team

repo_name: Decentralized Reliability Engineering
repo_url: https://github.com/dfinity/dre/
edit_uri: edit/main/docs/

nav:
  - "ICP Support":
      - Chatbot: "chat/icp-support.md"
  - "General":
      - index.md
      - Getting started: getting-started.md
      - Contributing: contributing.md
      - How to update these docs?: how-to-update-docs.md
  - "K8s":
      - Tips and trics: "k8s/tips-and-tricks.md"
  - "How to ...":
      - Create a neuron: create-a-neuron.md
      - Make a release: make-release.md
      - Submit NNS proposal: nns-proposals.md
      - Run qualification: qualification/running-qualification.md
      - Decentralization: decentralization.md
      - Release controller: release.md
      - Subnet decentralization: subnet-decentralization-whatif.md
  - "Trustworthy metrics":
      - General: trustworthy-metrics/trustworthy-metrics.md
      - Architecture: trustworthy-metrics/architecture.md
      - Untrusted metrics: trustworthy-metrics/untrusted-metrics.md
  - "Bazel":
      - Tips and tricks: bazel/tips-and-tricks.md

theme:
  name: material
  features:
    - content.action.edit
    - content.action.view
    - content.tooltips
    - content.code.copy
    - navigation.sections
    - navigation.instant
    - search.suggest
    - search.highlight
    - search.share
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/favicon.ico
  logo: assets/favicon.ico

plugins:
  - search
  - offline
  - git-revision-date-localized:
      enable_creation_date: true
  - git-committers:
      repository: dfinity/dre
      branch: main

# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - footnotes
  - toc:
      permalink: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.keys
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - tables
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - javascript/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css