batear/mkdocs.yml at main · batear-io/batear · 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
site_name: Batear
site_url: https://docs.batear.io
site_description: Ultra-low-cost acoustic drone detection on ESP32-S3 with encrypted LoRa alerting
site_author: TN666
repo_url: https://github.com/batear-io/batear
repo_name: batear-io/batear
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/icon.png
  favicon: assets/icon.png
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: white
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight
  icon:
    repo: fontawesome/brands/github

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

plugins:
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/batear-io/batear

nav:
  - Home: index.md
  - Getting Started:
      - Prerequisites: getting-started.md
      - Build & Flash: build-flash.md
      - Configuration: configuration.md
  - How It Works:
      - Detection Algorithm: how-it-works.md
      - System Architecture: architecture.md
      - LoRa Protocol: protocol.md
  - Reference:
      - Hardware: hardware.md
      - Calibration: calibration.md
      - REST API: api.md
      - Adding a Board: adding-boards.md
  - Contributing: contributing.md