-
Notifications
You must be signed in to change notification settings - Fork 3
/
mkdocs.yml
161 lines (152 loc) · 4.05 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
site_name: kubenet
nav:
- Home: index.md
- Getting Started:
- Getting started: 01-getting-started/01_install.md
- Prerequisites: 01-getting-started/02_prereq.md
- Examples/Tutorials:
- About: 02-examples/01_about.md
- Discovery: 02-examples/02_discovery.md
- Inventory: 02-examples/03_inventory.md
- Network Config: 02-examples/04_networkconfig.md
- Default Network: 02-examples/05_defaultnetwork.md
- Bridged Network: 02-examples/06_bridgednetwork.md
- Routed Network: 02-examples/07_routednetwork.md
- IRB Network: 02-examples/08_irbnetwork.md
- GitOps: 02-examples/09_gitops.md
- Videos/Presentations/Articles: 03-videos/01_videos.md
- Community:
- Community: 04-community/01_about.md
site_author: Wim Henderickx
site_description: >-
Kubenet is a community initiative to help network automation engineers understand kubernetes
# repository
repo_name: kubenet-dev/kubenet
repo_url: https://github.com/kubenet-dev/kubenet
site_url: "https://learn.kubenet.dev"
theme:
name: material
custom_dir: docs/overrides
# 404 page
static_templates:
- 404.html
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
language: en
features:
- navigation.top
- navigation.instant
- navigation.tracking
- navigation.tabs
- navigation.expand
- navigation.indexes
- navigation.sections
- navigation.tabs.sticky
- search.suggest
- content.code.annotate
- content.code.copy
- content.code.select
- content.action.edit
- content.tooltips
#- header.autohide
#- search.highlight
#- search.share
#- search.suggest
#- toc.integrate
- toc.follow
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white
accent: cyan
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: cyan
toggle:
icon: material/toggle-switch
name: Switch to light mode
font:
text: Manrope
code: Fira Mono
icon:
logo: kubenet_logo_only_final
repo: fontawesome/brands/github
edit: material/file-edit-outline
favicon: docs/images/kubenet_logo_only_final.svg
# Plugins
plugins:
- search
- mermaid2
- minify:
minify_html: true
# Customization
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/kubenet-dev
- icon: fontawesome/brands/discord
link: https://discord.gg/fH35bmcTU9
extra_css:
- stylesheets/extra.css
# Extensions
markdown_extensions:
- markdown.extensions.admonition
- markdown.extensions.attr_list
- markdown.extensions.codehilite:
guess_lang: false
- markdown.extensions.def_list
- markdown.extensions.footnotes
- markdown.extensions.meta
- md_in_html
- toc:
permalink: "#"
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight:
line_spans: __span
anchor_linenums: true
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: kubenet
repo: docs
- pymdownx.mark
- pymdownx.smartsymbols:
fractions: false
- pymdownx.snippets:
check_paths: true
#dedent_subsections: true
base_path:
- ./
url_download: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.blocks.tab:
alternate_style: true
- pymdownx.blocks.admonition
- pymdownx.blocks.definition
- pymdownx.blocks.details
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde