ScaleCore-Software/mkdocs.yml at main · OpenCEHardware/ScaleCore-Software · 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
site_name: ScaleCore Software Documentation
repo_name: OpenCEHardware/ScaleCore-Software
repo_url: https://github.com/OpenCEHardware/ScaleCore-Software
extra_css:
  - css/extra.css
theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/CElogo.png
  favicon: assets/CElogo.png
  features:
    - navigation.tabs
    - navigation.sections
    - toc.integrate
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
    - header.autohide
    - navigation.footer
  language: en
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
      primary: deep purple
      accent: indigo

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
      primary: deep purple
      accent: indigo
plugins:
  - search
  - print-site:
      path_to_pdf: "assets/Hardware Documentation Template.pdf"

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - md_in_html
  - markdown_include.include:
        base_path: docs
nav:
  - Home: index.md
  - ScaleCore Software:
      - Revisions: block/revisions.md
      - Document Conventions: block/document_conventions.md
      - Overview: block/overview.md
      - Getting Started: block/getting_started.md
      - Runtime Modes: block/runtime_modes.md
      - Examples: block/examples.md
  - About: about.md
copyright: |
  &copy; 2024 <a href="https://github.com/OpenCEHardware"  target="_blank" rel="noopener">OpenCEHardware</a>