OpenCentauri/mkdocs.yml at main · dbstf/OpenCentauri · 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
site_name: OpenCentauri
repo_url: https://github.com/suchmememanyskill/OpenCentauri
repo_name: OpenCentauri
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list
  - md_in_html
  - pymdownx.blocks.caption
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
plugins:
  - glightbox
  - git-committers:
      repository: suchmememanyskill/OpenCentauri
      branch: main
      enabled: !ENV [CI, false]
  - git-revision-date-localized:
      enable_creation_date: true
nav:
  - Home: index.md
  - Hardware:
    - CC1:
      - Hardware: hardware/CC1/index.md
      - Mainboard: hardware/CC1/mainboard.md
      - FEL & UART Setup: hardware/CC1/fel-uart-setup.md
      - EMMC Tap Points: hardware/CC1/emmc-tapping.md
      - Toolhead: hardware/CC1/toolhead.md
      - Camera: hardware/CC1/camera.md
      - Bed: hardware/CC1/bed.md
      - Screen: hardware/CC1/screen.md
      - Miscellaneous: hardware/CC1/misc.md
      - Official Documentation: hardware/CC1/documentation.md
    - CC2:
      - Hardware: hardware/CC2/index.md
      - Mainboard: hardware/CC2/mainboard.md
      - Toolhead: hardware/CC2/toolhead.md
      - Screen: hardware/CC2/screen.md
      - Miscellaneous: hardware/CC2/misc.md
      - CANVAS: hardware/CC2/CANVAS.md
      - Official Documentation: hardware/CC2/documentation.md

  - Software:
    - Software: software/index.md
    - Partitions: software/partitions.md
    - Updates: software/updates.md
    - Updates (CC2): software/updates-cc2.md
    - API: software/api.md
    - Custom gcode: software/custom-gcode.md
    - Embedded Firmware: software/embedded-firmware.md
    - FEL: software/FEL-mode.md
  - Mods:
    - Machine Mods: mods/machine_mods.md
    - Printable Mods: mods/printable_mods.md
    - Light Mods: mods/light_mods.md
    - Klipper via mainboard replacement:
      - Main: klipper-via-mainboard-replacement/index.md
      - Recognize Hotend: klipper-via-mainboard-replacement/recognize-hotend.md
      - Printer Config: klipper-via-mainboard-replacement/printer-config.md
      - Mainsail Config: klipper-via-mainboard-replacement/mainsail-config.md
      - UDEV Setup: klipper-via-mainboard-replacement/udev-setup.md
    - Patched firmware:
      - Patched firmware: patched-firmware/index.md
      - Modified slicer machine gcode: patched-firmware/modified_start_end_machine_gcode.md
theme:
  name: material
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tabs
    - navigation.expand
    - toc.integrate
    - content.code.copy
  palette:
  # Palette toggle for automatic mode
  - media: "(prefers-color-scheme)"
    toggle:
      icon: material/brightness-auto
      name: Switch to light mode

  # Palette toggle for light mode
  - media: "(prefers-color-scheme: light)"
    scheme: default
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode

  # Palette toggle for dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    toggle:
      icon: material/brightness-4
      name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
    logo: material/cube
extra:
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/t6Cft3wNJ3
extra_css:
  - extra.css