From d5fd0b2f11a0bf8928429e64f5268eb0387de0b3 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Sat, 21 Feb 2026 12:48:41 +0100 Subject: [PATCH] site: simplify base templates Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- content/reference/cli/docker/scout/watch.md | 3 +- content/reference/samples/_index.md | 3 - hugo.yaml | 14 + layouts/_partials/content-default.html | 49 ++-- layouts/baseof.html | 14 + layouts/cli.html | 15 +- layouts/glossary.html | 10 +- layouts/guides/list.html | 20 -- layouts/list.html | 6 +- layouts/samples/single.html | 8 +- layouts/scout-cli.html | 287 -------------------- layouts/series.html | 10 +- layouts/single.html | 6 +- layouts/wide.html | 12 +- 14 files changed, 79 insertions(+), 378 deletions(-) delete mode 100644 layouts/guides/list.html delete mode 100644 layouts/scout-cli.html diff --git a/content/reference/cli/docker/scout/watch.md b/content/reference/cli/docker/scout/watch.md index c9e1506f70..ec817aaaa3 100644 --- a/content/reference/cli/docker/scout/watch.md +++ b/content/reference/cli/docker/scout/watch.md @@ -1,11 +1,10 @@ --- datafolder: scout-cli datafile: docker_scout_watch -markdownfile: scout_watch.md aliases: - /engine/reference/commandline/scout_watch title: docker scout watch -layout: scout-cli +layout: cli --- " }} - {{ if gt (len $parts) 1 }} - {{ $contentAfterMarker := index $parts 1 }} - {{ $contentAfterMarker = strings.TrimLeft "\n" $contentAfterMarker }} - {{ if gt (len (strings.TrimSpace $contentAfterMarker)) 0 }} - {{ $useMarkdownContent = true }} - {{/* Skip markdown description section if it exists, use only content after it */}} - {{ if strings.Contains $contentAfterMarker "## Examples" }} - {{/* If there's an Examples section, split on it and use everything from Examples onward */}} - {{ $examplesParts := split $contentAfterMarker "## Examples" }} - {{ if gt (len $examplesParts) 1 }} - {{ $markdownContent = printf "## Examples%s" (index $examplesParts 1) }} - {{ else }} - {{ $markdownContent = $contentAfterMarker }} - {{ end }} - {{ else }} - {{/* No Examples section, use all content but skip Description if present */}} - {{ if strings.HasPrefix (strings.TrimSpace $contentAfterMarker) "## Description" }} - {{/* Very simple approach: just use empty content if it starts with Description */}} - {{ $markdownContent = "" }} - {{ else }} - {{ $markdownContent = $contentAfterMarker }} - {{ end }} - {{ end }} - {{ end }} - {{ end }} - {{ end }} - {{ end }} - - {{ .Store.Set "headings" slice }} - {{ .Store.Set "subheadings" slice }} -
-
- {{ partial "breadcrumbs.html" . }} -

{{ .Title }}

-
- - - {{ with $data.short }} - - - - - {{ end }} - {{ with $data.usage }} - - - - - {{ end }} - {{ with $data.aliases }} - {{ $aliases := strings.Replace . (fmt.Printf "%s, " page.Title) "" }} - - - - - {{ end }} - -
Description{{ . }}
Usage{{ . }}
- Aliases - {{ partialCached "tooltip.html" "An alias is a short or memorable alternative for a longer command." "cli-alias" }} - -
- {{ range (strings.Split $aliases ", ") }} - {{ . }} - {{ end }} -
-
-
- {{ .Content }} - {{ if $data.deprecated }} - {{ markdownify ` -> [!WARNING] -> This command is deprecated -> -> It may be removed in a future Docker version. For more information, see the -> [Docker roadmap](https://github.com/docker/roadmap/issues/209)` - }} - {{ end }} - {{ if or $data.experimental $data.experimentalcli }} - {{ markdownify ` -{{% experimental %}} - -**This command is experimental.** - -Experimental features are intended for testing and feedback as their -functionality or design may change between releases without warning or -can be removed entirely in a future release. - -{{% /experimental %}}` - }} - {{ end }} - {{ with $data.kubernetes }} -

- {{ partialCached "components/badge.html" (dict "color" "blue" "content" "Kubernetes") "k8s" }} - This command works with the Kubernetes orchestrator. -

- {{ end }} - {{ with $data.swarm }} -

- {{ partialCached "components/badge.html" (dict "color" "blue" "content" "Swarm") "swarm" }} - This command works with the Swarm orchestrator. -

- {{ end }} - - {{/* Always show YAML long description */}} - {{ with $data.long }} - {{ $heading := dict "level" 2 "text" "Description" }} - {{ partialCached "heading.html" $heading "cli-description" }} - {{ $subHeadings := (strings.FindRE `(?m:#{3,4} .*)` .) }} - {{ $.Store.Add "headings" $heading }} - {{ range $subHeadings }} - {{ $lvl := strings.Count "#" . }} - {{ $txt := strings.TrimLeft "# " . }} - {{ $.Store.Add "headings" (dict "level" $lvl "text" $txt) }} - {{ end }} - {{ . | $.RenderString (dict "display" "block") }} - {{ end }} - - {{ with $data.options }} - {{ $opts := where . "hidden" false }} - {{ with $opts }} - {{ $heading := dict "level" 2 "text" "Options" }} - {{ partialCached "heading.html" $heading "cli-options" }} - {{ $.Store.Add "headings" $heading }} -
- - - - - - - - - - {{ range . }} - - {{ $short := .shorthand }} - {{ $long := .option }} - - {{ $skipDefault := `[],map[],false,0,0s,default,'',""` }} - - - - {{ end }} - -
OptionDefaultDescription
- {{ with .details_url }} - - {{ with $short }}-{{ . }}, {{end}}--{{ $long }} - - {{ else }} - {{ with $short }}-{{ . }}, {{end}}--{{ $long }} - {{ end }} - - {{ with .default_value }} - {{ cond (in $skipDefault .) "" (printf "%s" . | safeHTML) }} - {{ end }} - - {{ with .min_api_version }} - {{ partialCached "components/badge.html" (dict "color" "blue" "content" (printf "API %s+" .)) "api" . }} - {{ end }} - {{ with .deprecated }} - {{ partialCached "components/badge.html" (dict "color" "red" "content" "Deprecated") "deprecated" }} - {{ end }} - {{ with .experimental }} - {{ partialCached "components/badge.html" (dict "color" "amber" "content" "experimental (daemon)") "exp" }} - {{ end }} - {{ with .experimentalcli }} - {{ partialCached "components/badge.html" (dict "color" "amber" "content" "experimental (CLI)") "exp-cli" }} - {{ end }} - {{ with .kubernetes }} - {{ partialCached "components/badge.html" (dict "color" "blue" "content" "Kubernetes") "k8s" }} - {{ end }} - {{ with .swarm }} - {{ partialCached "components/badge.html" (dict "color" "blue" "content" "Swarm") "swarm" }} - {{ end }} - {{ if .description }} - {{/* replace newlines in long desc with break tags */}} - {{ markdownify (strings.Replace .description "\n" "
") }} - {{ end }} -
-
- {{ end }} - {{ end }} - - {{ if $useMarkdownContent }} - {{/* Use markdown content after MARKER_GEN_END */}} - {{ $subHeadings := (strings.FindRE `(?m:#{2,4} .*)` $markdownContent) }} - {{ range $subHeadings }} - {{ $lvl := strings.Count "#" . }} - {{ $txt := strings.TrimLeft "# " . }} - {{ $.Store.Add "headings" (dict "level" $lvl "text" $txt) }} - {{ end }} - {{ $markdownContent | $.RenderString (dict "display" "block") }} - {{ else }} - {{/* Fallback to YAML examples if no markdown content after marker */}} - {{ with $data.examples }} - {{ $heading := dict "level" 2 "text" "Examples" }} - {{ partialCached "heading.html" $heading "cli-examples" }} - {{ $subHeadings := (strings.FindRE `(?m:#{3,4} .*)` .) }} - {{ $.Store.Add "headings" $heading }} - {{ range $subHeadings }} - {{ $lvl := strings.Count "#" . }} - {{ $txt := strings.TrimLeft "# " . }} - {{ $.Store.Add "headings" (dict "level" $lvl "text" $txt) }} - {{ end }} - {{ $.RenderString (dict "display" "block") . }} - {{ end }} - {{ end }} - - {{ if eq .Kind "section" }} - {{ $heading := dict "level" 2 "text" "Subcommands" }} - {{ partialCached "heading.html" $heading "cli-subcommands" }} - {{ $.Store.Add "headings" $heading }} - - - - - - - - - {{ range .Pages }} - {{- if and .Params.datafolder .Params.datafile }} - - - {{- end }} - {{ end }} - -
CommandDescription
{{ .Title }} - {{ $data := index (index site.Data .Params.datafolder) .Params.datafile }} - {{ $data.short }} -
- {{ end }} -
- - - -{{ end }} \ No newline at end of file diff --git a/layouts/series.html b/layouts/series.html index 40bfea0b73..dc40a84774 100644 --- a/layouts/series.html +++ b/layouts/series.html @@ -1,7 +1,11 @@ -{{ define "main" }} -{{ partial "breadcrumbs.html" . }} +{{ define "article" }}
+ {{ partial "breadcrumbs.html" . }}

{{ .Title }}

+
+ {{ partialCached "pagemeta.html" . . }} +
+
{{ .Summary }}
{{- if or .Params.proficiencyLevel .Params.time .Params.prerequisites }}
@@ -39,3 +43,5 @@
{{ end }} + +{{ define "right" }}{{ end }} diff --git a/layouts/single.html b/layouts/single.html index 934a6c2135..834974e186 100644 --- a/layouts/single.html +++ b/layouts/single.html @@ -1,3 +1,5 @@ -{{ define "main" }} - {{ partial "content-default.html" . }} +{{ define "article" }} +
+ {{ partial "content-default.html" . }} +
{{ end }} diff --git a/layouts/wide.html b/layouts/wide.html index f43c75581c..d31aab7193 100644 --- a/layouts/wide.html +++ b/layouts/wide.html @@ -1,11 +1 @@ -{{ define "main" }} -
- {{ partial "breadcrumbs.html" . }} -

{{ .Title }}

-
- {{ partialCached "pagemeta.html" . . }} -
-
- {{ .Content }} -
-{{ end }} +{{ define "right" }}{{ end }}