mkdocs.yml

site_name: Technical Documentation

# Theme
theme:
  name: "material"
  language: en

  logo: assets/logo.png
  favicon: assets/favicon.ico
  custom_dir: docs/overrides

  icon:
    search: octicons/search-24
    close: octicons/x-24
    top: octicons/chevron-up-24
    previous: octicons/chevron-left-24
    next: octicons/chevron-right-24
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16

  features:
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.footnote.tooltips
    - navigation.top
    - navigation.tabs
    - navigation.path
    - navigation.footer
    - search.suggest

  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep orange
      accent: deep orange
      toggle:
        icon: octicons/moon-16
        name: Switch to dark mode

    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep orange
      accent: deep orange
      toggle:
        icon: octicons/sun-16
        name: Switch to light mode

# Extensions
markdown_extensions:
  - attr_list
  - md_in_html
  - tables
  - admonition
  - footnotes
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - def_list
  - mdx_breakless_lists
  - mdx_truly_sane_lists
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.details
  - pymdownx.tilde
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true

plugins:
  - search
  - tags
  - roamlinks
  - mkdocs-video:
      video_muted: true
      video_controls: true

extra_css:
  - assets/stylesheets/extra.css
  - assets/stylesheets/carousel.css
  - assets/stylesheets/pins.css

extra_javascript:
  - assets/javascripts/carousel.js
  - assets/javascripts/mathjax.js
  - assets/javascripts/pins.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://unpkg.com/mermaid/dist/mermaid.min.js

nav:
  - FIRO:
      - index.md
      - specification.md
      - environment.md
  - Mechanics:
      - mechanics/index.md
      - Modules:
          - mechanics/modules/index.md
  - Electronics:
      - electronics/index.md
      - electronics/connectors.md
      - electronics/rover-wiring.md
      - electronics/radiation-protection.md
      - PCBs:
          - electronics/pcb/index.md
  - Software:
      - software/index.md
      
      - Interface:
          - software/interface/index.md
      - Cameras:
          - software/cameras/index.md
      - ROS2:
          - software/ros2/index.md
      - DevOps:
          - software/devops/index.md
      - RadCon:
          - software/radcon/index.md
  - Resources:
      - Contribution:
          - resources/contribution/writing-documentation.md
      - Software:
          - resources/software/repository-structure.md
          - resources/software/learning-ros.md
          - resources/software/writing-ros-packages.md
      - Electronics:
          - resources/electronics/pcb-documentation-template.md
          - resources/electronics/pcb-repository-template.md
      - Mechanics:
          - resources/mechanics/mechanical-file-naming-and-structure.md
      - Other:
          - resources/other/3d-printer-network-setup.md