OpenScan-Doc/mkdocs.yml at main · OpenScan-org/OpenScan-Doc · 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
site_name: OpenScan
plugins:
  - autolinks
  - search:
      lang:
        - en
theme:
  name: material
  language: en
  palette:
    primary: teal
    accent: indigo
  features:
    - content.code.annotate
    - search.suggest
    - search.highlight

extra_css:
  - |
    :root {
      --md-typeset-a-color: #e91e63;
    }
    .md-typeset a {
      color: var(--md-typeset-a-color);
    }
    .md-typeset a:hover {
      color: #c2185b;
    }

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - Introduction: "index.md"
  - Hardware:
    - Classic: "hardware/OpenScanClassic.md"
    - Mini: "hardware/OpenScanMini.md"
    - PCB: "hardware/PCBs.md"
  - Firmware:
    - Setup: "firmware/setup.md"
    - Usage: "firmware/usage.md"
  - Photogrammetry:
    - Basics: "photogrammetry/basics.md"
    - Software: "photogrammetry/software.md"
    - Quality: "photogrammetry/quality.md"
  - Showcase:
    - Scanner: "showcase/scanner.md"
    - 3D Scans: "showcase/scan.md"
  - Guidelines:
    - "Bugs & features": "guideline/report_bug.md"
  - Downloads: "downloads.md"
  - Changelog: "changelog.md"