124 lines
3.5 KiB
YAML
124 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://github.com/PlanktoScope/PlanktoScope
|
|
|
|
nav:
|
|
- Home: index.md
|
|
# - Introduction:
|
|
# - General: introduction/introduction.md
|
|
- Research: introduction/research.md
|
|
- Hardware:
|
|
- Device Specifications: introduction/device_specification.md
|
|
# - Manufacturing: hardware/manufacturing.md
|
|
# - Supply Chain: hardware/supply_chain.md
|
|
- Assembly Guide: hardware/assembly_guide.md
|
|
# - Maintenance and repair: hardware/maintenance_repair.md
|
|
# - Disposal and recycling: hardware/disposal_recycling.md
|
|
- Planktoscope HAT: hardware/hat_hardware.md
|
|
- Collection devices: hardware/collection_devices.md
|
|
- Software:
|
|
- Basic Install: software/easy_install.md
|
|
- Create the SD Card: software/create_sd.md
|
|
- Expert Setup: software/expert_setup.md
|
|
- Update Devicetree: software/update_devicetree.md
|
|
- Usage:
|
|
- Getting started: usage/getting_started.md
|
|
- User Interface: usage/ui_guide.md
|
|
- Remote Access: usage/remote_access.md
|
|
- MQTT Messages: usage/mqtt_messages.md
|
|
# - Protocols:
|
|
# - Basic Primer: protocols/basic_primer.md
|
|
# - FAQ: faq.md
|
|
- Contribute:
|
|
- Github Workflow: contribute/github_workflow.md
|
|
- Hardware Development: contribute/hardware_development.md
|
|
- Software Development: contribute/software_development.md
|
|
- Writing Documentation: contribute/writing_documentation.md
|
|
- Community:
|
|
- Getting in touch: community/getting_in_touch.md
|
|
# - Trainer: community/trainer.md
|
|
- Code of Conduct: community/code_of_conduct.md
|
|
# - Funding: funding.md
|
|
- License: license.md
|
|
- Changelog: changelog.md
|
|
|
|
theme:
|
|
logo: images/logos/planktoscope_white.png
|
|
language: 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
|
|
- minify:
|
|
minify_html: true
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- attr_list
|
|
- md_in_html
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
- pymdownx.details
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- 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
|
|
|
|
extra:
|
|
homepage: https://www.planktoscope.org/
|
|
social:
|
|
- icon: fontawesome/brands/github-alt
|
|
link: https://github.com/PlanktoScope
|
|
- icon: fontawesome/brands/slack
|
|
link: https://planktoscope.slack.com
|
|
- icon: fontawesome/brands/twitter
|
|
link: https://twitter.com/ThibautPollina
|
|
generator: false
|
|
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
|
|
copyright: >
|
|
Copyright © 2022
|