docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

hugo: create a common api layout 

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson 2024-09-11 12:44:15 +02:00
parent e3a66f58ae
commit c17d0e8553
31 changed files with 89 additions and 119 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
content/reference/api/engine/version/_index.md
View File

@ -4,4 +4,7 @@ build:
render: never render: never
sidebar: sidebar:
reverse: true reverse: true
cascade:
description: Reference documentation and Swagger (OpenAPI) specification for the Docker Engine API.
layout: api
--- ---

4
content/reference/api/engine/version/v1.25.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.25 title: Docker Engine API v1.25 reference
layout: engine-api linkTitle: v1.25
aliases: aliases:
- /engine/api/v1.25/ - /engine/api/v1.25/
--- ---

4
content/reference/api/engine/version/v1.26.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.26 linkTitle: v1.26
layout: engine-api title: Docker Engine API v1.26 reference
aliases: aliases:
- /engine/api/v1.26/ - /engine/api/v1.26/
--- ---

4
content/reference/api/engine/version/v1.27.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.27 linkTitle: v1.27
layout: engine-api title: Docker Engine API v1.27 reference
aliases: aliases:
- /engine/api/v1.27/ - /engine/api/v1.27/
--- ---

4
content/reference/api/engine/version/v1.28.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.28 linkTitle: v1.28
layout: engine-api title: Docker Engine API v1.28 reference
aliases: aliases:
- /engine/api/v1.28/ - /engine/api/v1.28/
--- ---

4
content/reference/api/engine/version/v1.29.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.29 linkTitle: v1.29
layout: engine-api title: Docker Engine API v1.29 reference
aliases: aliases:
- /engine/api/v1.29/ - /engine/api/v1.29/
--- ---

4
content/reference/api/engine/version/v1.30.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.30 linkTitle: v1.30
layout: engine-api title: Docker Engine API v1.30 reference
aliases: aliases:
- /engine/api/v1.30/ - /engine/api/v1.30/
--- ---

4
content/reference/api/engine/version/v1.31.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.31 linkTitle: v1.31
layout: engine-api title: Docker Engine API v1.31 reference
aliases: aliases:
- /engine/api/v1.31/ - /engine/api/v1.31/
--- ---

4
content/reference/api/engine/version/v1.32.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.32 linkTitle: v1.32
layout: engine-api title: Docker Engine API v1.32 reference
aliases: aliases:
- /engine/api/v1.32/ - /engine/api/v1.32/
--- ---

4
content/reference/api/engine/version/v1.33.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.33 linkTitle: v1.33
layout: engine-api title: Docker Engine API v1.33 reference
aliases: aliases:
- /engine/api/v1.33/ - /engine/api/v1.33/
--- ---

4
content/reference/api/engine/version/v1.34.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.34 linkTitle: v1.34
layout: engine-api title: Docker Engine API v1.34 reference
aliases: aliases:
- /engine/api/v1.34/ - /engine/api/v1.34/
--- ---

4
content/reference/api/engine/version/v1.35.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.35 linkTitle: v1.35
layout: engine-api title: Docker Engine API v1.35 reference
aliases: aliases:
- /engine/api/v1.35/ - /engine/api/v1.35/
--- ---

4
content/reference/api/engine/version/v1.36.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.36 linkTitle: v1.36
layout: engine-api title: Docker Engine API v1.36 reference
aliases: aliases:
- /engine/api/v1.36/ - /engine/api/v1.36/
--- ---

4
content/reference/api/engine/version/v1.37.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.37 linkTitle: v1.37
layout: engine-api title: Docker Engine API v1.37 reference
aliases: aliases:
- /engine/api/v1.37/ - /engine/api/v1.37/
--- ---

4
content/reference/api/engine/version/v1.38.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.38 linkTitle: v1.38
layout: engine-api title: Docker Engine API v1.38 reference
aliases: aliases:
- /engine/api/v1.38/ - /engine/api/v1.38/
--- ---

4
content/reference/api/engine/version/v1.39.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.39 linkTitle: v1.39
layout: engine-api title: Docker Engine API v1.39 reference
aliases: aliases:
- /engine/api/v1.39/ - /engine/api/v1.39/
--- ---

4
content/reference/api/engine/version/v1.40.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.40 linkTitle: v1.40
layout: engine-api title: Docker Engine API v1.40 reference
aliases: aliases:
- /engine/api/v1.40/ - /engine/api/v1.40/
--- ---

4
content/reference/api/engine/version/v1.41.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.41 linkTitle: v1.41
layout: engine-api title: Docker Engine API v1.41 reference
aliases: aliases:
- /engine/api/v1.41/ - /engine/api/v1.41/
--- ---

4
content/reference/api/engine/version/v1.42.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.42 linkTitle: v1.42
layout: engine-api title: Docker Engine API v1.42 reference
aliases: aliases:
- /engine/api/v1.42/ - /engine/api/v1.42/
--- ---

4
content/reference/api/engine/version/v1.43.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.43 linkTitle: v1.43
layout: engine-api title: Docker Engine API v1.43 reference
aliases: aliases:
- /engine/api/v1.43/ - /engine/api/v1.43/
--- ---

4
content/reference/api/engine/version/v1.44.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.44 linkTitle: v1.44
layout: engine-api title: Docker Engine API v1.44 reference
aliases: aliases:
- /engine/api/v1.44/ - /engine/api/v1.44/
--- ---

4
content/reference/api/engine/version/v1.45.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.45 linkTitle: v1.45
layout: engine-api title: Docker Engine API v1.45 reference
aliases: aliases:
- /engine/api/v1.45/ - /engine/api/v1.45/
--- ---

4
content/reference/api/engine/version/v1.46.md
View File

@ -1,6 +1,6 @@
--- ---
title: v1.46 linkTitle: v1.46
layout: engine-api title: Docker Engine API v1.46 reference
aliases: aliases:
- /engine/api/v1.46/ - /engine/api/v1.46/
--- ---

4
content/reference/api/engine/version/v1.47.md
View File

@ -1,4 +1,4 @@
--- ---
title: v1.47 linkTitle: v1.47
layout: engine-api title: Docker Engine API v1.47 reference
--- ---

6
content/reference/api/hub/dvp.md
View File

@ -1,4 +1,6 @@
--- ---
layout: hub-api layout: api
title: Docker Verified Publisher API description: Reference documentation and Swagger (OpenAPI) specification for the Docker Verified Publisher API.
linkTitle: DVP Data API
title: Docker Verified Publisher API reference
--- ---

6
content/reference/api/hub/latest.md
View File

@ -1,4 +1,6 @@
--- ---
layout: hub-api layout: api
title: Docker Hub API description: Reference documentation and Swagger (OpenAPI) specification for the Docker Hub API.
title: Docker Hub API reference
linkTitle: Docker Hub API
--- ---

2
hugo.yaml
View File

@ -262,7 +262,7 @@ module:
- source: docs/api/version-history.md - source: docs/api/version-history.md
target: content/reference/api/engine/version-history.md target: content/reference/api/engine/version-history.md
- source: docs/api - source: docs/api
target: static/reference/api/engine target: content/reference/api/engine/version
includeFiles: "*.yaml" includeFiles: "*.yaml"
- path: github.com/moby/buildkit - path: github.com/moby/buildkit

1
hugo_stats.json
View File

@ -317,7 +317,6 @@
"hover:text-black", "hover:text-black",
"hover:text-blue-light", "hover:text-blue-light",
"hover:underline", "hover:underline",
"hub-api",
"icon-lg", "icon-lg",
"icon-sm", "icon-sm",
"icon-svg", "icon-svg",

31
layouts/_default/api-baseof.html Normal file
View File

@ -0,0 +1,31 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>{{ .Title }}</title>
<!-- needed for adaptive design -->
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="description" content="{{ .Description }}" />
<meta charset="utf-8" />
<!-- favicon -->
{{- partialCached "favicon.html" "favicon" }}
<style>
body {
margin: 0;
padding: 0;
}
.menu-content>div:first-child {
background-color: #086dd7;
padding: 16px;
}
</style>
</head>
<body>
{{ $specURL := urls.Parse (printf "/%s%s.yaml" .File.Dir .File.ContentBaseName) }}
<redoc spec-url="{{ $specURL.String }}" hide-hostname="true" suppress-warnings="true" lazy-rendering></redoc>
<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
</body>
</html>

34
layouts/_default/engine-api-baseof.html
View File

@ -1,34 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Docker Engine API {{ .File.BaseFileName }} Reference</title>
<!-- needed for adaptive design -->
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="description"
content="Reference documentation and Swagger (OpenAPI) specification for the {{ .File.BaseFileName }} version of the API served by Docker Engine." />
<meta charset="utf-8" />
<!-- favicon -->
{{ partialCached "favicon.html" "favicon" }}
<!-- make the latest API version the canonical page as that's what we want users to be using mostly -->
<link rel="canonical" href="{{ site.BaseURL }}/reference/api/engine/version/v{{ site.Params.latest_engine_api_version }}/" />
<style>
body {
margin: 0;
padding: 0;
}
.menu-content>div:first-child {
background-color: #086dd7;
padding: 16px;
}
</style>
</head>
<body>
<redoc spec-url="/reference/api/engine/{{ .File.BaseFileName }}.yaml" hide-hostname="true" suppress-warnings="true"
lazy-rendering></redoc>
<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
</body>
</html>

33
layouts/_default/hub-api-baseof.html
View File

@ -1,33 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Docker Hub API Reference {{ .File.BaseFileName }}</title>
<!-- needed for adaptive design -->
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="description"
content="Reference documentation and Swagger (OpenAPI) specification for the {{ .File.BaseFileName }} API served by Docker Hub." />
<meta charset="utf-8" />
<!-- favicon -->
{{ partialCached "favicon.html" "favicon" }}
<!-- make the latest API version the canonical page as that's what we want users to be using mostly -->
<link rel="canonical" href="{{ "/reference/api/hub/latest/" | relURL }}" />
<style>
body {
margin: 0;
padding: 0;
}
.menu-content>div:first-child {
background-color: #086dd7;
padding: 16px;
}
</style>
</head>
<body>
<redoc spec-url="/reference/api/hub/{{ .File.BaseFileName }}.yaml" class="hub-api"></redoc>
<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
</body>
</html>