Docs/mkdocs.yml at main · team401/Docs · 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
site_name: Docs
site_url: https://team401.github.io/Docs
site_description: "FIRST Robotics Competition documentation developed by \nFRC Team 401: Copperhead Robotics"

repo_url: https://github.com/team401/Docs
edit_uri: edit/main/docs/

extra_css:
  - stylesheets/colors.css
theme:
  name: material
  favicon: images/logo_sq.png
  logo: images/logo.png
  palette:
    # Light mode
    - scheme: default
      toggle:
        icon: material/lightbulb
        name: Switch to Dark Mode

    # Dark mode
    - scheme: slate
      toggle:
        icon: material/lightbulb-outline
        name: Switch to Light Mode
  features:
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    # - navigation.tabs
    # - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.footer
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.preview
    - toc.follow

    # - toc.integrate
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.select
    - content.tabs.link

validation:
  links:
    absolute_links: relative_to_docs
    anchors: warn
    unrecognized_links: warn

markdown_extensions:
  - toc:
      permalink: ""
  - attr_list
  - md_in_html
  - pymdownx.highlight:
      linenums: true
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.snippets:
  - pymdownx.inlinehilite:
  - pymdownx.superfences:
  - markdown.extensions.attr_list:
  - pymdownx.keys:
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - tables:
  - attr_list:

extra:
  generator: false
  social:
    - icon: material/email-box
      link: mailto:team401@mcps.org
    - icon: simple/github
      link: https://github.com/team401
    - icon: simple/instagram
      link: https://instagram.com/team401
    - icon: simple/facebook
      link: https://www.facebook.com/copperheadrobotics/
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/frcteam401
    - icon: simple/youtube
      link: https://www.youtube.com/@FRCTeam401CopperheadRobotics

plugins:
  - optimize:
      enabled: !ENV CI
  - search:
  - group:
      enabled: !ENV CI
      plugins:
        - social:
            cards_layout_options:
              background_color: "#d35401"
  - git-revision-date-localized:
      enable_creation_date: true