docs/mkdocs.yml at master · ThingPulse/docs · 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
strict: true

site_name: '' # actual site name 'ThingPulse' is present in the logo and doesn't need to be repeated
site_url: https://docs.thingpulse.com/
site_description: ThingPulse docs
site_author: Marcel Stör & Dani Eichhorn
repo_name: thingpulse/docs
repo_url: https://github.com/thingpulse/docs
copyright: Copyright &copy; 2023 <a href="https://thingpulse.com">ThingPulse</a>.

# Configuration
theme:
  name: material
  logo: img/logo.svg
  favicon: img/favicon.ico

  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: en
  feature:
    tabs: true
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: orange
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: orange
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode

  features:
    # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-copy-button
    - content.code.copy

extra:
  # https://squidfunk.github.io/mkdocs-material/getting-started/#adding-social-links
  social:
    - icon: fontawesome/brands/facebook
      link: https://facebook.com/thingpulse
    - icon: fontawesome/brands/github
      link: https://github.com/thingpulse
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/thingpulse
  analytics:
    provider: google
    property: G-V8ZHG66YBG

nav:
  - Home: index.md
  - support.md
  - Guides:
    - ESP32 Color Kit Grande: guides/esp32-color-kit-grande.md
    - ESP32-S3 Pendrive: guides/esp32-s3-pendrive.md
    - Breathing Heart: guides/breathing-heart.md
    - AMo - CO2 Monitor: guides/amo-co2-monitor.md
    - Icon64 - ESP32 with RBG LED & audio: guides/icon64-esp32-rgb-led-audio.md
    - Icon256 - Word Clock: guides/icon256-word-clock.md
    - ESP8266 IoT Starter Kit: guides/iot-starter-kit.md
    - WiFi Color Display Kit: guides/wifi-color-display-kit.md
    - 2.9″ ESPaper Plus Kit: guides/espaper-plus-kit.md
    - 2.9″ ESPaper Lite Kit: guides/espaper-lite-kit.md
    - 4.2″ ESPaper Plus Kit: guides/42-espaper-plus-kit.md
    - ESPaper Calendar: guides/espaper-calendar.md
  - How-tos:
    - Create OpenWeatherMap API key: how-tos/openweathermap-key.md
    - how-tos/install-drivers.md
    - how-tos/Arduino-IDE-for-ESP8266.md
  - Hardware specs:
    - WiFi Color Display Kit: specs/wifi-color-display-kit.md
    - 2.9" ESPaper Lite and Plus Kit: specs/2_9-espaper-kit-dimensions.md

watch:
  - docs/guides
  - mkdocs.yml

markdown_extensions:
  # https://squidfunk.github.io/mkdocs-material/reference/admonitions/
  - admonition
  - attr_list
  - md_in_html
  - toc:
      permalink: §
  # https://python-markdown.github.io/extensions/definition_lists/
  - def_list
  # https://github.com/mkdocs/mkdocs/issues/777#issuecomment-308266201
  - markdown_include.include:
      base_path: docs
  # https://facelessuser.github.io/pymdown-extensions/
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tilde

plugins:
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      slide_effect: slide
      width: 100%
      height: auto
      zoomable: true
      draggable: true
      skip_classes:
        - custom-skip-class-name
      auto_caption: false
      caption_position: bottom
  - mkdocs-video:
      is_video: True
      video_muted: True
      video_controls: True
      video_loop: True
      video_autoplay: True
      css_style:
        width: "90%"