Hitloop_Hardware/mkdocs.yml at main · responsibleIT/Hitloop_Hardware · 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
# Replace the text below to customize your site
site_name: HitLoop Beacon Controller
site_description: Hitloop Beacon Controller Documentation
site_author: Rover Vos, Bas Pijls
copyright: Copyright 2025, HvA Hitloop

# site_url: https://knowledgebase.hbo-ict-hva.nl
# repo_url: https://gitlab.fdmci.hva.nl/propedeuse-hbo-ict/knowledgebase/student-knowledgebase

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://code.iconify.design/3/3.0.0/iconify.min.js

theme:
  name: material

  # custom_dir: mdocotion
  hide_site_name: true
  content_margin_top: 0px
  icon:
    logo: material/music-note-bluetooth


  features:
    - search.share
    - content.code.annotate
    - navigation.sections
    - content.tabs.link
    - content.code.copy

plugins:
  - search
  - awesome-pages
  - mkdocs-video:
      css_style:
        is_video: True
        min-width: "640px"
        max-width: "900px"
        min-height: "360px"
  - section-index
  - autolinks
  - git-revision-date-localized:
      fallback_to_build_date: true
      # Read more: https://timvink.github.io/mkdocs-git-revision-date-localized-plugin/options/#enabled
      enabled: !ENV [ENABLED_GIT_REVISION_DATE, False]
  - exclude-search:
      exclude:
        - 3_onderwijs/*

markdown_extensions:
  - extra
  - abbr
  - smarty
  - admonition
  - footnotes
  - attr_list
  - md_in_html
  - pymdownx.keys
  - pymdownx.tabbed:
      alternate_style: true
  - codehilite:
      guess_lang: true
  - toc:
      permalink: true
  - pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.arithmatex:
      generic: true