-
-
Notifications
You must be signed in to change notification settings - Fork 6
/
mkdocs.yml
157 lines (152 loc) · 3.84 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
site_name: Bracex
site_url: https://facelessuser.github.io/bracex
repo_url: https://github.com/facelessuser/bracex
edit_uri: tree/master/docs/src/markdown
site_description: Python spell checker.
copyright: |
Copyright © 2018 - 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:
primary: deep purple
accent: deep purple
font:
text: Roboto
code: Roboto Mono
features:
- navigation.tabs
- navigation.top
- navigation.instant
- navigation.indexes
- toc.follow
- content.code.copy
- navigation.footer
- search.share
- search.highlight
- search.suggest
pymdownx:
sponsor: "https://github.com/sponsors/facelessuser"
nav:
- Home:
- Usage: index.md
- About:
- Contributing & Support: about/contributing.md
- Development: about/development.md
- Changelog: about/changelog.md
- License: about/license.md
markdown_extensions:
- markdown.extensions.toc:
slugify: !!python/object/apply:pymdownx.slugs.slugify {kwds: {case: lower}}
permalink: ""
- markdown.extensions.smarty:
smart_quotes: false
- pymdownx.betterem:
- markdown.extensions.attr_list:
- markdown.extensions.tables:
- markdown.extensions.abbr:
- markdown.extensions.footnotes:
- markdown.extensions.md_in_html:
- pymdownx.superfences:
preserve_tabs: true
- pymdownx.highlight:
extend_pygments_lang:
- name: pycon3
lang: pycon
options:
python3: true
- pymdownx.inlinehilite:
- pymdownx.magiclink:
repo_url_shortener: true
repo_url_shorthand: true
social_url_shorthand: true
user: facelessuser
repo: bracex
- 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.striphtml:
- pymdownx.snippets:
base_path:
- docs/src/markdown/.snippets
- LICENSE.md
auto_append:
- refs.md
- pymdownx.keys:
separator: "\uff0b"
- pymdownx.saneheaders:
- 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}}
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/facelessuser
plugins:
- search
- git-revision-date-localized:
fallback_to_build_date: true
- mkdocs_pymdownx_material_extras
- minify:
minify_html: true