-
-
Notifications
You must be signed in to change notification settings - Fork 962
/
mkdocs.yml
232 lines (223 loc) · 7.32 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
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
site_name: Spaceship
site_author: Spaceship Team
site_url: https://spaceship-prompt.sh
site_description: Minimalistic, powerful and extremely customizable Zsh prompt
copyright: "Copyright © 2021 Denys Dovhan"
repo_url: https://github.com/spaceship-prompt/spaceship-prompt
repo_name: spaceship-prompt
theme:
name: material
custom_dir: docs/overrides
logo: //spaceship-prompt.github.io/brand/spaceship-no-letters.svg
icon:
repo: fontawesome/brands/github
favicon: assets/favicon.ico
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-sunny
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-night
name: Switch to light mode
features:
- navigation.sections
- navigation.indexes
- navigation.instant
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- search.highlight
- toc.integrate
nav:
- Home: index.md
- Getting Started: getting-started.md
- Configuration:
- Introduction: config/intro.md
- Prompt configuration: config/prompt.md
- Loading custom sections: config/loading-sections.md
- Built-in Sections:
- sections/index.md
- Prompt character (char): sections/char.md
- Time (time): sections/time.md
- Username (user): sections/user.md
- Hostname (host): sections/host.md
- Directory (dir): sections/dir.md
- Line separator (line_sep): sections/line_sep.md
- Async (async): sections/async.md
- Battery (battery): sections/battery.md
- Execution time (exec_time): sections/exec_time.md
- Exit code (exit_code): sections/exit_code.md
- Jobs (jobs): sections/jobs.md
- Git (git): sections/git.md
- Mercurial (hg): sections/hg.md
- Package (package): sections/package.md
- Node.js (node): sections/node.md
- Bun (bun): sections/bun.md
- Deno (deno): sections/deno.md
- Ruby (ruby): sections/ruby.md
- Elm (elm): sections/elm.md
- Elixir (elixir): sections/elixir.md
- Xcode (xcode): sections/xcode.md
- Swift (swift): sections/swift.md
- Go (golang): sections/golang.md
- Perl (perl): sections/perl.md
- PHP (php): sections/php.md
- Python (python): sections/python.md
- Rust (rust): sections/rust.md
- Haskell (haskell): sections/haskell.md
- Scala (scala): sections/scala.md
- Java (java): sections/java.md
- Lua (lua): sections/lua.md
- Dart (dart): sections/dart.md
- Julia (julia): sections/julia.md
- Crystal (crystal): sections/crystal.md
- Docker (docker): sections/docker.md
- Docker Compose (docker_compose): sections/docker_compose.md
- Amazon Web Services (aws): sections/aws.md
- Google Cloud Platform (gcloud): sections/gcloud.md
- Virtualenv (venv): sections/venv.md
- Conda virtualenv (conda): sections/conda.md
- .NET (dotnet): sections/dotnet.md
- OCaml (ocaml): sections/ocaml.md
- Kubernetes (kubectl): sections/kubectl.md
- Ansible (Ansible): sections/ansible.md
- Terraform (terraform): sections/terraform.md
- Pulumi (pulumi): sections/pulumi.md
- IBM Cloud (ibmcloud): sections/ibmcloud.md
- Nix Shell (nix-shell): sections/nix_shell.md
- Advanced:
- Creating a custom section: advanced/creating-section.md
- Per-directory configuration: advanced/per-directory-config.md
- API:
- Environment: api/environment.md
- Sections: api/section.md
- General utilities: api/utils.md
- Testing kit: api/testkit.md
- Registry: registry.md
- FAQ: faq.md
- Blog:
- blog/index.md
- 2022:
- Announcing Spaceship v4 — the faster, the better: blog/2022-spaceship-v4.md
- 2018:
- Meet Spaceship v3.0!: blog/2018-spaceship-v3.md
- 2017:
- A big update of spaceship-zsh-theme: blog/2017-spaceship-v2.md
- Contribute: contribute.md
markdown_extensions:
- meta
- md_in_html
- def_list
- toc:
permalink: true
- attr_list
- tables
- pymdownx.tabbed:
alternate_style: true
- admonition
- footnotes
- pymdownx.details
- pymdownx.superfences
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
extra:
alternate:
- name: English
lang: en
link: /en
- name: Deutsch
lang: de
link: /de
- name: Français
lang: fr
link: /fr
- name: Українська
lang: uk
link: /uk
- name: 简体中文
lang: zh
link: /zh
- name: Help translating
link: https://translate.spaceship-prompt.sh
analytics:
provider: google
property: G-0STBM9BNC1
social:
- icon: fontawesome/brands/github
link: https://github.com/spaceship-prompt/spaceship-prompt
- icon: fontawesome/brands/twitter
link: https://twitter.com/SpaceshipPrompt
- icon: fontawesome/brands/discord
link: https://discord.gg/NTQWz8Dyt9
extra_css:
- assets/styles/themes.css
- assets/styles/embed.css
- assets/styles/hero.css
- assets/styles/companies.css
- assets/styles/announce.css
- assets/styles/registry.css
extra_javascript:
- https://cdn.jsdelivr.net/npm/lodash@4.17.15/lodash.min.js
- assets/scripts/registry.js
plugins:
- search:
lang:
- en
- de
- fr
- uk
- zh
- redirects:
redirect_maps:
options.md: config/intro.md
api.md: api/environment.md
troubleshooting.md: faq.md
- i18n:
default_language: en
# Default behavior doesn't display language switcher for non-English pages
material_alternate: false
languages:
en:
name: English
de:
name: Deutsch
fr:
name: Français
uk:
name: Українська
zh:
name: 简体中文
nav_translations:
de: # TODO: Add German translations
fr: # TODO: Add French translations
uk:
Home: Головна
Getting Started: Початок роботи
Configuration: Конфігурація
Introduction: Вступ
Prompt configuration: Налаштування командного рядка
Loading custom sections: Завантаження власних секцій
Built-in Sections: Вбудовані секції
Advanced: Розширені можливості
Creating a custom section: Створення власної секції
Per-directory configuration: Налаштування для кожної директорії
API: API
Environment: Середовище
Sections: Секції
General utilities: Загальні утиліти
Testing kit: Інструменти тестування
Registry: Реєстр
FAQ: ЧАПИ
Blog: Блог
Contribute: Зробити внесок
zh: # TODO: Add Chinese translations