-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
167 lines (157 loc) · 4.04 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
# =====================================
# Project Information
# =====================================
site_name: KafREST
site_url: https://mauricioromagnollo.github.io/kafrest/
site_author: Maurício Romagnollo
# =====================================
# Repository
# =====================================
repo_name: Github
repo_url: https://github.com/mauricioromagnollo/kafrest/
# =====================================
# Copyright
# =====================================
copyright: Copyright © 2023 - Maurício Romagnollo
# =====================================
# Theme
# =====================================
theme:
name: material
favicon: assets/favicon.ico
logo: assets/favicon.ico
font:
text: Roboto
code: Roboto Mono
icon:
logo: logo
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: slate
primary: black
accent: indigo
toggle:
icon: material/weather-sunny
name: Switch to light mode
features:
# - announce.dismiss
# - content.action.edit
# - content.action.view
- content.code.annotate
- content.code.copy
# - content.code.select
# - 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
extra_css:
- stylesheets/extra.css
# =====================================
# Plugins
# =====================================
# plugins:
# - minify:
# minify_html: true
# =====================================
# Extensions - Markdown
# =====================================
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
# - toc:
# permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:material.extensions.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
normalize_issue_symbols: true
repo_url_shorthand: true
user: squidfunk
repo: mkdocs-material
- pymdownx.mark
- pymdownx.smartsymbols
# - pymdownx.snippets:
# auto_append:
# - includes/mkdocs.md
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
combine_header_slug: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# =====================================
# Exclude Files When Compile
# =====================================
exclude_docs: |
drafts/
*.py
!/foo/example.py
tmp/
# =====================================
# Footer
# =====================================
extra:
generator: false
annotate:
json: [.s2]
social:
- icon: fontawesome/brands/github
link: https://github.com/mauricioromagnollo
- icon: fontawesome/brands/instagram
link: https://www.instagram.com/mauricioromagnollo/
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/in/mauricioromagnollo/
# =====================================
# Exclude in Navigation
# =====================================
not_in_nav: |
/private.md
# =====================================
# Navigation
# =====================================
nav:
- Kafrest: 'INDEX.md'
- Contributing: 'CONTRIBUTING.md'