updated page config and added meta data
This commit is contained in:
parent
99cedf5656
commit
41e828c48a
58
mkdocs.yml
58
mkdocs.yml
|
@ -6,19 +6,20 @@ site_description: An open and affordable imaging platform for \
|
||||||
citizen oceanography
|
citizen oceanography
|
||||||
site_url: https://planktoscope.curious.bio/
|
site_url: https://planktoscope.curious.bio/
|
||||||
repo_name: PlanktoScope
|
repo_name: PlanktoScope
|
||||||
repo_url: https://code.curious.bio/curious.bio/planktoscope
|
repo_url: https://github.com/PlanktoScope/PlanktoScope
|
||||||
|
|
||||||
nav:
|
nav:
|
||||||
- Introduction:
|
- Home: index.md
|
||||||
- General: introduction/introduction.md
|
# - Introduction:
|
||||||
- Device Specifications: introduction/device_specification.md
|
# - General: introduction/introduction.md
|
||||||
- Research: introduction/research.md
|
- Research: introduction/research.md
|
||||||
- Hardware:
|
- Hardware:
|
||||||
- Manufacturing: hardware/manufacturing.md
|
- Device Specifications: introduction/device_specification.md
|
||||||
- Supply Chain: hardware/supply_chain.md
|
# - Manufacturing: hardware/manufacturing.md
|
||||||
|
# - Supply Chain: hardware/supply_chain.md
|
||||||
- Assembly Guide: hardware/assembly_guide.md
|
- Assembly Guide: hardware/assembly_guide.md
|
||||||
- Maintenance and repair: hardware/maintenance_repair.md
|
# - Maintenance and repair: hardware/maintenance_repair.md
|
||||||
- Disposal and recycling: hardware/disposal_recycling.md
|
# - Disposal and recycling: hardware/disposal_recycling.md
|
||||||
- Planktoscope HAT: hardware/hat_hardware.md
|
- Planktoscope HAT: hardware/hat_hardware.md
|
||||||
- Collection devices: hardware/collection_devices.md
|
- Collection devices: hardware/collection_devices.md
|
||||||
- Software:
|
- Software:
|
||||||
|
@ -31,26 +32,25 @@ nav:
|
||||||
- User Interface: usage/ui_guide.md
|
- User Interface: usage/ui_guide.md
|
||||||
- Remote Access: usage/remote_access.md
|
- Remote Access: usage/remote_access.md
|
||||||
- MQTT Messages: usage/mqtt_messages.md
|
- MQTT Messages: usage/mqtt_messages.md
|
||||||
- Protocols:
|
# - Protocols:
|
||||||
- Basic Primer: protocols/basic_primer.md
|
# - Basic Primer: protocols/basic_primer.md
|
||||||
- FAQ: faq.md
|
# - FAQ: faq.md
|
||||||
- Contribute:
|
- Contribute:
|
||||||
- Development Workflow: contribute/development_workflow.md
|
- Github Workflow: contribute/github_workflow.md
|
||||||
- Hardware Development: contribute/hardware_development.md
|
- Hardware Development: contribute/hardware_development.md
|
||||||
- Software Development: contribute/software_development.md
|
- Software Development: contribute/software_development.md
|
||||||
- Software architecture: contribute/software_architecture.md
|
|
||||||
- Writing Documentation: contribute/writing_documentation.md
|
- Writing Documentation: contribute/writing_documentation.md
|
||||||
- Community:
|
- Community:
|
||||||
- Getting in touch: community/community.md
|
- Getting in touch: community/getting_in_touch.md
|
||||||
- Trainer: community/trainer.md
|
# - Trainer: community/trainer.md
|
||||||
- Code of Conduct: community/code_of_conduct.md
|
- Code of Conduct: community/code_of_conduct.md
|
||||||
- Funding: funding.md
|
# - Funding: funding.md
|
||||||
- License: license.md
|
- License: license.md
|
||||||
- Changelog: changelog.md
|
- Changelog: changelog.md
|
||||||
|
|
||||||
theme:
|
theme:
|
||||||
logo: images/logos/planktoscope_white.png
|
logo: images/logos/planktoscope_white.png
|
||||||
locale: en
|
language: en
|
||||||
name: material
|
name: material
|
||||||
font:
|
font:
|
||||||
text: Roboto
|
text: Roboto
|
||||||
|
@ -80,28 +80,22 @@ theme:
|
||||||
|
|
||||||
plugins:
|
plugins:
|
||||||
- glightbox
|
- glightbox
|
||||||
- charts
|
- minify:
|
||||||
# - table-reader
|
minify_html: true
|
||||||
|
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
- admonition
|
- admonition
|
||||||
- attr_list
|
- attr_list
|
||||||
- md_in_html
|
- md_in_html
|
||||||
- sane_lists
|
|
||||||
- smarty
|
|
||||||
- tables
|
- tables
|
||||||
- toc:
|
- toc:
|
||||||
permalink: true
|
permalink: true
|
||||||
- pymdownx.pathconverter
|
|
||||||
- pymdownx.details
|
- pymdownx.details
|
||||||
- pymdownx.superfences:
|
- pymdownx.superfences:
|
||||||
custom_fences:
|
custom_fences:
|
||||||
- name: mermaid
|
- name: mermaid
|
||||||
class: mermaid
|
class: mermaid
|
||||||
format: !!python/name:pymdownx.superfences.fence_code_format
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
||||||
- name: vegalite
|
|
||||||
class: vegalite
|
|
||||||
format: !!python/name:mkdocs_charts_plugin.fences.fence_vegalite
|
|
||||||
- pymdownx.emoji:
|
- pymdownx.emoji:
|
||||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||||
|
@ -112,12 +106,18 @@ markdown_extensions:
|
||||||
custom_checkbox: true
|
custom_checkbox: true
|
||||||
|
|
||||||
extra:
|
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
|
generator: false
|
||||||
|
|
||||||
extra_css:
|
extra_css:
|
||||||
- stylesheets/extra.css
|
- stylesheets/extra.css
|
||||||
|
|
||||||
extra_javascript:
|
copyright: >
|
||||||
- https://cdn.jsdelivr.net/npm/vega@5
|
Copyright © 2022
|
||||||
- https://cdn.jsdelivr.net/npm/vega-lite@5
|
|
||||||
- https://cdn.jsdelivr.net/npm/vega-embed@6
|
|
||||||
|
|
Loading…
Reference in a new issue