cinemate/mkdocs.yml at main · Tiramisioux/cinemate · 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
141
142
143
144
145
146
147
# ───────────────────────────
# Project basics
# ───────────────────────────
site_name: CineMate Docs
site_description: Documentation for CineMate
site_url: https://tiramisioux.github.io/cinemate/
repo_url: https://github.com/tiramisioux/cinemate
edit_uri: blob/main/docs/
repo_name: GitHub
dev_addr: 0.0.0.0:8000            # live-preview reachable from your laptop

# ───────────────────────────
# Navigation (edit to match your .md files)
# ───────────────────────────
nav:
  - Home: index.md
  - Overview: readme.md
  - Quick start: getting-started.md
  - Using the camera:
      - Simple GUI: simple-gui.md
      - Web GUI: web-gui.md
      - Playback: playback.md
      # - Web API: web-api.md   # unconfirmed - hidden from the menu, page still builds
      # - Lenses and image circles: image-circle.md   # unverified - hidden from the menu, page still builds
      - Audio recording: audio-recording.md
      - Digital zoom: digital-zoom.md
      - Speed ramping & shutter angle synchronization: speed-ramping.md
      - Storage pre-roll warm-up: storage-preroll.md
  - Configuring:
      - Raspberry Pi models: raspberry-pi-models.md
      - config.txt: config-txt.md
      # - The CineMate stack explained: cinemate-stack.md   # hidden from the menu, page still builds
      - settings.jsonc: settings-json.md
      # - Settings editor: settings-editor.md   # hidden from the menu, page still builds
      - Camera sensors and frame rates: sensors.md
      - ClearHDR (imx585): clear-hdr.md
      - CineMate Log (imx585 / imx283): cinemate-log.md
      - Dual sensors: dual-sensors.md
      - Additional hardware: hardware-controls.md
      - Building control units: building-control-units.md
      - Configuring the Wi-Fi hotspot: hotspot-logic.md
  - System maintenance:
      - Connecting via SSH: ssh.md
      - System services: system-services.md
      # - Recovery console: recovery-console.md   # hidden from the menu, page still builds
      - Backing up the SD card: backing-up-sd-card.md
  - Troubleshooting: troubleshooting.md
  - Advanced:
      # - Simple GUI refresh tuning: simple-gui-refresh-tuning.md   # hidden from the menu, page still builds
      - Manual installation: installation-steps.md
      # - Compiling cinepi-raw: compiling-cinepi-raw.md   # hidden from the menu, page still builds
      # - Overclocking the Pi: overclocking.md   # shipped on by the installer; pending fact-check - hidden from the menu, page still builds
  - Reference:
      - CineMate terminal commands: cli-commands.md
      - CinePi-RAW terminal commands: cli-user-guide.md
      # - Redis API: redis-guide.md   # hidden from the menu, page still builds
      # - Redis Key reference: redis-keys.md   # hidden from the menu, page still builds
      # - How CineMate launches CinePi-raw: cinepi-multi.md   # hidden from the menu, page still builds
      - Changelog: changelog.md
  # - CineMate builds:
  #     - Box build: brick.md
  - About:
      # - Todo: todo.md
      - Acknowledgements: acknowledgments.md
  #- Download PDF: renders/CineMate-Docs.pdf
# Theme
# ───────────────────────────
theme:
  name: readthedocs
  custom_dir: docs/overrides
  icon:
    logo: material/library

  font:
    text: Roboto
    code: Roboto Mono

  language: en

extra_css:

  - stylesheets/extra.css
  # - overrides/github-markdown.css
  # - overrides/highlight.css
  # - overrides/markdown.css

  - https://unpkg.com/highlightjs-copy@1/dist/highlightjs-copy.min.css
extra_javascript:

  - https://unpkg.com/highlightjs-copy@1/dist/highlightjs-copy.min.js
  - js/ko-fi-widget.js
  - js/copybutton-init.js

# ───────────────────────────
# Markdown add-ons
# ───────────────────────────

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - tables
  - codehilite:
      guess_lang: true
      use_pygments: true
      pygments_style: friendly
  - toc:
      permalink: "#"            # tiny link-icon on headings
  - pymdownx.snippets
  - pymdownx.superfences        # code blocks inside admonitions/tabs
  - pymdownx.tabbed
  - pymdownx.emoji
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde

# ───────────────────────────
# Plugins
# ───────────────────────────
plugins:
  - search

  # - with-pdf:
  #     # ── template ─────────────────────────────
  #     custom_template_path: docs/stylesheets     # where styles.scss now lives

  #     # ── cover & back cover ───────────────
  #     cover: true
  #     back_cover: true
  #     cover_title: "CineMate"
  #     cover_subtitle: "User & Builder Guide"
  #     cover_logo: docs/assets/images/CINEMATE.jpg   # relative to docs/

  #     # ── build behaviour ─────────────────
  #     output_path: renders/CineMate-Docs.pdf  # already using this

  #     # ── layout ─────────────────
  #     two_columns_level: 2        # experimental two-column layout
  #     toc_level: 3                # depth of autogenerated TOC

  #     verbose: true