SkyMapper.github.io/mkdocs.yml at main · She456/SkyMapper.github.io · 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
site_name: SkyMapper Docs
site_description: Build an autonomous indoor 3D scanning drone using a commercial UAV + smartphone payload.
site_author: KIST SkyMapper Team

# Keep directory-style URLs like /hardware/ like Voron/PX4 docs
use_directory_urls: true

repo_url: https://github.com/<YOUR_ORG>/<YOUR_REPO>
repo_name: <YOUR_ORG>/<YOUR_REPO>
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/1024.png
  favicon: assets/1024.png
  features:
    - navigation.indexes
    - navigation.top
    - navigation.tracking
    - content.action.edit
    - content.code.copy
    - search.suggest
    - search.highlight
    - toc.follow
  palette:
    - scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Light mode
    - scheme: default
      toggle:
        icon: material/weather-night
        name: Dark mode

plugins:
  - search

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - Home: index.md
  - About: about.md

  - Getting Started:
      - getting-started/index.md
      - Requirements: getting-started/requirements.md
      - Demo Replay (No Drone): getting-started/demo-replay.md
      - Quickstart (Full System): getting-started/quickstart.md
      - First Scan Checklist: getting-started/first-scan.md

  - Hardware:
      - hardware/index.md
      - BOM: hardware/bom.md
      - Printing: hardware/printing.md
      - Mount Assembly: hardware/mount-assembly.md
      - Drone Integration: hardware/drone-integration.md
      - Safety: hardware/safety.md

  - Software:
      - software/index.md
      - Installation: software/installation.md
      - Configuration: software/configuration.md
      - Mobile App: software/mobile.md
      - Controller: software/controller.md
      - Web Viewer: software/viewer.md
      - Sessions & Logs: software/sessions.md

  - Operation:
      - operation/run-scan.md
      - Monitoring & Replay: operation/replay.md
      - Data Export: operation/export.md

  - Troubleshooting:
      - troubleshooting/index.md
      - Hardware: troubleshooting/hardware.md
      - Network: troubleshooting/network.md
      - Software: troubleshooting/software.md

  - Reference:
      - reference/architecture.md
      - Network Ports: reference/network-ports.md
      - File Formats: reference/file-formats.md
      - Glossary: reference/glossary.md

  - Contribute:
      - contribute/index.md
      - Documentation: contribute/docs.md
      - Roadmap: contribute/roadmap.md
      - License: contribute/license.md

  - Legacy Pages:
      - guide/index_2.md
      - guide/hardware.md
      - guide/software.md