mesh-client/mkdocs.yml at main · Colorado-Mesh/mesh-client · 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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
site_name: Colorado Mesh Client
site_url: https://colorado-mesh.github.io/mesh-client/
site_description: >-
  Cross-platform desktop client for Meshtastic, MeshCore, and Reticulum (LXMF) mesh networks.
repo_url: https://github.com/Colorado-Mesh/mesh-client
repo_name: Colorado-Mesh/mesh-client
edit_uri: edit/main/docs/
copyright: Copyright &copy; Colorado Mesh volunteers. Mesh-Client is GPL-3.0-or-later.

exclude_docs: |
  requirements.txt

hooks:
  - scripts/mkdocs_hooks.py

validation:
  omitted_files: warn
  absolute_links: info
  unrecognized_links: warn
  anchors: warn

theme:
  name: material
  language: en
  logo: assets/logo.png
  favicon: assets/favicon.png
  palette:
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.action.edit

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Colorado-Mesh/mesh-client
      name: GitHub
    - icon: fontawesome/brands/discord
      link: https://discord.com/invite/McChKR5NpS
      name: Discord
    - icon: material/web
      link: https://coloradomesh.org/
      name: Colorado Mesh

plugins:
  - search
  - git-revision-date-localized:
      type: date
      fallback_to_build_date: true

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - md_in_html
  - tables
  - def_list
  - footnotes
  - github-callouts
  - toc:
      permalink: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - Home: index.md
  - Install: install.md
  - Features: features.md
  - User Guide:
      - Live Traffic Map: live-traffic-map.md
      - Reticulum Setup Guide: reticulum-setup-guide.md
      - Reticulum: reticulum.md
      - EMCOMM (MECP & Incident Command): emcomm.md
      - Key Backup & Crypto: key-backup-and-crypto.md
      - Meshtastic Telemetry: meshtastic-telemetry-local-client.md
      - Notification Sounds: notification-sounds.md
      - Localization: localization.md
      - Glossary: glossary.md
  - Support:
      - Troubleshooting: troubleshooting.md
      - MeshCore Troubleshooting: troubleshooting-meshcore.md
      - Reticulum Troubleshooting: troubleshooting-reticulum.md
      - Diagnostics: diagnostics.md
      - Log Analysis: log-analysis.md
      - Community: https://coloradomesh.org/
  - Engineering:
      - Development Guide: development-environment.md
      - Contributing: contributing.md
      - Accessibility: accessibility-checklist.md
      - UI Style Guide: style-guide.md
      - CI/CD: ci-cd.md
      - Release Process: release-process.md
      - Service Announcements: service-announcements.md
      - Meshtastic & MeshCore Parity: meshcore-meshtastic-parity.md
      - Reticulum Development: reticulum-development.md
      - Reticulum Sidecar IPC: reticulum-sidecar-ipc.md
      - Reticulum Games Parity: reticulum-games-parity.md
      - Nomad Hosting Interop: nomad-hosting-interop.md
      - LetsMesh MQTT Auth: letsmesh-mqtt-auth.md
      - Subsystem reference:
          - Overview: development/index.md
          - Architecture quick reference: development/architecture-quick-ref.md
          - Common issues: development/common-issues.md
          - Renderer hooks: development/renderer-hooks.md
          - BLE and serial: development/ble-serial.md
          - Chat: development/chat.md
          - Connection panel: development/connection-panel.md
          - Meshtastic: development/meshtastic.md
          - MQTT: development/mqtt.md
          - MeshCore Repeaters: development/meshcore-repeaters.md
          - MeshCore Rooms: development/meshcore-rooms.md
          - MeshCore companion CLI: development/meshcore-companion-cli.md
          - EMCOMM: development/emcomm.md
          - MECP: development/mecp.md
          - Offline maps: development/offline-maps.md
          - Live packet map: development/live-packet-map.md
          - Settings search: development/settings-search.md
  - Project:
      - License: license.md
      - Credits: credits.md
      - Third-party licenses: third-party-licenses.md