-
Notifications
You must be signed in to change notification settings - Fork 21
/
Copy pathmkdocs.yml
184 lines (178 loc) · 4.68 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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# official tutorial
# mkdocs-material: https://squidfunk.github.io/mkdocs-material/
# mkdocs: https://www.mkdocs.org/user-guide/configuration/
site_name: kube
repo_url: https://github.com/kube-rs/kube
repo_name: kube
# NB: edit uri won't work well with sync system if we don't have canonical docs in the same repo as the site
#edit_uri: edit/main/docs
edit_uri: 'https://github.com/kube-rs/website/edit/main/docs'
theme:
icon:
repo: fontawesome/brands/github
name: material
logo: favicon.png
favicon: favicon.png
palette:
# dark mode
- scheme: slate
# use a lighter blue for banner and buttons (indigo too dark for buttons)
primary: blue
accent: blue
media: "(prefers-color-scheme: dark)"
toggle:
icon: material/toggle-switch
name: Switch to light mode
# light mode
- scheme: default
media: "(prefers-color-scheme: light)"
primary: indigo
accent: light blue
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
language: en
features:
- navigation.tabs
#- navigation.indexes
- navigation.sections
- navigation.instant
- navigation.tracking
- navigation.prune
- content.action.edit
# NB: Maintaining the nav list is not necessary, but is needed to reorder.
# Generated from "fd .md ." in docs/ folder.
# mkdocs serve will tell us about uncovered documents or broken links
nav:
- Information:
Usage:
#- index.md
- getting-started.md
#- quick-tutorial.md
- changelog.md
- features.md
- upgrading.md
- troubleshooting.md
Policies:
- security.md
- stability.md
- rust-version.md
- kubernetes-version.md
- release-process.md
Third Party:
- adopters.md
- guides.md
- Controllers:
Concepts:
- controllers/intro.md
- controllers/object.md
- controllers/reconciler.md
- controllers/application.md
- controllers/relations.md
- controllers/gc.md
- controllers/schemas.md
Advanced:
- controllers/testing.md
- controllers/admission.md
- controllers/streams.md
- controllers/generics.md
- controllers/internals.md
Operational:
- controllers/observability.md
- controllers/optimization.md
- controllers/manifests.md
- controllers/security.md
- controllers/scaling.md
- controllers/availability.md
#- comunity.md
#- proposal-process.md
#- mentorship.md
#- coding-style.md
- Crates:
- crates/kube.md
- crates/kube-core.md
- crates/kube-client.md
- crates/kube-derive.md
- crates/kube-runtime.md
# Maybe something for the future
#- Proposals/Rejected: []
#- Proposals/Done: []
#- Proposals/Accepted: []
- Contributing:
#- code-of-conduct.md
- governance.md
- maintainers.md
- contributing.md
- website.md
- tools.md
- architecture.md
- Blog:
- blog/index.md
markdown_extensions:
- attr_list # https://squidfunk.github.io/mkdocs-material/reference/images/
- pymdownx.tabbed # https://squidfunk.github.io/mkdocs-material/reference/content-tabs/
- nl2br # newline-to-break
- md_in_html # allow markdown within html blocks
- toc:
permalink: '#' # heading anchor
slugify: !!python/name:pymdownx.slugs.uslugify
- admonition
- codehilite:
guess_lang: false
linenums: false
- footnotes
- abbr
- pymdownx.snippets
- meta
- def_list
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist
- pymdownx.tilde
# mermaid diagrams
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
plugins:
- search
- roamlinks
#- autolinks
- blog
- exclude:
glob:
- "*.tmp"
- "*.pdf"
- "*.gz"
regex:
- '.*\.(tmp|bin|tar)$'
copyright: ''
extra:
generator: false
social:
#- icon: fontawesome/regular/bookmark
# link: https://kube.rs
- icon: fontawesome/brands/rust
link: https://docs.rs/kube
- icon: fontawesome/brands/github
link: https://github.com/kube-rs/kube/discussions
#- icon: fontawesome/brands/mastodon
# link: https://hachyderm.io/@clux
# better than twitter, but not really doing PR
- icon: fontawesome/brands/discord
link: https://discord.gg/tokio
- icon: fontawesome/brands/linux
link: https://www.linuxfoundation.org/legal/trademark-usage