planktoscope/mkdocs.yml
2022-12-19 02:25:34 +01:00

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://code.curious.bio/curious.bio/planktoscope
nav:
- Introduction:
- General: introduction/introduction.md
- Device Specifications: introduction/device_specification.md
- Research: introduction/research.md
- Hardware:
- 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:
- Development Workflow: contribute/development_workflow.md
- Hardware Development: contribute/hardware_development.md
- Software Development: contribute/software_development.md
- Software architecture: contribute/software_architecture.md
- Writing Documentation: contribute/writing_documentation.md
- Community:
- Getting in touch: community/community.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
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
# - table-reader
markdown_extensions:
- admonition
- attr_list
- md_in_html
- sane_lists
- smarty
- tables
- toc:
permalink: true
- pymdownx.pathconverter
- 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
extra:
generator: false
extra_css:
- stylesheets/extra.css
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