118 lines
3.5 KiB
YAML
118 lines
3.5 KiB
YAML
---
|
|
# SPDX-License-Identifier: CC-BY-SA-4.0
|
|
|
|
site_name: PlanktoScope
|
|
site_description: An open and affordable imaging platform for \
|
|
citizen oceanography
|
|
site_url: https://planktoscope.curious.bio/
|
|
repo_name: PlanktoScope
|
|
repo_url: https://code.curious.bio/curious.bio/planktoscope
|
|
|
|
nav:
|
|
- Introduction:
|
|
- General: 00_introduction/introduction.md
|
|
- Device Specification: 00_introduction/device_specification.md
|
|
- Research: 00_introduction/research.md
|
|
- Hardware:
|
|
- Manufacturing: 01_hardware/manufacturing.md
|
|
- Supply Chain: 01_hardware/supply_chain.md
|
|
- Assembly Guide: 01_hardware/assembly_guide.md
|
|
- Maintenance and repair: 01_hardware/maintenance_repair.md
|
|
- Disposal and recycling: 01_hardware/disposal_recycling.md
|
|
- Planktoscope HAT: 01_hardware/hat_hardware.md
|
|
- Collection devices: 01_hardware/collection_devices.md
|
|
- Software:
|
|
- Basic Install: 02_software/easy_install.md
|
|
- Create the SD Card: 02_software/create_sd.md
|
|
- Expert Setup: 02_software/expert_setup.md
|
|
- Update Devicetree: 02_software/update_devicetree.md
|
|
- Usage:
|
|
- Getting started: 03_usage/getting_started.md
|
|
- User Interface: 03_usage/ui_guide.md
|
|
- Remote Access: 03_usage/remote_access.md
|
|
- MQTT Messages: 03_usage/mqtt_messages.md
|
|
- Protocols:
|
|
- Basic Primer: 04_protocols/basic_primer.md
|
|
- Contribute:
|
|
- Development Workflow: 05_contribute/contributions.md
|
|
- Hardware Development: 05_contribute/hardware_development.md
|
|
- Software Development: 05_contribute/software_development.md
|
|
- Software architecture: 05_contribute/software_architecture.md
|
|
- Writing Documentation: 05_contribute/writing_documentation.md
|
|
- Community:
|
|
- Getting in touch: 06_community/community.md
|
|
- Trainer: 06_community/trainer.md
|
|
- Code of Conduct: 06_community/code_of_conduct.md
|
|
- Changelog: changelog.md
|
|
- License: license.md
|
|
- Funding: funding.md
|
|
|
|
theme:
|
|
logo: images/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
|