tvhgo/mkdocs.yml at main · CutterXYZ/tvhgo · 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
site_name: tvhgo
site_description: tvhgo Documentation
site_url: "https://davidborzek.github.io/tvhgo/"

exclude_docs: |
  docs.go

theme:
  name: "material"

  features:
    - navigation.top
    - navigation.footer
    - navigation.sections
    - content.code.copy

  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: cyan
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: cyan
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/davidborzek/tvhgo

repo_url: https://github.com/davidborzek/tvhgo

nav:
  - "Welcome": "index.md"
  - "Installation": "installation.md"
  - "Configuration":
      - "Configuration": "configuration.md"
      - "Auth": "auth.md"
      - "Metrics": "metrics.md"
      - "Fail2Ban": "fail2ban.md"
  - "Interfaces":
      - "REST API": "rapidoc.html"
      - "CLI": "cli/docs.md"

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg