mkdocs.yml

site_name: The SwarmUS Project
site_url: https://swarmus.github.io/SwarmUS-doc/
repo_url: https://github.com/SwarmUS/
repo_name: SwarmUS
edit_uri: ""
copyright: Copyright © 2021 - SwarmUS

nav:
  - Home: "index.md"
  - User Guides:
      - User Guides Home: "sections/user-guide/index.md"
      - Basic Examples:
          - Flashing an LED Using Buzz: "sections/user-guide/basic-examples/led-flash-buzz.md"
          - Flashing an LED on a remote Hiveboard: "sections/user-guide/basic-examples/led-flash-remote-hiveboard.md"
          - Controlling a Robot Using Buzz and HiveMindBridge: "sections/user-guide/basic-examples/buzz-control-robot.md"
          - Using Interlocalisation Between Swarm Agents: "sections/user-guide/basic-examples/basic-interloc.md"
  - Reference:
      - Reference Home: "sections/reference/index.md"
      - Architecture of the System: "sections/reference/architecture.md"
      - Buzz: "sections/reference/Buzz/index.md"
      - HiveMind:
          - About HiveMind: "sections/reference/HiveMind/hivemind-preface.md"
          - HiveMind and the Host: "sections/reference/HiveMind/hivemind-host.md"
          - HiveMind and the Swarm: "sections/reference/HiveMind/hivemind-swarm.md"
          - HiveMind API: "sections/reference/HiveMind/hivemind-api.md"
      - HiveMindBridge:
          - About HiveMindBridge: "sections/reference/HiveMindBridge/about-hivemindbridge.md"
          - Registering Custom Actions: "sections/reference/HiveMindBridge/registering-custom-actions.md"
          - Defining Callbacks: "sections/reference/HiveMindBridge/defining-callbacks.md"
          - Defining Manifests: "sections/reference/HiveMindBridge/defining-manifests.md"
          - Example Logger Implementation: "sections/reference/HiveMindBridge/logger.md"
      - Interlocalisation:
          - How it Works:
              - Introduction: "sections/reference/Interloc/how_it_works/intro.md"
              - Distance Measurement: "sections/reference/Interloc/how_it_works/distance.md"
              - Angle Measurement: "sections/reference/Interloc/how_it_works/angle.md"
              - Synchronization: "sections/reference/Interloc/how_it_works/sync.md"
          - Calibrating a Hiveboard: "sections/reference/Interloc/calibrating_a_hiveboard.md"
      - Networking:
          - Configuring the Wi-Fi network: "sections/reference/Networking/configure-wifi.md"
          - HiveConnect: "sections/reference/Networking/hiveconnect.md"
      - HiveAR:
          - About HiveAR: "sections/reference/HiveAR/hivear-preface.md"
          - Setup HiveAR: "sections/reference/HiveAR/hivear-setup.md"
          - Sending Commands: "sections/reference/HiveAR/hivear-commands.md"
          - Swarm Visualization: "sections/reference/HiveAR/hivear-visualization.md"
          - Configuration: "sections/reference/HiveAR/hivear-configuration.md"
      - Development:
          - Embedded development with CLion: 
              - Getting Started: "sections/reference/Development/clion-setup/getting_started.md"
              - HiveMind CLion setup: "sections/reference/Development/clion-setup/hive_mind_setup.md"
              - HiveConnect CLion setup: "sections/reference/Development/clion-setup/hive_connect_setup.md"
              - Logging in CLion: "sections/reference/Development/clion-setup/logging.md"
  - Hardware:
      - Hardware Home: "sections/hardware/index.md"
      - HiveBoard:
        - V1.000: "sections/hardware/HiveBoard/HiveBoard_V1.000.md"
        - Available UI: "sections/hardware/HiveBoard/hiveboard-ui.md"
      - BeeBoard:
        - V1.000: "sections/hardware/BeeBoard/BeeBoard_V1.000.md"
  - About: "sections/about/about.md"

theme:
  name: material
  custom_dir: 'theme'
  palette:
    - scheme: slate
      primary: orange
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
    - scheme: default
      primary: orange
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    
  logo: assets/SVG_S_Swarm_Abeille.svg
  favicon: assets/SVG_S_Swarm_Abeille.svg
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/swarmus/
    - icon: fontawesome/brands/github
      link: https://github.com/SwarmUS
  disqus: swarmus

extra_css:
    - css/extra.css

markdown_extensions:
  - tables
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences:
        custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid
  - pymdownx.snippets
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - lightgallery

plugins:
  - search
  - mermaid2:
      arguments:
          # test if its __palette_1 (dark) or __palette_2 (light)
          theme: |
            ^(JSON.parse(window.localStorage.getItem(__prefix('__palette'))).index == 1) ? 'light' : 'dark'

extra_javascript:
- 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
- extra/refresh_on_toggle_dark_light.js