MeshCore-GOME/mkdocs.yml at main · MrAlders0n/MeshCore-GOME · 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
# Site Information
site_name: Greater Ottawa Mesh Enthusiasts
site_url: https://ottawamesh.ca
repo_name: MeshCore NCR
repo_url:  https://github.com/MrAlders0n/MeshCore-NCR

# Navigation Structure
nav:
  - Home:  index.md

  - Community:
      - Goals: community/goals.md
      - Getting Involved: community/getting-involved.md
      - Contributing: community/contributing.md
      - Rules: community/rules.md

  - Deployment:
      - Coverage: deployment/coverage.md
      - Repeaters: deployment/repeaters.md
      - Repeaters Interlink: deployment/repeaters-intercity.md
      - Repeater Classification: deployment/repeater_classification.md
      - Repeater Showcase: deployment/repeaters-showcase.md
      - Wanted Repeater Locations: deployment/repeater-wanted-locations.md
      - Frequency Settings: deployment/frequency-settings.md

  - Hardware:
      - Overview: hardware/overview.md
      - Antenna: hardware/recommended-antenna.md
      - Companion Nodes: hardware/recommended-companions.md
      - Repeater Nodes:
          - Repeater Nodes:  hardware/recommended-repeaters.md
          - Repeater Mounting Options: hardware/repeater-mounting-options.md
          - 300mW Solar Repeater Build Guide: hardware/repeater-solar-300mw-diy-build.md

  - MeshCore:
      - General:
          - MeshCore FAQ: meshcore/general-faq.md
          - MeshCore How-To: meshcore/general-howto.md
          - MeshCore Roles: meshcore/general-meshcore-roles.md
      - Configuration:
          - Flashing a Companion:  meshcore/flash-companion.md
          - Flashing a Repeater: meshcore/flash-repeater.md
          - Generating a Repeater ID: meshcore/generate-repeater-id.md
          - Flashing a Room Server: meshcore/flash-room-server.md
          - RAK4631 Custom Display Firmware: meshcore/firmware-rak-custom-display.md
          - Heltec V3 Wi-Fi Firmware:  meshcore/firmware-heltec-v3-wifi.md
      - Packet Capture:
          - Overview: meshcore/packet-capture-overview.md
          - Companion Observer: meshcore/packet-capture-companion-listener.md
          - Repeater Observer: meshcore/packet-capture-standalone-repeater.md

  - Meshtastic:
      - Getting Started: meshtastic/getting-started.md
      - Frequency Settings: meshtastic/frequency-settings.md

  - Resources:
      - Useful Links: resources/useful-links.md

# Theme Configuration
theme:
  name:  material
  logo: assets/logo-GOME-mkdocs.png
  favicon: assets/favicon-GOME-mkdocs.png
  palette:
    scheme: slate

# Markdown Extensions
markdown_extensions:
  - attr_list
  - admonition
  - md_in_html
  - pymdownx.blocks.caption
  - toc:
      permalink: true

# Plugins
plugins:
  - search
  - macros
  - glightbox:
      touchNavigation: true
  - i18n:
      reconfigure_material: true
      languages:
        - locale: en
          name: English
          default: true
          build: true
        - locale: fr
          name: Français
          build: true


# Extra JavaScript
extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - zOther/javascript/tablesort.js
  - zOther/javascript/hexgrid.js

# Extra CSS
extra_css:
  - zOther/css/hexgrid.css
  - zOther/css/repeaters-intercity.css