pirate-midi-docs/mkdocs.yml at main · Pirate-MIDI/pirate-midi-docs · 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
site_name: Pirate MIDI Documentation
site_description: Official documentation for Pirate MIDI products and tools
site_url: https://docs.piratemidi.com
repo_url: https://github.com/Pirate-MIDI/pirate-midi-docs
edit_uri: edit/main/docs/
repo_name: Pirate MIDI Docs (GitHub)

theme:
  language: en
  favicon: assets/favicon.png
  logo: assets/logo-white.png
  name: material
  features:
    - content.action.edit
    - header.autohide
    - navigation.tabs
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.path
    - navigation.footer
    - content.code.copy
    - content.tooltips
    - search.suggest
    - search.highlight
    - search.share
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: cyan
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: light blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  font:
    text: Inter
    code: Google Sans Code

plugins:
  - search
  - social:
      cards_layout_options:
        background_color: "#5b8dca"   # your brand blue
        color: "#ffffff"              # text on the card
        font_family: "Inter"
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago

nav:
  - Home: index.md
  - Manuals:
      - Overview: manuals/index.md
      - Scribble: manuals/scribble/index.md
      - Bridge6: manuals/bridge6/index.md
      - Bridge4: manuals/bridge4/index.md
      - Aero:
        - Introduction: manuals/aero/index.md
        - Quickstart: manuals/aero/aero-quickstart.md
        - Device Overview: manuals/aero/aero-device-overview.md
        - Flexiports & MIDI: manuals/aero/aero-flexiports-and-midi.md
        - Messages & Modes: manuals/aero/aero-messages-and-modes.md
        - MIDI Clock: manuals/aero/aero-midi-clock.md
        - LFOs & Aux Switches: manuals/aero/aero-lfo-aux.md
        - More Features & Settings: manuals/aero/aero-features-and-settings.md
        - Resetting & Updating: manuals/aero/aero-resetting-and-updating.md
        - MIDI Implementation: manuals/aero/aero-midi-implementation.md
        - Warranty: manuals/aero/aero-warranty.md
      - Polar:
        - Polar Plus:
          - Introduction: manuals/polar/polar-plus/index.md
          - Quickstart: manuals/polar/polar-plus/plus-quickstart.md
          - Connect & Configure: manuals/polar/polar-plus/plus-config.md
          - Update Firmware: manuals/polar/polar-plus/plus-firmware.md
          - MIDI Commands: manuals/polar/polar-plus/plus-midi-commands.md
          - Warranty: manuals/polar/polar-plus/plus-warranty.md
        - Polar Mini:
          - Introduction: manuals/polar/polar-mini/index.md
          - Quickstart: manuals/polar/polar-mini/mini-quickstart.md
          - Connect & Configure: manuals/polar/polar-mini/mini-config.md
          - Update Firmware: manuals/polar/polar-mini/mini-firmware.md
          - MIDI Commands: manuals/polar/polar-mini/mini-midi-commands.md
          - Warranty: manuals/polar/polar-mini/mini-warranty.md
        - Polar Pico:
          - Introduction: manuals/polar/polar-pico/index.md
          - Quickstart: manuals/polar/polar-pico/pico-quickstart.md
          - Connect & Configure: manuals/polar/polar-pico/pico-config.md
          - Update Firmware: manuals/polar/polar-pico/pico-firmware.md
          - MIDI Commands: manuals/polar/polar-pico/pico-midi-commands.md
          - Warranty: manuals/polar/polar-pico/pico-warranty.md
      - CLiCK v2:
        - Overview: manuals/click-v2/index.md
        - Examples: manuals/click-v2/click-examples.md
        - MIDI Implementation: manuals/click-v2/click-midi-implementation.md
        - Warranty: manuals/click-v2/click-warranty.md
      - Exp-Doubler: manuals/exp-doubler/index.md
      - CLiCK v1: manuals/click-v1/index.md
      - µLOOP v1: manuals/µloop/index.md
      - Thru Gizmo: manuals/thru-gizmo/index.md
  - Device API: https://developer.piratemidi.com
  - Support: support/index.md

extra_css:
  - assets/branding.css
  - assets/print.css

extra:
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/x722K7ksA6
    - icon: fontawesome/brands/youtube
      link: https://youtube.com/c/piratemidi
    - icon: fontawesome/brands/facebook
      link: https://facebook.com/groups/pirate.midi.users
    - icon: fontawesome/brands/instagram
      link: https://instagram.com/piratemidi

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - tables
  - attr_list
  - md_in_html
  - pymdownx.blocks.caption
  - def_list
  - abbr
  - pymdownx.details
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg