This repository has been archived by the owner on Feb 27, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmkdocs.yml
137 lines (133 loc) · 4.64 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
site_name: your_site_name # Change this to your site name
site_description: A cool description of your site
site_url: https://change_me.io/ # Change this to your site URL
theme:
name: 'material'
logo: assets/meta/favicons.png
favicon: assets/meta/favicons.png
custom_dir: overrides
font:
text: Ubuntu
code: Ubuntu Mono
language: en
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
accent: light blue
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to light mode
features:
- navigation.indexes
- navigation.top
- navigation.tabs
- navigation.tabs.sticky
- navigation.expand
- search.suggest
- search.highlight
# Extensions
markdown_extensions:
- footnotes
- nl2br
- attr_list
- sane_lists
- meta
- smarty
- tables
- mdx_breakless_lists
- def_list
- pymdownx.arithmatex:
generic: true
- pymdownx.details
- pymdownx.magiclink
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.highlight:
use_pygments: true
anchor_linenums: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- admonition
- toc:
permalink: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
plugins:
- search
- meta-descriptions
- git-revision-date-localized:
type: date
fallback_to_build_date: true
locale: en
custom_format: "%A %d %B %Y"
enable_creation_date: true
- ezlinks:
wikilinks: true
- awesome-pages
- embed_file:
callouts: true
custom-attributes: 'assets/css/custom_attributes.css'
- custom-attributes:
file: 'assets/css/custom_attributes.css'
- tags:
tags_file: tags.md
- encryptcontent:
title_prefix: '🔐'
summary: 'Private page'
placeholder: 'Password'
decryption_failure_message: 'Invalid password'
encryption_info_message: "You don't have access to this page."
search_index: 'encrypted'
password_button: True
password_button_text: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" height="1em" width="1em"><!--! Font Awesome Pro 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2022 Fonticons, Inc. --><path d="M416 32h-64c-17.67 0-32 14.33-32 32s14.33 32 32 32h64c17.67 0 32 14.33 32 32v256c0 17.67-14.33 32-32 32h-64c-17.67 0-32 14.33-32 32s14.33 32 32 32h64c53.02 0 96-42.98 96-96V128C512 74.98 469 32 416 32zM342.6 233.4l-128-128c-12.51-12.51-32.76-12.49-45.25 0c-12.5 12.5-12.5 32.75 0 45.25L242.8 224H32C14.31 224 0 238.3 0 256s14.31 32 32 32h210.8l-73.38 73.38c-12.5 12.5-12.5 32.75 0 45.25s32.75 12.5 45.25 0l128-128C355.1 266.1 355.1 245.9 342.6 233.4z"/></svg>'
- callouts
- glightbox
hooks:
- overrides/hooks/on_page_markdown.py
- overrides/hooks/on_env.py
- overrides/hooks/on_files.py
extra_javascript:
- https://cdn.jsdelivr.net/gh/ObsidianPublisher/assets@main/dist/javascript.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0-beta3/css/all.min.css
- https://cdn.jsdelivr.net/gh/ObsidianPublisher/assets@main/dist/styles.css
- assets/css/admonition.css
- assets/css/custom_attributes.css
- assets/css/customization.css
extra:
SEO: assets/meta/SEO.png
comments: false #disable comments globally
generate_graph: true #generate the graph of the site
attachments: 'assets/img' #path to the folder where the attachments are stored
no-auto-h1: false #disable the automatic generation of h1 if no h1 is found
blog_list:
pagination: true #enable pagination
pagination_message: true #display the message "Showing x posts out of y"
pagination_translation: 'posts in' #message to display before the number of posts ; Add your own translation!
no_page_found: "No pages found!" #message to display when no pages are found ; Add your own translation!
hooks:
strip_comments: true
fix_heading: true