SQMeter/mkdocs.yml at main · DeanJ87/SQMeter · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
site_name: SQMeter
site_description: ESP32 Dark Sky Quality Monitor
site_url: https://DeanJ87.github.io/SQMeter/
repo_url: https://github.com/DeanJ87/SQMeter
repo_name: DeanJ87/SQMeter
edit_uri: edit/main/docs/

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/DeanJ87/SQMeter
      name: GitHub
    - icon: material/monitor-eye
      link: https://DeanJ87.github.io/SQMeter/demo/
      name: Live Demo

theme:
  name: material
  palette:
    - scheme: slate
      primary: deep purple
      accent: cyan
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
    - scheme: default
      primary: deep purple
      accent: cyan
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github
  favicon: assets/favicon.png

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Live Demo: live-demo.md
  - Getting Started:
    - Flashing Your Device: getting-started/flashing.md
    - Hardware Setup: getting-started/hardware.md
    - First Boot: getting-started/first-setup.md
  - User Guide:
    - Configuration: user-guide/configuration.md
    - Security: user-guide/security.md
    - MQTT Integration: user-guide/mqtt.md
    - OTA Updates: user-guide/ota.md
  - Hardware:
    - Overview: hardware/overview.md
    - RG-15 Rain Sensor: hardware/rg15.md
    - Schematic: hardware/schematic.md
    - PCB: hardware/pcb.md
    - Enclosure: hardware/enclosure.md
    - Bill of Materials: hardware/bom.md
    - Assembly: hardware/assembly.md
  - API Reference:
    - REST API: api/rest.md
    - WebSocket: api/websocket.md
    - Integrations: api/integrations.md
  - Development:
    - ADR 001 Sky Optics: development/adr-001-sky-optics-and-averaging.md
    - Dev Workflow: development/workflow.md
    - Adding Sensors: development/sensors.md
    - Contributing: development/contributing.md
    - Audit Report: audits/sqmeter-nuclear-codebase-audit.md
    - Audit Remediation Plan: audits/sqmeter-audit-remediation-plan.md
  - Reference:
    - Sky Quality Calculations: reference/sky-quality.md
    - Troubleshooting: reference/troubleshooting.md