mkdocs.yml

site_name: BugBot
site_description: Build, program, and simulate BugBot. Firmware, Python library, protocol, and simulation reference.
site_url: https://www.bugbotlab.com/bugbot/

repo_url: https://github.com/BugBotLab/bugbot
repo_name: BugBotLab/bugbot
edit_uri: edit/main/docs/

docs_dir: docs
site_dir: site

theme:
  name: material
  logo: assets/green_bug.png
  favicon: assets/green_bug.png
  palette:
    - scheme: default
      primary: custom
      accent: custom
  font:
    text: Nunito
    code: Roboto Mono
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Build:
    - Overview: build/index.md
    - Parts List: build/parts-list.md
    - 3D Printing: build/3d-printing.md
    - Assembly: build/assembly.md
  - Lessons:
    - Overview: lessons/index.md
    - "1. Your First Move": lessons/01-first-move.md
  - Hardware:
    - Overview: hardware/index.md
  - Python Library:
    - Overview: python-api/index.md
    - Robot: python-api/robot.md
    - Dongle: python-api/dongle.md
    - Exceptions: python-api/exceptions.md
  - Protocol:
    - ESP-NOW Wire Protocol: espnow/00-protocol.md
    - Robot Firmware: espnow/01-robot-firmware-brief.md
    - Dongle Firmware: espnow/02-dongle-firmware-brief.md
    - Host Library Spec: espnow/03-host-library-spec.md
  - Architecture: architecture.md