mifarepy/mkdocs.yml at main · SparkDrago05/mifarepy · 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
site_name: mifarepy
site_description: "Documentation for the mifarepy project."
site_author: "Spark Drago"
site_url: "https://SparkDrago05.github.io/mifarepy/"
repo_url: "https://github.com/SparkDrago05/mifarepy/"
repo_name: "mifarepy"
theme:
  name: material
  custom_dir: overrides
  highlightjs: true
  highlight_theme: github  # for light mode
  highlight_theme_dark: dracula  # for dark mode
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to system preference
extra_css:
  - style.css
nav:
  - Home: index.md
  - Installation: installation.md
  - Usage: usage.md
  - Examples: examples.md
  - API Reference: api.md
  - Contributing: contributing.md

plugins:
  - git-authors
  - search
  - mike:
      alias_type: symlink
      redirect_template: null
      deploy_prefix: ""
      canonical_version: null
      version_selector: true
      css_dir: css
      javascript_dir: js

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences

extra:
  analytics:
    provider: google
    property: G-PZYQH7R8EV
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            opening a <a href="https://github.com/SparkDrago05/mifarepy/issues/new?template=feedback.md" target="_blank" rel="noopener">feedback issue</a>.

  version:
    provider: mike