scrollkit/mkdocs.yml at master · czei/scrollkit · 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
site_name: ScrollKit
site_description: LED Matrix Display Framework for CircuitPython and Desktop
site_author: Michael Czeiszperger
repo_url: https://github.com/czei/scrollkit
repo_name: czei/scrollkit

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: pink
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: pink
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
  features:
    - navigation.sections
    - navigation.top
    - content.code.copy
    - content.code.annotate

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

extra_css:
  - stylesheets/theme.css
  - stylesheets/landing.css

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Hardware Assembly: guide/device-setup.md
  - Demo Gallery: demos.md
  - "Sample Project: The Forge Sign": sample-project.md
  - Visual Reference: guide/visual-reference.md
  - Tutorials:
      - "Easy: Hello World": tutorials/easy.md
      - "Medium: Live Data": tutorials/medium.md
      - "Hard: Full App": tutorials/hard.md
  - Guide:
      - Architecture: guide/architecture.md
      - App Framework: guide/app.md
      - Display: guide/display.md
      - Performance: guide/performance.md
      - Pixel Art: guide/pixel-art.md
      - Effects: guide/effects.md
      - Characterful Scrolling: guide/scrolling.md
      - Theatrical Transitions: guide/transitions.md
      - Gradient Text: guide/gradient-text.md
      - Palette-Animated Bitmap Text: guide/bitmap-text.md
      - Palette Partitions & Treatments: guide/palette-treatments.md
      - Marks & Acts: guide/acts.md
      - Character Animation: guide/character-animation.md
      - Sensors & Tilt: guide/sensors.md
      - Web Interface: guide/web.md
      - OTA Updates: guide/ota.md
      - Networking: guide/networking.md
      - Configuration: guide/config.md
      - Simulator: guide/simulator.md
      - Adding New Hardware: guide/hardware.md
      - Utilities: guide/utils.md
  - API Reference: reference.md