-
-
Notifications
You must be signed in to change notification settings - Fork 254
/
mkdocs.yml
254 lines (249 loc) · 7.42 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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
site_name: PyMdown Extensions Documentation
site_url: https://facelessuser.github.io/pymdown-extensions
repo_url: https://github.com/facelessuser/pymdown-extensions
edit_uri: tree/master/docs/src/markdown
site_description: A Collection of Useful Extensions for Python Markdown
copyright: |
Copyright © 2014 - 2024 <a href="https://github.com/facelessuser" target="_blank" rel="noopener">Isaac Muse</a>
docs_dir: docs/src/markdown
theme:
name: material
custom_dir: docs/theme
icon:
logo: material/book-open-page-variant
palette:
scheme: dracula
primary: deep purple
accent: deep purple
font:
text: Roboto
code: Roboto Mono
features:
- announce.dismiss
- navigation.tabs
- navigation.top
- navigation.instant
- navigation.indexes
- toc.follow
- content.tabs.link
- search.share
- search.highlight
- search.suggest
- content.code.copy
- content.code.annotations
pymdownx:
sponsor: "https://github.com/sponsors/facelessuser"
nav:
- Home:
- Pymdown Extensions: index.md
- Installation: installation.md
- Usage Notes: usage_notes.md
- Extensions:
- Arithmatex: extensions/arithmatex.md
- B64: extensions/b64.md
- BetterEm: extensions/betterem.md
- Blocks:
- extensions/blocks/index.md
- Blocks Extension API: extensions/blocks/api.md
- Admonition: extensions/blocks/plugins/admonition.md
- Caption: extensions/blocks/plugins/caption.md
- Definition: extensions/blocks/plugins/definition.md
- Details: extensions/blocks/plugins/details.md
- HTML: extensions/blocks/plugins/html.md
- Tab: extensions/blocks/plugins/tab.md
- Caret: extensions/caret.md
- Critic: extensions/critic.md
- Details: extensions/details.md
- Emoji: extensions/emoji.md
- EscapeAll: extensions/escapeall.md
- Extra: extensions/extra.md
- FancyLists: extensions/fancylists.md
- Highlight: extensions/highlight.md
- InlineHilite: extensions/inlinehilite.md
- Keys: extensions/keys.md
- MagicLink: extensions/magiclink.md
- Mark: extensions/mark.md
- PathConverter: extensions/pathconverter.md
- ProgressBar: extensions/progressbar.md
- SaneHeaders: extensions/saneheaders.md
- SmartSymbols: extensions/smartsymbols.md
- Snippets: extensions/snippets.md
- StripHTML: extensions/striphtml.md
- SuperFences: extensions/superfences.md
- Tabbed: extensions/tabbed.md
- Tasklist: extensions/tasklist.md
- Tilde: extensions/tilde.md
- Extras:
- Slugs: extras/slugs.md
- Advanced Mermaid Notes: extras/mermaid.md
- FAQ:
- Frequently Asked Questions: faq.md
- About:
- Contributing & Support: about/contributing.md
- Development: about/development.md
- Security Vulnerabilities: about/security.md
- Changelog: about/changelog.md
- Migration Notes:
- '6.0': about/releases/6.0.md
- '7.0': about/releases/7.0.md
- '8.0': about/releases/8.0.md
- '9.0': about/releases/9.0.md
- License: about/license.md
markdown_extensions:
- markdown.extensions.toc:
slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}
permalink: ""
- markdown.extensions.admonition:
- markdown.extensions.smarty:
smart_quotes: false
- pymdownx.betterem:
- markdown.extensions.attr_list:
- markdown.extensions.def_list:
- markdown.extensions.tables:
- markdown.extensions.abbr:
- markdown.extensions.footnotes:
- markdown.extensions.md_in_html:
- pymdownx.superfences:
preserve_tabs: true
custom_fences:
# Mermaid diagrams
- name: diagram
class: diagram
format: !!python/name:pymdownx.superfences.fence_code_format
- name: math
class: arithmatex
format: !!python/object/apply:pymdownx.arithmatex.arithmatex_fenced_format {kwds: {mode: generic, tag: pre}}
- name: md-render
class: md-render
format: !!python/name:tools.pymdownx_md_render.md_sub_render
- pymdownx.highlight:
extend_pygments_lang:
- name: php-inline
lang: php
options:
startinline: true
- name: pycon3
lang: pycon
options:
python3: true
linenums_style: pymdownx-inline
- pymdownx.inlinehilite:
custom_inline:
- name: math
class: arithmatex
format: !!python/object/apply:pymdownx.arithmatex.arithmatex_inline_format {kwds: {mode: generic}}
- pymdownx.magiclink:
repo_url_shortener: true
repo_url_shorthand: true
social_url_shorthand: true
social_url_shortener: true
user: facelessuser
repo: pymdown-extensions
normalize_issue_symbols: true
- pymdownx.tilde:
- pymdownx.caret:
- pymdownx.smartsymbols:
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.escapeall:
hardbreak: True
nbsp: True
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.progressbar:
- pymdownx.arithmatex:
generic: true
block_tag: 'pre'
- pymdownx.mark:
- pymdownx.striphtml:
- pymdownx.snippets:
base_path:
- docs/src/markdown/.snippets
- LICENSE.md
- SECURITY.md
auto_append:
- refs.md
check_paths: true
- pymdownx.keys:
separator: "\uff0b"
- pymdownx.details:
- pymdownx.tabbed:
alternate_style: true
- pymdownx.saneheaders:
- pymdownx.fancylists:
inject_style: true
- pymdownx.blocks.admonition:
types:
- new
- settings
- note
- abstract
- info
- tip
- success
- question
- warning
- failure
- danger
- bug
- example
- quote
- pymdownx.blocks.details:
types:
- name: details-new
class: new
- name: details-settings
class: settings
- name: details-note
class: note
- name: details-abstract
class: abstract
- name: details-info
class: info
- name: details-tip
class: tip
- name: details-success
class: success
- name: details-question
class: question
- name: details-warning
class: warning
- name: details-failure
class: failure
- name: details-danger
class: danger
- name: details-bug
class: bug
- name: details-example
class: example
- name: details-quote
class: quote
- pymdownx.blocks.html:
- pymdownx.blocks.definition:
- pymdownx.blocks.tab:
alternate_style: True
combine_header_slug: True
slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}
- pymdownx.blocks.caption:
- tools.collapse_code:
expand_text: ''
collapse_text: ''
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/facelessuser
extra_css:
# - https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css
- assets/pymdownx-extras/extra-add764b01e.css
extra_javascript:
- https://cdn.jsdelivr.net/npm/[email protected]/dist/mermaid.min.js
# - https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
- assets/pymdownx-extras/extra-loader-B5CKpNQx.js
plugins:
- search:
- git-revision-date-localized:
fallback_to_build_date: true
- minify:
minify_html: true