-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
170 lines (138 loc) · 4.82 KB
/
mkdocs.yml
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
site_name: Brinton Memorial Cookbook
site_url: https://mikew.github.io/brinton-memorial-cookbook
site_description: This cookbook is dedicated to the students, parents and staff of Brinton Memorial School. March, 1996.
site_author: Brinton Memorial
copyright: '© 1996 Brinton Memorial'
repo_name: mikew/brinton-memorial-cookbook
repo_url: https://github.com/mikew/brinton-memorial-cookbook
extra:
social:
- icon: fontawesome/solid/globe
link: https://mikew.github.io/brinton-memorial-cookbook
- icon: fontawesome/brands/github-alt
link: https://github.com/mikew/brinton-memorial-cookbook
plugins:
- social
- search
# https://github.com/timvink/mkdocs-charts-plugin
- charts
# https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
- awesome-pages:
filename: navigation.yml
# https://github.com/Andre601/mkdocs-pagenav-generator
- pagenav-generator
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#configuration
- tags
# https://github.com/datarobot/mkdocs-redirects
- redirects:
redirects_maps:
# 'old.md': new.md
- glightbox
theme:
name: material
custom_dir: overrides
logo: assets/images/logo.png
favicon: assets/images/logo.png
features:
# Top level sections are always available at the top.
- navigation.tabs
# SPA navigation.
- navigation.instant
- navigation.indexes
- navigation.footer
# Move the table of contents for a page to the main sidebar.
# - toc.integrate
# Simple search suggestions as the user types.
- search.suggest
# Highlight what the user searched for.
- search.highlight
# All content tabs across the whole documentation site will be linked and
# switch to the same label when the user clicks on a tab
- content.tabs.link
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: teal
toggle:
icon: material/brightness-4
name: Switch to light mode
extra_javascript:
# https://squidfunk.github.io/mkdocs-material/reference/mathjax/
- assets/javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# https://github.com/timvink/mkdocs-charts-plugin
- https://cdn.jsdelivr.net/npm/vega@5
- https://cdn.jsdelivr.net/npm/vega-lite@5
- https://cdn.jsdelivr.net/npm/vega-embed@6
# - https://cdn.jsdelivr.net/npm/redoc@latest/bundles/redoc.standalone.js
extra_css:
- assets/stylesheets/theme-overrides.css
# - https://fonts.googleapis.com/css?family=Montserrat:300,400,700
markdown_extensions:
- meta
- pymdownx.betterem
- pymdownx.smartsymbols
- toc:
permalink: true
# https://squidfunk.github.io/mkdocs-material/reference/abbreviations/
- abbr
- pymdownx.snippets
# https://squidfunk.github.io/mkdocs-material/reference/admonitions/
- admonition
- pymdownx.details
- pymdownx.superfences
# https://squidfunk.github.io/mkdocs-material/reference/annotations/
- attr_list
- md_in_html
- pymdownx.superfences
# https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
# https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#configuration
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
# https://squidfunk.github.io/mkdocs-material/reference/data-tables/
- tables
# https://squidfunk.github.io/mkdocs-material/reference/diagrams/
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
# https://github.com/timvink/mkdocs-charts-plugin
- name: vegalite
class: vegalite
format: !!python/name:mkdocs_charts_plugin.fences.fence_vegalite
# https://squidfunk.github.io/mkdocs-material/reference/footnotes/
- footnotes
# https://squidfunk.github.io/mkdocs-material/reference/formatting/
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
# https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
# https://squidfunk.github.io/mkdocs-material/reference/images/
- attr_list
- md_in_html
# https://squidfunk.github.io/mkdocs-material/reference/lists/
- def_list
- pymdownx.tasklist:
custom_checkbox: true
# https://squidfunk.github.io/mkdocs-material/reference/mathjax/
- pymdownx.arithmatex:
generic: true