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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# ───────────────────────────
# 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
  - Introduction: readme.md
  - Quick start:
      - Getting started with a minimal build: getting-started.md
  - Customising your build:
    - Connecting via SSH: ssh.md
    - Cinemate terminal commands: cli-commands.md
    - Custom settings: settings-json.md
    # - Adding hardware controls: hardware-controls.md
    - Configuring the Wi-Fi hotspot: hotspot-logic.md
  - Using the camera:
      - Simple GUI: simple-gui.md
      - Camera sensors and frame rates: sensors.md
      - Audio recording: audio-recording.md
      - FPS correction and audio sync: fps-correction.md
      - Digital zoom: digital-zoom.md
      - Speed ramping & shutter angle synchronization: speed-ramping.md
      - Dual sensors: dual-sensors.md
  - System management:
      - Modifying config.txt: config-txt.md
      - System services: system-services.md
      - Storage pre-roll warm-up: storage-preroll.md
      - Manual installation: installation-steps.md
      - Recompiling cinepi-raw: compiling-cinepi-raw.md
      # - Overclocking the Pi: overclocking.md
      - Backing up the SD card: backing-up-sd-card.md

  - Reference & troubleshooting:
      - CinePi RAW terminal commands: cli-user-guide.md
      - Redis API: redis-guide.md
      - Key reference: redis-keys.md
      # - Hardware overview: preinstalled-hardware.md
      # - Known issues: known-issues.md
      # - Troubleshooting: troubleshooting.md
  # - Cinemate builds:
  #     - Bare bones build: bare-bones-build.md
  #     - Box build: brick.md
  - Development & contributing:

      # - Todo: todo.md
      # - Contributors: contributors.md
      # - Contributing to the project: contributing.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

  features:
    - navigation.instant
    - navigation.sections
    - navigation.top
    - toc.integrate
    - toc.follow
    - content.code.copy
    - content.code.select

    # Read the Docs specific
    - collapse_navigation: True,
    - sticky_navigation: True,
    - navigation_depth: 4,
    - includehidden: True,
    - titles_only: False

  palette:
    - scheme: default           # WCAG-AA compliant base

extra_css:

  - templates/styles.scss
  - 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.tabbed
  - pymdownx.emoji
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - 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