mirror of https://github.com/docker/docs.git
328 lines
9.4 KiB
YAML
328 lines
9.4 KiB
YAML
title: Docker Docs
|
|
baseURL: https://docs.docker.com
|
|
refLinksErrorLevel: ERROR
|
|
enableGitInfo: true
|
|
disablePathToLower: true
|
|
enableInlineShortcodes: true
|
|
ignoreLogs:
|
|
- cascade-pattern-with-extension
|
|
|
|
taxonomies:
|
|
tag: tags
|
|
language: languages
|
|
|
|
# Remove the /manuals prefix for content in the manuals section
|
|
permalinks:
|
|
page:
|
|
manuals: /:sections[1:]/:slugorfilename/
|
|
section:
|
|
manuals: /:sections[1:]/:slugorfilename/
|
|
|
|
markup:
|
|
tableOfContents:
|
|
startLevel: 2
|
|
endLevel: 3
|
|
goldmark:
|
|
extensions:
|
|
typographer: false
|
|
parser:
|
|
wrapStandAloneImageWithinParagraph: false
|
|
attribute:
|
|
# Allow setting attributes on block-level elements
|
|
block: true
|
|
renderer:
|
|
# Allow inline HTML
|
|
unsafe: true
|
|
highlight:
|
|
# Use custom CSS for syntax highlighting
|
|
noClasses: false
|
|
|
|
build:
|
|
# Generate hugo_stats.json - Tailwind uses this to detect classes
|
|
buildStats:
|
|
enable: true
|
|
disableIDs: true
|
|
disableTags: true
|
|
# Ensure that CSS/assets changes trigger a dev server rebuild
|
|
cachebusters:
|
|
- source: assets/watching/hugo_stats\.json
|
|
target: styles\.css
|
|
- source: (postcss|tailwind)\.config\.js
|
|
target: css
|
|
- source: assets/.*\.js
|
|
target: js
|
|
- source: (assets|layouts)/.*\.(.*)$
|
|
target: "$2"
|
|
|
|
# Additional output formats (e.g. custom JSON files)
|
|
outputFormats:
|
|
# File containing all redirects, see: layouts/index.redirects.json
|
|
redirects:
|
|
baseName: redirects
|
|
isPlainText: true
|
|
mediaType: "application/json"
|
|
notAlternative: true
|
|
# Metadata file used by DD global search, see: layouts/index.metadata.json
|
|
metadata:
|
|
baseName: metadata
|
|
isPlainText: true
|
|
mediaType: "application/json"
|
|
notAlternative: true
|
|
# robots.txt, see: layouts/index.robots.json
|
|
robots:
|
|
baseName: robots
|
|
isPlainText: true
|
|
mediaType: "text/plain"
|
|
notAlternative: true
|
|
|
|
# Enable custom output formats for the home page only
|
|
# (only generate the custom output files once)
|
|
outputs:
|
|
home:
|
|
- html
|
|
- redirects
|
|
- metadata
|
|
- robots
|
|
|
|
languages:
|
|
en:
|
|
languageName: English
|
|
|
|
# Site-wide parameters
|
|
# Can be accessed in content with {{% param "param_name" %}}
|
|
# Or in layouts/partials with site.Params.param_name
|
|
params:
|
|
kapa:
|
|
id: ba5c2cbc-6535-4334-a72e-050f7a681c8a
|
|
analytics:
|
|
hotjar:
|
|
prod: 3169877
|
|
stage: 3218181
|
|
google: GTM-WL2QLG5
|
|
onetrust: 65425fb0-7b36-4317-9f10-7b3e08039af0
|
|
vwo: 723167
|
|
|
|
# Docs repository URL
|
|
repo: https://github.com/docker/docs
|
|
|
|
# === Example versions ===
|
|
# The following parameters are used in various ways in content and templates.
|
|
# Mostly as examples in code snippets, but also in other exotic ways.
|
|
# Use `grep` to figure out how they might be used.
|
|
|
|
# Latest version of the Docker Engine API
|
|
latest_engine_api_version: "1.48"
|
|
# Latest version of Docker Engine
|
|
docker_ce_version: "28.0.1"
|
|
# Previous version of the Docker Engine
|
|
# (Used to show e.g., "latest" and "latest"-1 in engine install examples
|
|
docker_ce_version_prev: "28.0.0"
|
|
# Latest Docker Compose version
|
|
compose_version: "v2.33.1"
|
|
# Latest BuildKit version
|
|
buildkit_version: "0.20.0"
|
|
|
|
# Example runtime/library/os versions
|
|
example_go_version: "1.23"
|
|
example_alpine_version: "3.21"
|
|
example_node_version: "20"
|
|
|
|
menus:
|
|
# Site header menu
|
|
main:
|
|
- name: Get started
|
|
pageRef: /get-started/
|
|
weight: 1
|
|
- name: Guides
|
|
pageRef: /guides/
|
|
weight: 2
|
|
- name: Manuals
|
|
pageRef: /manuals/
|
|
weight: 3
|
|
- name: Reference
|
|
pageRef: /reference/
|
|
weight: 4
|
|
|
|
# Footer links
|
|
footer:
|
|
- url: https://www.docker.com/products
|
|
name: Product offerings
|
|
- url: https://www.docker.com/products/personal
|
|
name: Docker Personal
|
|
parent: Product offerings
|
|
- url: https://www.docker.com/products/pro
|
|
name: Docker Pro
|
|
parent: Product offerings
|
|
- url: https://www.docker.com/products/team
|
|
name: Docker Team
|
|
parent: Product offerings
|
|
- url: https://www.docker.com/products/business
|
|
name: Docker Business
|
|
parent: Product offerings
|
|
- url: https://www.docker.com/pricing/faq
|
|
name: Pricing FAQs
|
|
parent: Product offerings
|
|
- url: https://www.docker.com/partners/programs
|
|
name: Docker Verified Publisher
|
|
parent: Product offerings
|
|
- url: https://www.docker.com/partners
|
|
name: Partners
|
|
parent: Product offerings
|
|
|
|
- url: https://www.docker.com/
|
|
name: Features
|
|
- url: https://www.docker.com/products/docker-desktop
|
|
name: Docker Desktop
|
|
parent: Features
|
|
- url: https://www.docker.com/products/docker-hub
|
|
name: Docker Hub
|
|
parent: Features
|
|
- url: https://www.docker.com/products/secure-software-supply-chain
|
|
name: Secure Software Supply Chain
|
|
parent: Features
|
|
- url: https://www.docker.com/products/container-runtime
|
|
name: Container Runtime
|
|
parent: Features
|
|
- url: https://www.docker.com/products/developer-tools
|
|
name: Developer Tools
|
|
parent: Features
|
|
- url: https://www.docker.com/partners
|
|
name: Trusted Content
|
|
parent: Features
|
|
- url: https://www.docker.com/roadmap
|
|
name: Docker Product Roadmap
|
|
parent: Features
|
|
|
|
- name: Developers
|
|
- url: https://www.docker.com/use-cases
|
|
name: Use cases
|
|
parent: Developers
|
|
- url: /get-started/
|
|
name: Get started
|
|
parent: Developers
|
|
- url: https://www.docker.com/blog/
|
|
name: Blog
|
|
parent: Developers
|
|
- url: https://www.docker.com/docker-community
|
|
name: Community
|
|
parent: Developers
|
|
- url: https://www.docker.com/open-source
|
|
name: Open Source
|
|
parent: Developers
|
|
- url: https://www.docker.com/community/get-involved/developer-preview
|
|
name: Preview Program
|
|
parent: Developers
|
|
|
|
- url: https://www.docker.com/company
|
|
name: About us
|
|
- url: https://www.docker.com/what-container
|
|
name: What is a container?
|
|
parent: About us
|
|
- url: https://www.docker.com/why-docker
|
|
name: Why Docker?
|
|
parent: About us
|
|
- url: https://www.docker.com/events
|
|
name: Virtual events
|
|
parent: About us
|
|
- url: https://www.docker.com/swag
|
|
name: Swag store
|
|
parent: About us
|
|
- url: https://www.docker.com/company/newsroom
|
|
name: Newsroom
|
|
parent: About us
|
|
- url: https://www.docker.com/careers
|
|
name: Careers
|
|
parent: About us
|
|
- url: https://www.docker.com/company/contact
|
|
name: Contact us
|
|
parent: About us
|
|
- url: https://www.docker.com/customers
|
|
name: Customers
|
|
parent: About us
|
|
- url: https://www.docker.com/newsletter-subscription
|
|
name: Newsletter
|
|
parent: About us
|
|
|
|
# Hugo modules - for fetching docs from upstream repos
|
|
# NOTE: we always vendor upstream docs in _vendor/
|
|
# Versions are declared in go.mod
|
|
module:
|
|
proxy: https://proxy.golang.org,direct
|
|
hugoVersion:
|
|
extended: false
|
|
min: "0.141.0"
|
|
mounts:
|
|
# Mount the assets directory so it doesn't get overwritten
|
|
- source: assets
|
|
target: assets
|
|
# Mount hugo_stats.json to the assets dir to trigger cachebust
|
|
- source: hugo_stats.json
|
|
target: assets/watching/hugo_stats.json
|
|
# Mount the icon files to assets so we can access them with resources.Get
|
|
- source: node_modules/@material-symbols/svg-400/rounded
|
|
target: assets/icons
|
|
|
|
imports:
|
|
|
|
# Docker Engine
|
|
- path: github.com/moby/moby
|
|
mounts:
|
|
- source: docs/api/v1.24.md
|
|
target: content/reference/api/engine/version/v1.24.md
|
|
- source: docs/api/version-history.md
|
|
target: content/reference/api/engine/version-history.md
|
|
- source: docs/api
|
|
target: content/reference/api/engine/version
|
|
includeFiles: "*.yaml"
|
|
|
|
# BuildKit
|
|
- path: github.com/moby/buildkit
|
|
mounts:
|
|
- source: frontend/dockerfile/docs/reference.md
|
|
target: content/reference/dockerfile.md
|
|
- source: frontend/dockerfile/docs/rules
|
|
target: content/reference/build-checks
|
|
includeFiles: "*.md"
|
|
- source: docs/buildkitd.toml.md
|
|
target: content/manuals/build/buildkit/toml-configuration.md
|
|
- source: docs/attestations/slsa-definitions.md
|
|
target: content/manuals/build/metadata/attestations/slsa-definitions.md
|
|
- source: docs/attestations/attestation-storage.md
|
|
target: content/manuals/build/metadata/attestations/attestation-storage.md
|
|
|
|
# Buildx CLI plugin
|
|
- path: github.com/docker/buildx
|
|
mounts:
|
|
- source: docs/bake-reference.md
|
|
target: content/manuals/build/bake/reference.md
|
|
|
|
# Docker CLI
|
|
- path: github.com/docker/cli
|
|
mounts:
|
|
- source: docs/extend
|
|
target: content/manuals/engine/extend
|
|
excludeFiles:
|
|
- "EBS_volume.md"
|
|
- "plugins_metrics.md"
|
|
- "plugins_services.md"
|
|
- source: docs/deprecated.md
|
|
target: content/manuals/engine/deprecated.md
|
|
- source: docs/reference/run.md
|
|
target: content/manuals/engine/containers/run.md
|
|
- source: docs/reference/dockerd.md
|
|
target: content/reference/cli/dockerd.md
|
|
|
|
# Compose
|
|
- path: github.com/docker/compose/v2
|
|
mounts:
|
|
- source: docs/reference
|
|
target: data/compose-cli
|
|
includeFiles: "*.yaml"
|
|
|
|
# Scout CLI plugin (public dist repo)
|
|
- path: github.com/docker/scout-cli
|
|
mounts:
|
|
- source: docs
|
|
target: data/scout-cli
|
|
includeFiles: "*.yaml"
|