github.com/ddev/ddev@v1.23.2-0.20240519125000-d824ffe36ff3/mkdocs.yml (about) 1 # yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json 2 site_name: DDEV Docs 3 # todo: Make sure to set this to the correct one; otherwise it breaks 404 page 4 site_url: https://ddev.readthedocs.io/en/stable/ 5 repo_url: https://github.com/ddev/ddev 6 repo_name: ddev/ddev 7 edit_uri: blob/master/docs/content 8 copyright: DDEV Foundation 9 extra_javascript: 10 - 'assets/jquery-3.5.1.min.js' 11 #- 'assets/extra.js' 12 - 'assets/temp-fix-header-links-in-tabs.js' 13 extra_css: 14 - 'assets/extra.css' 15 site_author: DDEV Foundation 16 site_description: >- 17 Do local website development on your computer or in the cloud with DDEV. 18 docs_dir: docs/content 19 20 # Configuration 21 theme: 22 name: material 23 custom_dir: docs/overrides 24 icon: 25 edit: material/pencil 26 palette: 27 # Palette toggle for automatic mode 28 - media: "(prefers-color-scheme)" 29 toggle: 30 icon: material/brightness-auto 31 name: Switch to light mode 32 primary: indigo 33 accent: indigo 34 # Palette toggle for light mode 35 - media: "(prefers-color-scheme: light)" 36 scheme: default 37 toggle: 38 icon: material/brightness-7 39 name: Switch to dark mode 40 primary: indigo 41 accent: indigo 42 # Palette toggle for dark mode 43 - media: "(prefers-color-scheme: dark)" 44 scheme: slate 45 toggle: 46 icon: material/brightness-4 47 name: Switch to system preference 48 primary: indigo 49 accent: indigo 50 features: 51 - content.action.edit 52 - content.code.copy 53 # - content.tabs.link 54 - navigation.expand 55 - navigation.indexes 56 # - navigation.instant 57 - navigation.sections 58 - navigation.tabs 59 # - navigation.tabs.sticky 60 - navigation.top 61 - navigation.tracking 62 # - toc.follow 63 # - toc.integrate 64 - navigation.footer 65 - search.suggest 66 favicon: favicon.png 67 # readthedocs doesn't seem to do logo css right 68 # logo: /logo.svg 69 70 # Plugins 71 plugins: 72 - search 73 - privacy 74 - redirects: 75 redirect_maps: 76 - minify: 77 minify_html: true 78 - git-revision-date-localized: 79 # enable_creation_date: true 80 #- git-committers: 81 # repository: https://github.com/ddev/ddev 82 # token: !ENV GH_TOKEN 83 84 85 # Customization 86 extra: 87 social: 88 - icon: fontawesome/brands/github 89 link: https://github.com/ddev/ddev 90 - icon: fontawesome/brands/discord 91 link: https://discord.gg/5wjP76mBJD 92 - icon: fontawesome/brands/stack-overflow 93 link: https://stackoverflow.com/tags/ddev 94 - icon: fontawesome/brands/twitter 95 link: https://twitter.com/search?q=%23ddev&src=unknown&f=live 96 generator: false 97 analytics: 98 provider: plausible 99 version: !ENV [READTHEDOCS_VERSION_NAME, 'stable'] 100 101 # Extensions 102 markdown_extensions: 103 - abbr 104 - admonition 105 - attr_list 106 - def_list 107 - footnotes 108 - meta 109 - md_in_html 110 - toc: 111 permalink: true 112 toc_depth: 2 113 - pymdownx.arithmatex: 114 generic: true 115 - pymdownx.betterem: 116 smart_enable: all 117 - pymdownx.caret 118 - pymdownx.details 119 - pymdownx.emoji: 120 emoji_index: !!python/name:material.extensions.emoji.twemoji 121 emoji_generator: !!python/name:material.extensions.emoji.to_svg 122 - pymdownx.highlight: 123 anchor_linenums: true 124 extend_pygments_lang: 125 - name: php 126 lang: php 127 options: 128 startinline: true 129 - pymdownx.inlinehilite 130 - pymdownx.keys 131 - pymdownx.magiclink: 132 repo_url_shorthand: true 133 user: ddev 134 repo: ddev 135 - pymdownx.mark 136 - pymdownx.smartsymbols 137 - pymdownx.superfences: 138 - pymdownx.tabbed: 139 alternate_style: true 140 - pymdownx.tasklist: 141 custom_checkbox: true 142 - pymdownx.tilde 143 - smarty 144 145 nav: 146 - "Start!": 147 - index.md 148 - 'Installing': 149 - users/install/index.md 150 - users/install/docker-installation.md 151 - users/install/ddev-installation.md 152 - 'Upgrading': users/install/ddev-upgrade.md 153 - 'Getting Started': 154 - users/project.md 155 - users/quickstart.md 156 - users/install/performance.md 157 - users/install/shell-completion.md 158 - users/install/phpstorm.md 159 - 'Usage': 160 - 'Common Tasks': 161 - users/usage/index.md 162 - users/usage/cli.md 163 - users/usage/database-management.md 164 - users/usage/cms-settings.md 165 - users/usage/managing-projects.md 166 - users/usage/troubleshooting.md 167 - users/usage/offline.md 168 - 'Reference': 169 - users/usage/architecture.md 170 - users/usage/commands.md 171 - users/usage/developer-tools.md 172 - users/usage/diagnostics.md 173 - 'Uninstalling': users/usage/uninstall.md 174 - 'Getting Help': 175 - users/usage/faq.md 176 - users/support.md 177 - users/code-of-conduct.md 178 - 'Configuration': 179 - users/configuration/config.md 180 - users/extend/database-types.md 181 - users/configuration/hooks.md 182 - users/extend/additional-hostnames.md 183 - users/configuration/experimental.md 184 - 'Extending': 185 - users/extend/customization-extendibility.md 186 - users/extend/additional-services.md 187 - users/extend/custom-compose-files.md 188 - users/extend/customizing-images.md 189 - users/extend/custom-commands.md 190 - users/extend/in-container-configuration.md 191 - users/extend/custom-tls-certificates.md 192 - users/extend/traefik-router.md 193 - 'Debugging & Profiling': 194 - users/debugging-profiling/step-debugging.md 195 - 'Profiling': 196 - users/debugging-profiling/blackfire-profiling.md 197 - users/debugging-profiling/xhprof-profiling.md 198 - users/debugging-profiling/xdebug-profiling.md 199 - 'Hosting & Deployment': 200 - users/topics/index.md 201 - users/topics/sharing.md 202 - users/topics/hosting.md 203 - users/topics/remote-docker.md 204 - 'Hosting Provider Integrations': 205 - users/providers/index.md 206 - 'Acquia': users/providers/acquia.md 207 - 'Lagoon': users/providers/lagoon.md 208 - 'Pantheon': users/providers/pantheon.md 209 - 'Platform.sh': users/providers/platform.md 210 - 'Upsun': users/providers/upsun.md 211 - 'Development': 212 - developers/index.md 213 - developers/building-contributing.md 214 - developers/buildkite-testmachine-setup.md 215 - developers/github-selfhosted-setup.md 216 - developers/project-types.md 217 - developers/release-management.md 218 - developers/brand-guide.md 219 - developers/testing-docs.md 220 - developers/writing-style-guide.md 221 - developers/remote-config.md 222 - developers/maintainers.md