Device-API-Docs/mkdocs.yml at main · Pirate-MIDI/Device-API-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
site_name: Pirate MIDI Device API Documentation
site_description: Official documentation for the Device API protocol for interacting with Pirate MIDI hardware
site_url: https://developer.piratemidi.com
repo_url: https://github.com/Pirate-MIDI/Device-API-Docs
edit_uri: edit/main/docs/
repo_name: Device-API-Docs (GitHub)

theme:
  language: en
  favicon: assets/favicon.png
  logo: assets/logo-white.png
  custom_dir: overrides
  name: material
  features:
    - content.action.edit
    - header.autohide
    - navigation.tabs
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.path
    - navigation.footer
    - navigation.prune
    - 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
  - awesome-pages
  - macros
  - 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


markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list

extra_javascript:
  - assets/renderjson.js
  - assets/json-viewer.js

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