---
# SPDX-License-Identifier: CC-BY-SA-4.0

site_name: PlanktoScope
site_description: An open and affordable imaging platform for \
  citizen oceanography
site_url: http://PlanktoScope.github.io/PlanktoScope
edit_uri: blob/master/docs
repo_name: PlanktoScope/PlanktoScope
repo_url: https://github.com/PlanktoScope/PlanktoScope

nav:
  - Introduction:
      - Introduction: introduction.md
      - Specs: specs.md
      - Research: research.md
  - Hardware:
      - Circularity: build_workshops.md
      - Planktoscope HAT: hat_hardware.md
  - Assembly:
      - Assembly guide: images/assembly_guide.md
      - Trainer Notes: trainer_notes.md
  - Software:
      - Basic Install: easy_install.md
      - Create Master SD Card: create_sd.md
      - Expert Setup: expert_setup.md
      - Remote Access: remote_access.md
  - Internals:
      - Software architecture: software_architecture.md
      - MQTT Messages: mqtt_messages.md
      - Update the Device Tree: update_device-tree.md
  - Usage:
      - Getting started: images/getting_started.md
      - User Interface: images/ui_guide.md
      - Collection devices: collection_devices.md
  - Community:
      - people: people.md
      - Community: community.md
      - Code of Conduct: code_of_conduct.md
  - Contribute:
      - Hardware: hardware_development.md
      - Software: edit_the_code.md
      - Documentation: edit_this_doc.md
      - Protocols: protocols.md
  - About:
      - Changelog: changelog.md
      - License: license.md
      - Funding: funding.md
  - Contact: contact.md

theme:
  logo: assets/logo-white.png
  locale: en
  name: material
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - content.code.annotate
    - navigation.sections
    - navigation.expand
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.instant
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

plugins:
  - glightbox
  - charts

extra_javascript:
  - https://cdn.jsdelivr.net/npm/vega@5
  - https://cdn.jsdelivr.net/npm/vega-lite@5
  - https://cdn.jsdelivr.net/npm/vega-embed@6

extra:
  generator: false

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - sane_lists
  - smarty
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
        - name: vegalite
          class: vegalite
          format: !!python/name:mkdocs_charts_plugin.fences.fence_vegalite
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons
  - pymdownx.tasklist:
      custom_checkbox: true