generated from jobindjohn/obsidian-publish-mkdocs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
131 lines (123 loc) · 5.18 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
site_name: Notes Not Scandal
site_url: https://didiowen.github.io/notes-not-scandal/
site_description: inspired by Cate Blanchett's Notes on a Scandal
site_author: YW Chen
theme:
name: 'material'
logo: assets/virus.png
favicon: assets/virus.png
# custom_dir: overrides
features:
- navigation.tabs # top-level sections are rendered in a menu layer below the header for viewports above 1220px, but remain as-is on mobile
- navigation.tabs.sticky # navigation tabs will lock below the header and always remain visible when scrolling down
- navigation.sections # top-level sections are rendered as groups in the sidebar for viewports above 1220px, but remain as-is on mobile
- navigation.tracking # the URL in the address bar is automatically updated with the active anchor as highlighted in the table of contents
- navigation.top # A back-to-top button can be shown when the user, after scrolling down, starts to scroll up again
- toc.follow # the sidebar is automatically scrolled so that the active anchor is always visible
- search.highlight
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: green
accent: amber
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: light green
accent: lime
toggle:
icon: material/toggle-switch
name: Switch to light mode
# Extensions
markdown_extensions:
- footnotes
- md_in_html
- abbr # adds the ability to add a small tooltip to an element, by wrapping it with an abbr tag
- admonition # adds support for admonitions, more commonly known as call-outs, which can be defined in Markdown
- attr_list # allows to add HTML attributes and CSS classes to almost every Markdown inline- and block-level element with a special syntax
- pymdownx.arithmatex: # allows for rendering of block and inline block equations and integrates seamlessly with MathJax
generic: true
- tables
- toc:
permalink: true
title: Table of contents
- pymdownx.tasklist:
custom_checkbox: true
- def_list
- nl2br
- pymdownx.critic # allows for the usage of Critic Markup to highlight added, deleted or updated sections in a document
- pymdownx.caret # The Caret, Mark and Tilde extensions add the ability to highlight text and define sub- and superscript using a simple syntax
- pymdownx.mark
- pymdownx.tilde
- pymdownx.keys # adds a simple syntax to allow for the rendering of keyboard keys and combinations
- pymdownx.betterem # improves the detection of Markup to emphasize text in Markdown using special characters
- pymdownx.details # supercharges the Admonition extension, making the resulting call-outs collapsible
- pymdownx.superfences # allows for arbitrary nesting of code and content blocks inside each other, including admonitions, tabs, lists and all other elements
- pymdownx.magiclink
# - pymdownx.superfences:
# custom_fences:
# - name: mermaid
# class: mermaid
# format: !!python/name:pymdownx.superfences.fence_code_format
plugins:
- search
- callouts
- roamlinks
- blog:
blog_dir: .
blog_toc: true
pagination: false
pagination_per_page: 2
post_excerpt_separator: <!-- more -->
post_url_format: "{categories}/{slug}"
post_url_max_categories: 1
post_slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
archive_date_format: yyyy/MM
archive_url_date_format: yyyy/MM
- git-revision-date-localized:
type: timeago
# - bibtex:
# bib_file: "docs/assets/library.bib"
# bib_by_default: true
# csl_file: "docs/assets/harvard-imperial.csl"
# cite_inline: true
# - minify:
# minify_html: true
# minify_js: true
# minify_css: true
# - glightbox
extra:
social:
- icon: /fontawesome/regular/envelope
name: send me an email
link: mailto:<[email protected]>
# SEO: assets/meta/SEO.png
# comments: $comments #disable comments globally
# generate_graph: $generate_graph #generate the graph of the site
# no-auto-h1: $auto_h1 #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:
# - overrides/hooks/on_page_markdown.py
# - overrides/hooks/on_env.py
# - overrides/hooks/on_files.py
#hooks:
# strip_comments: true
# fix_heading: true
extra_javascript:
- 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://unpkg.com/mermaid/dist/mermaid.min.js
- https://cdn.jsdelivr.net/gh/ObsidianPublisher/assets@main/dist/javascript.js
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0-beta3/css/all.min.css