CommonProjectFiles/docs/mkdocs_parent.yml at eebdcf8feab37156df86b1b8eb230fbbe2868ae6 · Wolf2323/CommonProjectFiles · 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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
site_dir: target/docs
docs_dir: docs
edit_uri: edit/main/docs/
copyright: >
  <p id="bqCopyright">© 2024-{CurrentYear}</p>
  <a href="#__consent">Change cookie settings</a>

extra_css:
  - '_webCode/css/button.css'
  - '_webCode/css/centered.css'
  - '_webCode/css/contentAreaFullWidth.css'
  - '_webCode/css/mermaidCentered.css'
  - '_webCode/css/externalLinkIcon.css'

extra_javascript:
  - '_webCode/js/copyLinkToClipboard.js'
  - '_webCode/js/copyrightYearUpdater.js'
  - '_webCode/js/mathjax.js'
  - '_webCode/js/externalLinkIcon.js'
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# More info on this theme: https://squidfunk.github.io/mkdocs-material
theme:
  name: material
  custom_dir: 'docs/_custom_theme/'
  language: en
  features:
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.path
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.indexes
    - search.share
    - search.suggest
    - content.tooltips
    - toc.follow

  palette:
    - scheme: slate
      primary: indigo
      accent: teal
      toggle:
        icon: material/lightbulb
        name: Switch to light mode
    - scheme: default
      primary: blue
      accent: teal
      toggle:
        icon: fontawesome/solid/moon
        name: Switch to dark mode
  font:
    text: Roboto
    code: Roboto Mono
  logo: '_media/brand/Icon/Icon1K.png'
  favicon: '_media/brand/Icon/Icon32.ico'
  icon:
    admonition:
      example: fontawesome/regular/eye


# See the following for docs on these extensions: https://squidfunk.github.io/mkdocs-material/setup/extensions/
markdown_extensions:
  - admonition
  - attr_list
  - codehilite:
      linenums: true
  - footnotes
  - md_in_html
  - meta
  - tables
  - pymdownx.highlight
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - '_custom_theme/.icons'
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - 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
  - pymdownx.snippets
  - abbr
  - toc:
      permalink: 🔗

plugins:
  - typeset
  - search: { }
  - snippets:
      directory: "_snippets"
      identifier: "snippet"
  - exclude:
      glob:
        - _snippets/*
        - _custom_theme/*
        - _tutorials/*
        - mkdocs_parent.yml
        - setup-docs-dependencies.py
  - group:
      enabled: !ENV CI
      plugins:
        - optimize

extra:
  consent:
    title: Cookie consent
    cookies:
      github: GitHub
    actions:
      - manage
      - reject
      - accept
    description: >
      <p style="margin-top: 0px; margin-bottom: 0px;">We need your consent to make request to GitHub.com. We load statistics about our Git repository from there.</p>

validation:
  nav:
    omitted_files: warn
    not_found: warn
    absolute_links: warn
  links:
    not_found: warn
    absolute_links: warn
    unrecognized_links: warn