DigOutBox/mkdocs.yml at main · galactic-forensics/DigOutBox · 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
site_name: DigOutBox Documentation

theme:
  name: material
  features:
    - content.code.copy
    - content.code.select
    - navigation.footer
  palette:
    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

site_url: https://digoutbox.readthedocs.io
repo_url: https://github.com/galactic-forensics/DigOutBox
site_author: Reto Trappitsch

markdown_extensions:
  - admonition
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets


plugins:
  - mermaid2
  - search

nav:
  - Home: index.md
  - Images: images.md
  - Versioning: versioning.md
  - Hardware: hardware.md
  - Firmware: firmware.md
  - Python Interface: controller.md
  - GUI: gui.md
  - Changelog: changelog.md
  - Developer Guide: dev.md
  - Acknowledgement: acknowledgement.md