/
mkdocs.yml
222 lines (216 loc) · 6.08 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
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: DDEV Docs
# todo: Make sure to set this to the correct one; otherwise it breaks 404 page
site_url: https://ddev.readthedocs.io/en/stable/
repo_url: https://github.com/ddev/ddev
repo_name: ddev/ddev
edit_uri: blob/master/docs/content
copyright: DDEV Foundation
extra_javascript:
- 'assets/jquery-3.5.1.min.js'
#- 'assets/extra.js'
- 'assets/temp-fix-header-links-in-tabs.js'
extra_css:
- 'assets/extra.css'
site_author: DDEV Foundation
site_description: >-
Do local website development on your computer or in the cloud with DDEV.
docs_dir: docs/content
# Configuration
theme:
name: material
custom_dir: docs/overrides
icon:
edit: material/pencil
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
primary: indigo
accent: indigo
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
primary: indigo
accent: indigo
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference
primary: indigo
accent: indigo
features:
- content.action.edit
- content.code.copy
# - content.tabs.link
- navigation.expand
- navigation.indexes
# - navigation.instant
- navigation.sections
- navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
# - toc.follow
# - toc.integrate
- navigation.footer
- search.suggest
favicon: favicon.png
# readthedocs doesn't seem to do logo css right
# logo: /logo.svg
# Plugins
plugins:
- search
- privacy
- redirects:
redirect_maps:
- minify:
minify_html: true
- git-revision-date-localized:
# enable_creation_date: true
#- git-committers:
# repository: https://github.com/ddev/ddev
# token: !ENV GH_TOKEN
# Customization
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/ddev/ddev
- icon: fontawesome/brands/discord
link: https://discord.gg/5wjP76mBJD
- icon: fontawesome/brands/stack-overflow
link: https://stackoverflow.com/tags/ddev
- icon: fontawesome/brands/twitter
link: https://twitter.com/search?q=%23ddev&src=unknown&f=live
generator: false
analytics:
provider: plausible
version: !ENV [READTHEDOCS_VERSION_NAME, 'stable']
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- toc:
permalink: true
toc_depth: 2
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
extend_pygments_lang:
- name: php
lang: php
options:
startinline: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: ddev
repo: ddev
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- smarty
nav:
- "Start!":
- index.md
- 'Installing':
- users/install/index.md
- users/install/docker-installation.md
- users/install/ddev-installation.md
- 'Upgrading': users/install/ddev-upgrade.md
- 'Getting Started':
- users/project.md
- users/quickstart.md
- users/install/performance.md
- users/install/shell-completion.md
- users/install/phpstorm.md
- 'Usage':
- 'Common Tasks':
- users/usage/index.md
- users/usage/cli.md
- users/usage/database-management.md
- users/usage/cms-settings.md
- users/usage/managing-projects.md
- users/usage/troubleshooting.md
- users/usage/offline.md
- 'Reference':
- users/usage/architecture.md
- users/usage/commands.md
- users/usage/developer-tools.md
- users/usage/diagnostics.md
- 'Uninstalling': users/usage/uninstall.md
- 'Getting Help':
- users/usage/faq.md
- users/support.md
- users/code-of-conduct.md
- 'Configuration':
- users/configuration/config.md
- users/extend/database-types.md
- users/configuration/hooks.md
- users/extend/additional-hostnames.md
- users/configuration/experimental.md
- 'Extending':
- users/extend/customization-extendibility.md
- users/extend/additional-services.md
- users/extend/custom-compose-files.md
- users/extend/customizing-images.md
- users/extend/custom-commands.md
- users/extend/in-container-configuration.md
- users/extend/custom-tls-certificates.md
- users/extend/traefik-router.md
- 'Debugging & Profiling':
- users/debugging-profiling/step-debugging.md
- 'Profiling':
- users/debugging-profiling/blackfire-profiling.md
- users/debugging-profiling/xhprof-profiling.md
- users/debugging-profiling/xdebug-profiling.md
- 'Hosting & Deployment':
- users/topics/index.md
- users/topics/sharing.md
- users/topics/hosting.md
- users/topics/remote-docker.md
- 'Hosting Provider Integrations':
- users/providers/index.md
- 'Acquia': users/providers/acquia.md
- 'Lagoon': users/providers/lagoon.md
- 'Pantheon': users/providers/pantheon.md
- 'Platform.sh': users/providers/platform.md
- 'Upsun': users/providers/upsun.md
- 'Development':
- developers/index.md
- developers/building-contributing.md
- developers/buildkite-testmachine-setup.md
- developers/github-selfhosted-setup.md
- developers/project-types.md
- developers/release-management.md
- developers/brand-guide.md
- developers/testing-docs.md
- developers/writing-style-guide.md
- developers/remote-config.md
- developers/maintainers.md