turnfix/mkdocs.yml at WebInterface · Igel18/turnfix · 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
111
site_name: TurnFix Documentation
site_description: Comprehensive gymnastics competition management system
site_author: TurnFix Team
site_url: https://turnfix.readthedocs.io

# Repository
repo_name: Igel18/turnfix
repo_url: https://github.com/Igel18/turnfix
edit_uri: edit/WebInterface/documentation/newWebbased/

# Documentation directory
docs_dir: documentation/newWebbased

# Theme configuration
theme:
  name: readthedocs
  highlightjs: true
  hljs_languages:
    - typescript
    - javascript
    - bash
    - sql
    - yaml
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight

# Plugins
plugins:
  - search:
      lang:
        - en
        - de
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: sphinx

# Extensions
markdown_extensions:
  - markdown_include.include:
      base_path: documentation/newwebbased
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Navigation - Only existing files (auto-expand from here)
# Note: Files listed here must exist in documentation/newwebbased/
# nav:
#   - Auto-generated navigation from file structure

# Extra
extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Igel18/turnfix
  analytics:
    feedback:
      title: War diese Seite hilfreich?
      ratings:
        - icon: material/emoticon-happy-outline
          name: Diese Seite war hilfreich
          data: 1
          note: Danke für Ihr Feedback!
        - icon: material/emoticon-sad-outline
          name: Diese Seite könnte verbessert werden
          data: 0
          note: Danke für Ihr Feedback! Bitte erstellen Sie ein Issue auf GitHub.

# Copyright
copyright: Copyright &copy; 2024-2025 TurnFix Team