docs/mkdocs.yml at main · PPUC/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
site_name: Pinball Power-Up Controller & DMD
site_url: https://ppuc.github.io/docs/
site_description: Pinball Power-Up Controller & DMD (PPUC) is a free and open-source pinball controller and display system.
use_directory_urls: true
repo_url: https://github.com/PPUC
repo_name: PPUC on GitHub
edit_uri: docs/blob/main/docs/
docs_dir: docs

plugins:
  - search
  - github_repos:
      organization: PPUC
      cache_minutes: 30
      github_token: ""  # Only needed for private repos
      exclude_repos:
        - dmd
        - docs
        - .github
        - ZeDMD_Updater
        - ColorizingDMD
        - pindmd3-firmware
        - libppuclogger
      include_archived: false  # Whether to show archived repos
      forked_repos:
        - dmd-extensions
        - pinmame
        - libdmdutil

extra_css:
  - stylesheets/ppuc.css

markdown_extensions:
  - toc:
      title: On this page
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.snippets:
      base_path: includes
      check_paths: true
      auto_append:
        - content_footer.md
  - pymdownx.keys
  - pymdownx.extra

theme:
  name: material
  logo: /docs/images/logo.png
  icon:
    repo: fontawesome/brands/github
    edit: fontawesome/solid/wand-magic-sparkles
  custom_dir: overrides

  features:
    - navigation.tracking
    - navigation.instant
    - navigation.footer
    - navigation.indexes
    - navigation.top
    - content.action.edit
    - toc.follow
    - content.code.annotate

  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Open Sans
    code: Noto Sans Mono

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/PPUC
      name: PPUC Organization
    - icon: fontawesome/brands/discord
      link: https://discord.gg/fkkk4MbBn5
      name: Join our Discord
  base_url: /docs/

nav:
  - Overview: index.md
  - PPUC:
    - ppuc/index.md
    - ppuc/getting_started.md
    - ppuc/config_tool.md
    - ppuc/build_from_source.md
    - ppuc/how_to_run.md
  - "PPUC Hardware":
    - ppuc_hardware/index.md
    - ppuc_hardware/io_16_8_1.md
    - ppuc_hardware/io_16x8_matrix.md
    - ppuc_hardware/out_8x10.md
    - ppuc_hardware/opto_16.md
  - ZeDMD:
    - zedmd/index.md
  - PPUC/DMD:
    - ppuc_dmd/index.md
    - ppuc_dmd/when_things_dont_work.md
  - GitHub Repositories: github_repos.md