-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
141 lines (129 loc) · 3.17 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
# Project information
site_name: 'MkDocs DoItYourself'
site_description: 'A Multiarch docker container for MkDocs + Material Design theme'
site_author: 'Eloy Lopez'
site_url: 'https://DeftWork.github.io/mkdocs-diy/'
# Repository
repo_name: DeftWork/mkdocs-diy
repo_url: https://github.com/DeftWork/mkdocs-diy
# Copyright
copyright: 'Copyright © 2024 Eloy Lopez'
# Configuration
theme:
name: material
#custom_dir: !ENV [THEME_DIR, "material"]
# Static files
static_templates:
- 404.html
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
features:
- content.code.annotate
- content.tabs.link
# - header.autohide
# - navigation.expand
- navigation.indexes
# - navigation.instant
- navigation.sections
- navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
# - toc.integrate
palette:
- scheme: default
#primary: indigo
primary: css/extra.css
#accent: indigo
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: css/extra.css
#accent: red
toggle:
icon: material/toggle-switch
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
favicon: assets/images/favicon.png
icon:
logo: logo
# Avoid collision with gh-pages
#docs_dir: 'mkdocs'
#site_dir: 'docs'
site_dir: mkdocs
# Query string example
edit_uri: edit/master/docs/
# Plugins
plugins:
- search
# - macros
# - redirects:
# redirect_maps:
# changelog/insiders.md: insiders/changelog.md
# - minify:
# minify_html: true
# Customization
extra_css:
- css/extra.css
extra:
analytics:
provider: google
#property: !ENV GOOGLE_ANALYTICS_KEY
property: UA-139487885-1
social:
- icon: fontawesome/brands/github
link: https://github.com/elswork
- icon: fontawesome/brands/docker
link: https://hub.docker.com/u/elswork
- icon: fontawesome/brands/twitter
link: https://twitter.com/elswork
- icon: fontawesome/brands/linkedin
link: https://linkedin.com/in/elswork/
# Extensions
markdown_extensions:
- admonition
- abbr
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: elswork
repo: cv-eloy.deft.work
- 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