-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
161 lines (154 loc) · 5.3 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
# Project information
site_name: Brain pages
site_url: https://poulti.github.io/brain-pages/
site_author: Poulti
site_description: >-
Auto published notes from Poulti's second brain
# Repository
repo_name: poulti/brain-pages
repo_url: https://github.com/poulti/brain-pages/
# Copyright
copyright: Copyright © 2025 Poulti
# Customization
extra:
social:
- icon: 'fontawesome/brands/twitter'
link: 'https://twitter.com/poulti'
# Configuration
theme:
name: material
custom_dir: overrides
features:
- content.code.copy
- content.code.annotate
palette:
- media: "(prefers-color-scheme: light)"
scheme: light
primary: 'amber'
accent: 'orange'
toggle:
icon: material/toggle-switch-off-outline
name: Come to the dark side
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: 'deep orange'
accent: 'amber'
toggle:
icon: material/toggle-switch
name: Switch to light mode
icon:
logo: logo-brain-pages
extra_css:
- stylesheets/extra.css
# Plugins
plugins:
- search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- minify:
minify_html: true
- glightbox
#FIXME: doesn't work with the preview env
- git-revision-date-localized
# Extensions
markdown_extensions:
- mdx_include:
base_path: docs
- admonition
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.snippets
- pymdownx.highlight:
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
options:
custom_icons:
- overrides/.icons
- attr_list
- md_in_html
# Page tree example
# nav:
# - Home: index.md
# - Getting started:
# - Installation: getting-started.md
# - Creating your site: creating-your-site.md
# - Publishing your site: publishing-your-site.md
# - Customization: customization.md
# - Browser support: browser-support.md
# - Philosophy: philosophy.md
# - Alternatives: alternatives.md
# - License: license.md
# - Changelog:
# - changelog/index.md
# - How to upgrade: upgrade.md
# - Contributing:
# - contributing/index.md
# - Reporting a bug: contributing/reporting-a-bug.md
# - Reporting a docs issue: contributing/reporting-a-docs-issue.md
# - Requesting a change: contributing/requesting-a-change.md
# - Asking a question: https://github.com/squidfunk/mkdocs-material/discussions
# - Guides:
# - Creating a reproduction: guides/creating-a-reproduction.md
# - Setup:
# - Changing the colors: setup/changing-the-colors.md
# - Changing the fonts: setup/changing-the-fonts.md
# - Changing the language: setup/changing-the-language.md
# - Changing the logo and icons: setup/changing-the-logo-and-icons.md
# - Ensuring data privacy: setup/ensuring-data-privacy.md
# - Setting up navigation: setup/setting-up-navigation.md
# - Setting up site search: setup/setting-up-site-search.md
# - Setting up site analytics: setup/setting-up-site-analytics.md
# - Setting up social cards: setup/setting-up-social-cards.md
# - Setting up a blog: setup/setting-up-a-blog.md
# - Setting up tags: setup/setting-up-tags.md
# - Setting up versioning: setup/setting-up-versioning.md
# - Setting up the header: setup/setting-up-the-header.md
# - Setting up the footer: setup/setting-up-the-footer.md
# - Adding a git repository: setup/adding-a-git-repository.md
# - Adding a comment system: setup/adding-a-comment-system.md
# - Building an optimized site: setup/building-an-optimized-site.md
# - Building for offline usage: setup/building-for-offline-usage.md
# - Extensions:
# - setup/extensions/index.md
# - Python Markdown: setup/extensions/python-markdown.md
# - Python Markdown Extensions: setup/extensions/python-markdown-extensions.md
# - Dependencies:
# - setup/dependencies/image-processing.md
# - Reference:
# - reference/index.md
# - Admonitions: reference/admonitions.md
# - Annotations: reference/annotations.md
# - Buttons: reference/buttons.md
# - Code blocks: reference/code-blocks.md
# - Content tabs: reference/content-tabs.md
# - Data tables: reference/data-tables.md
# - Diagrams: reference/diagrams.md
# - Footnotes: reference/footnotes.md
# - Formatting: reference/formatting.md
# - Grids: reference/grids.md
# - Icons, Emojis: reference/icons-emojis.md
# - Images: reference/images.md
# - Lists: reference/lists.md
# - MathJax: reference/mathjax.md
# - Tooltips: reference/tooltips.md
# - Insiders:
# - insiders/index.md
# - Getting started:
# - Installation: insiders/getting-started.md
# - Changelog: insiders/changelog.md
# - Blog:
# - blog/index.md
# - 2022:
# - blog/posts/blog-support-just-landed.md
# - blog/posts/chinese-search-support.md
# - 2021:
# - blog/posts/the-past-present-and-future.md
# - blog/posts/excluding-content-from-search.md
# - blog/posts/search-better-faster-smaller.md