-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathmkdocs.yml
More file actions
211 lines (195 loc) · 5.61 KB
/
mkdocs.yml
File metadata and controls
211 lines (195 loc) · 5.61 KB
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
###
### mkdocs-theme.yml
###
copyright:
'©2021-2025 Nir Geier<br/><a href="https://visitor-badge.laobi.icu/badge?page_id=nirgeier" target="_blank" rel="noopener"><img
src="https://visitor-badge.laobi.icu/badge?page_id=nirgeier" alt="Visitor Badge"></a>'
theme:
name: material
custom_dir: mkdocs/overrides
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.code.select
- content.footnote.tooltips
- content.tabs.link
- content.tooltips
- content.footer.last-updated
- content.footer.contributors
- navigation.expand: false
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
- navigation.prune
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top: true
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
- toc.integrate
- toc.sticky
#- header.autohide # Disabled to keep top nav always visible
# 👈 enables avatar display
palette:
# Dark mode only
- scheme: slate
primary: indigo # You can choose any color here
font:
text: Mulish
code: JetBrains Mono
favicon: assets/favicon.png
icon:
logo: logo
repo: fontawesome/brands/github
admonition:
note: material/lightbulb
###
### mkdocs-nav.yml
###
nav:
- index.md
- Basic Commands: 01-Commands.md
- Basic Bash scripting: 02-Scripting.md
- Bash Functions: 03-Functions.md
- Bash Loops: 04-Loops.md
- Vim Cheat Sheet: 05-Vim-Cheat-Sheet.md
###
### mkdocs-site.yml
###
docs_dir: Labs
edit_uri:
repo_name: nirgeier/UnixLabs
repo_url: https://github.com/nirgeier/UnixLabs
site_author: Nir Geier - nirgeier@gmail.com
site_description: A collection of GitHub Labs for learning and practicing GitHub skills.
site_dir: ./mkdocs-site
site_name: Bash Scripting Labs
site_url: https://nirgeier.github.io/UnixLabs/
###
### mkdocs-extra.yml
###
extra:
assets:
- ./assets/images/
generator: false
social:
- icon: fontawesome/brands/github
link: https://github.com/nirgeier/UnixLabs
name: View on GitHub
class: social-class__github
- icon: octicons/repo-forked-16
link: https://github.com/nirgeier/UnixLabs/network/members
name: Fork this repo
class: social-class__fork
- icon: octicons/star-16
link: https://github.com/nirgeier/UnixLabs/stargazers
name: Star this repo
class: social-class__star
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/in/nirgeier/
name: Connect on LinkedIn
class: social-class__linkedin
- icon: fontawesome/brands/discord
link: https://discord.gg/U6xW23Ss
name: Follow me on Discord
class: social-class__discord
- icon: fontawesome/brands/stack-overflow
link: https://stackoverflow.com/users/1755598/codewizard
name: Follow me on Stack Overflow
class: social-class__stackoverflow
- icon: fontawesome/brands/whatsapp
link: https://wa.me/972548122310
name: Follow me on WhatsApp
class: social-class__whatsapp
- icon: fontawesome/solid/envelope
link: mailto:nirg@codewizard.co.il
name: Email me
class: social-class__email
extra_css:
- ./assets/stylesheets/codewizard.css?v=1765703719
extra_javascript:
- https://buttons.github.io/buttons.js?v=1765703719
- assets/javascripts/truncate_nav.js?v=1765703719
###
### mkdocs-extensions.yml
###
markdown_extensions:
- toc:
permalink: true
baselevel: 1
toc_depth: 3
- abbr
- tables
- admonition # For callouts/notes
- footnotes # Footnotes support
- attr_list # Attribute lists for elements
- def_list # Definition lists
- md_in_html # Markdown inside HTML blocks
- smarty # Smart punctuation
- meta
- codehilite:
guess_lang: true # Fallback code highlighting
- pymdownx.tabbed:
alternate_style: true
- pymdownx.details # Collapsible details
- pymdownx.inlinehilite # Inline code highlighting
- pymdownx.keys # Keyboard key formatting
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.tilde # Subscript/superscript
- pymdownx.snippets # Snippet includes
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: "!!python/name:pymdownx.superfences.fence_code_format"
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
###
### mkdocs-plugins.yml
###
plugins:
- awesome-pages
- meta
# - pdf-export:
# combined: true # all pages in one PDF
# combined_output_path: docs/Full-Documentation.pdf
# media_type: print
# verbose: true
# Git
#- git-authors
- git-committers:
branch: main
docs_path: Labs # set if your docs folder is not root
enabled: true
repository: nirgeier/UnixLabs
- git-revision-date-localized:
enable_creation_date: true
enable_git_follow: false
fallback_to_build_date: true
locale: en
timezone: UTC
type: date
- search:
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- minify:
minify_html: true
# Leave this one as the last one in the list
- print-site
- include-markdown