forked from uni-notes/uni-notes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
169 lines (160 loc) · 4.21 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
site_url: https://uni-notes.netlify.app
site_name: Uni Notes
site_author: Ahmed Thahir
site_description: >-
Ahmed Thahir's notes taken over the years, now featuring others' as well :)
# Repository
repo_name: Uni Notes
repo_url: https://github.com/uni-notes/uni-notes
edit_uri: edit/main/docs/
# Copyright
# copyright: Copyright © 2023 Ahmed Thahir
# Configuration
theme:
name: material
custom_dir: overrides
font: false
features:
# - announce.dismiss
# - content.action.view
- content.action.edit
- content.code.annotate
- content.code.copy
# - content.tabs.link
- content.tooltips
- header.autohide
# - navigation.expand
- navigation.footer
- navigation.indexes
- navigation.instant
# - navigation.prune
# - navigation.sections
# - navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
# - toc.follow
# - toc.integrate
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
logo: icons/logo-512.png
favicon: icons/logo-36.png
icon:
logo: logo
# Plugins
plugins:
- search:
lang: en
separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;' #'[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- minify:
minify_html: true
minify_js: true
minify_css: true
htmlmin_opts:
remove_comments: true
cache_safe: true
- mkdocs-jupyter
- git-committers:
repository: uni-notes/uni-notes
branch: main
token: !!python/object/apply:os.getenv ["MKDOCS_GIT_COMMITTERS_APIKEY"]
exclude:
- index.md
- CONTRIBUTING.md
- git-revision-date-localized:
type: timeago
custom_format: "%d. %B %Y"
exclude:
- index.md
- CONTRIBUTING.md
# Customization
extra:
generator: false
# analytics:
# provider: google
# property: !ENV GOOGLE_ANALYTICS_KEY
# social:
# - icon: fontawesome/brands/github
# link: https://github.com/squidfunk
# - icon: fontawesome/brands/gitter
# link: https://gitter.im/squidfunk/mkdocs-material
# - icon: fontawesome/brands/docker
# link: https://hub.docker.com/r/squidfunk/mkdocs-material/
# - icon: fontawesome/brands/python
# link: https://pypi.org/project/mkdocs-material/
# - icon: fontawesome/brands/twitter
# link: https://twitter.com/squidfunk
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- toc:
permalink: true
toc_depth: 2
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:materialx.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: squidfunk
repo: mkdocs-material
- 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.arithmatex:
generic: true
extra_css:
- stylesheets/custom.css
# - stylesheets/katex.min.css
# extra_javascript:
# - javascripts/register_service_worker.js
# - javascripts/katex.min.js
# - javascripts/custom.js
# - javascripts/quicklink_lower_case.js
# - javascripts/mathjax.js
# - https://polyfill.io/v3/polyfill.min.js?features=es6
# - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# - javascripts/tex-mml-chtml.js
# - javascripts/mathjax_mhchem.js
# - javascripts/mathjax_color.js
# - javascripts/mathjax_cases.js