TimeKeeper/mkdocs.yml at main · CurtinFRC/TimeKeeper · 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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# Project information
site_name: Time Keeper Documentation
site_url: https://curtinfrc.github.io/TimeKeeper/
site_author: Connor (CJ) Buchel
site_description: >-
  Time Keeper - Documentation for TK Management

# Repository information
repo_name: CurtinFRC/TimeKeeper
repo_url: https://github.com/CurtinFRC/TimeKeeper/
edit_uri: edit/master/docs/

# Navigation structure - customize this based on your content
nav:
  - Home: index.md
  - User Guide:
      - Overview: guides/guides.md
  - Support:
      - Bug Reports: support/bug_reports.md
      - Change Requests: support/change_requests.md
      - Q&A: https://github.com/CurtinFRC/TimeKeeper/discussions

# Site configuration
theme:
  name: material
  font:
    text: "Ubuntu"
    code: "Ubuntu Mono"
  logo: assets/logo.png
  favicon: assets/logo.png

  # Color scheme with your primary color
  palette:
    # dark theme
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
      primary: blue
      accent: indigo

    # light theme
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
      primary: blue
      accent: indigo

  # Navigation features
  features:
    # Navigation
    - navigation.instant # Faster page loading (SPA-like behavior)
    - navigation.instant.prefetch # Prefetch pages on hover
    - navigation.instant.progress # Show loading progress bar
    - navigation.tracking # Update URL with active anchor
    - navigation.tabs # Top-level sections as tabs
    - navigation.tabs.sticky # Tabs remain visible when scrolling
    - navigation.sections # Top-level sections are rendered as groups
    - navigation.expand # Expand all sections by default
    - navigation.path # Show breadcrumb navigation path
    - navigation.indexes # Allow section index pages
    - navigation.top # "Back to top" button

    # Search
    - search.suggest # Show search suggestions
    - search.highlight # Highlight search terms on page
    - search.share # Share search results via URL

    # Table of contents
    - toc.follow # Sidebar automatically scrolls to active heading
    - toc.integrate # Integrate TOC into navigation (left sidebar only)

    # Content
    - content.code.copy # Copy button for code blocks
    - content.code.annotate # Allow annotations in code blocks
    - content.tabs.link # Link content tabs across pages
    - content.tooltips # Enable tooltips for abbreviations
    - content.action.edit # Edit button on pages
    - content.action.view # View source button on pages

# Extensions
markdown_extensions:
  # Python Markdown extensions
  - abbr # Abbreviations/tooltips
  - admonition # Call-out blocks (notes, warnings, etc.)
  - attr_list # Add HTML attributes to elements
  - def_list # Definition lists
  - footnotes # Footnote support
  - md_in_html # Markdown inside HTML
  - tables # Table support
  - toc:
      permalink: true # Add permanent links to headings
      permalink_title: Anchor link to this section
      toc_depth: 3 # Max depth for TOC

  # PyMdown Extensions (advanced features)
  - pymdownx.arithmatex: # Math notation support
      generic: true
  - pymdownx.betterem: # Better emphasis handling
      smart_enable: all
  - pymdownx.caret # Superscript (^text^) and insert (^^text^^)
  - pymdownx.mark # Highlighting (==text==)
  - pymdownx.tilde # Subscript (~text~) and delete (~~text~~)
  - pymdownx.critic # Track changes
  - pymdownx.details # Collapsible details/summary
  - pymdownx.highlight: # Code highlighting
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite # Inline code highlighting
  - pymdownx.keys # Keyboard keys (++ctrl+alt+del++)
  - pymdownx.magiclink: # Auto-link URLs and GitHub references
      repo_url_shorthand: true
      user: CurtinFRC
      repo: TimeKeeper
  - pymdownx.smartsymbols # Smart symbols (arrows, fractions, etc.)
  - pymdownx.snippets: # Include external files
      check_paths: true
  - pymdownx.superfences: # Nested code blocks, diagrams
  - pymdownx.tabbed: # Tabbed content blocks
      alternate_style: true
  - pymdownx.tasklist: # Task lists with checkboxes
      custom_checkbox: true

# Plugins
plugins:
  - search: # Search functionality
      lang: en
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - tags # Tag support for pages

# Extra configuration
extra:
  # Social links in footer
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/CurtinFRC/TimeKeeper
      name: TimeKeeper on GitHub