site: simplify base templates

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

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
 ---
 
 <!--

content/reference/samples/_index.md

@@ -3,9 +3,6 @@ linkTitle: Samples
 title: Samples overview
 description: Learn how to containerize different types of services by walking through
   Official Docker samples.
-cascade:
-  layout: samples
-  type: samples
 aliases:
 - /en/latest/examples/
 - /engine/examples/

hugo.yaml

@@ -10,6 +10,20 @@ ignoreLogs:
 
 taxonomies: {}
 
+# Cascade layout and type settings to content subtrees.
+# See https://gohugo.io/configuration/cascade/#target
+cascade:
+  # Guide sections use the series layout (metadata card + modules list)
+  - target:
+      path: /guides/**
+      kind: section
+    layout: series
+  # Sample pages use the samples type (routes to layouts/samples/)
+  - target:
+      path: /reference/samples/**
+      kind: page
+    type: samples
+
 # Remove the /manuals prefix for content in the manuals section
 permalinks:
   page:

layouts/_partials/content-default.html

@@ -1,30 +1,23 @@
-<div class="flex w-full gap-8">
-  <article class="prose dark:prose-invert max-w-4xl min-w-0 flex-[2_2_0%]">
-    {{ partial "breadcrumbs.html" . }}
-    <div class="flex items-start justify-between">
-      <h1 data-pagefind-weight="10">{{ .Title | safeHTML }}</h1>
-      <div class="md-dropdown ml-auto hidden lg:block">
-        {{ partial "md-dropdown.html" . }}
-      </div>
-    </div>
-    <div class="block lg:hidden">
-      {{ partialCached "pagemeta.html" . . }}
-      <hr />
-    </div>
-    {{ .Content }}
-    {{- if and (eq .Type "guides") (not .IsSection) (ne .CurrentSection .FirstSection) -}}
-      {{- with .PrevInSection -}}
-        <div class="not-prose col-start-2 my-4">
-          <a
-            href="{{ .Permalink }}"
-            class="cursor-pointer rounded-sm bg-blue-500 px-4 py-2 text-white hover:bg-blue-400 dark:bg-blue-800 dark:hover:bg-blue-700"
-            >{{ .Title }} &raquo;</a
-          >
-        </div>
-      {{- end -}}
-    {{- end -}}
-  </article>
-  <div class="-mt-8 hidden min-w-48 flex-1 lg:block">
-    {{ partial "aside.html" . }}
+{{ partial "breadcrumbs.html" . }}
+<div class="flex items-start justify-between">
+  <h1 data-pagefind-weight="10">{{ .Title | safeHTML }}</h1>
+  <div class="md-dropdown ml-auto hidden lg:block">
+    {{ partial "md-dropdown.html" . }}
   </div>
 </div>
+<div class="block lg:hidden">
+  {{ partialCached "pagemeta.html" . . }}
+  <hr />
+</div>
+{{ .Content }}
+{{- if and (eq .Type "guides") (not .IsSection) (ne .CurrentSection .FirstSection) -}}
+  {{- with .PrevInSection -}}
+    <div class="not-prose col-start-2 my-4">
+      <a
+        href="{{ .Permalink }}"
+        class="cursor-pointer rounded-sm bg-blue-500 px-4 py-2 text-white hover:bg-blue-400 dark:bg-blue-800 dark:hover:bg-blue-700"
+        >{{ .Title }} &raquo;</a
+      >
+    </div>
+  {{- end -}}
+{{- end -}}

layouts/baseof.html

@@ -69,6 +69,20 @@
       >
         {{ partial "pagefind-meta.html" . }}
         {{ block "main" . }}
+          <div class="flex w-full gap-8">
+            <div class="min-w-0 flex-[2_2_0%]">
+              {{ block "article" . }}
+                <article class="prose dark:prose-invert max-w-4xl">
+                  {{ partial "content-default.html" . }}
+                </article>
+              {{ end }}
+            </div>
+            {{ block "right" . }}
+              <div class="-mt-8 hidden min-w-48 flex-1 lg:block">
+                {{ partial "aside.html" . }}
+              </div>
+            {{ end }}
+          </div>
         {{ end }}
       </div>
     </main>

layouts/cli.html

@@ -1,14 +1,14 @@
-{{ define "main" }}
+{{ define "article" }}
   {{ $data := "" }}
   {{ if .Params.datafolder }}
     {{ $data = index (index site.Data .Params.datafolder) .Params.datafile }}
   {{ else }}
     {{ $data = index site.Data .Params.datafile }}
   {{ end }}
+
   {{ .Store.Set "headings" slice }}
   {{ .Store.Set "subheadings" slice }}
-  <div class="flex w-full">
-    <article class="prose min-w-0 flex-[2_2_0%] max-w-4xl dark:prose-invert">
+  <article class="prose min-w-0 max-w-4xl dark:prose-invert">
     {{ partial "breadcrumbs.html" . }}
     <div class="flex items-start justify-between gap-4">
       <h1>{{ .Title }}</h1>
@@ -200,11 +200,11 @@ can be removed entirely in a future release.
       </table>
     {{ end }}
   </article>
+{{ end }}
 
-  <div class="hidden flex-1 min-w-52 lg:block">
-    <aside
-      class="sticky top-16 h-[calc(100vh-64px)] min-w-52 space-y-4 overflow-y-auto py-4 w-full"
-      >
+{{ define "right" }}
+  <div class="hidden min-w-52 flex-1 lg:block">
+    <aside class="sticky top-16 h-[calc(100vh-64px)] min-w-52 space-y-4 overflow-y-auto py-4 w-full">
       <div id="TableOfContents">
         <div class="text-lg pb-2">{{ T "tableOfContents" }}</div>
         <nav class="toc">
@@ -229,5 +229,4 @@ can be removed entirely in a future release.
       </div>
     </aside>
   </div>
-
 {{ end }}

layouts/glossary.html

@@ -1,11 +1,11 @@
-{{ define "main" }}
-  {{ partial "breadcrumbs.html" . }}
+{{ define "article" }}
   <article class="prose max-w-none dark:prose-invert">
+    {{ partial "breadcrumbs.html" . }}
     {{ with .Title }}
     <h1 class="scroll-mt-36">{{ . }}</h1>
     {{ end }}
     {{ with .Content }}
-      {{ .  }}
+      {{ . }}
     {{ end }}
     <table>
       <thead>
@@ -28,7 +28,3 @@
     </table>
   </article>
 {{ end }}
-
-{{ define "right" }}
-  {{ partial "aside.html" . }}
-{{ end }}

layouts/guides/list.html

@@ -1,20 +0,0 @@
-{{ define "main" }}
-<article class="prose min-w-0 max-w-4xl dark:prose-invert">
-  {{ partial "breadcrumbs.html" . }}
-  <h1 data-pagefind-weight="10" class="scroll-mt-36">{{ .Title }}</h1>
-  <div class="block lg:hidden">
-    {{ partialCached "pagemeta.html" . . }}
-    <hr />
-  </div>
-  {{ .Content }}
-  {{ partial "heading.html" (dict "text" "Modules" "level" 2) }}
-  <ol>
-    {{- range .Pages }}
-    <li>
-      <a class="link" href="{{ .Permalink }}">{{ .LinkTitle }}</a>
-      <p>{{ plainify .Description }}</p>
-    </li>
-    {{- end }}
-  </ol>
-</article>
-{{ end }}

layouts/list.html

@@ -1,3 +1,5 @@
-{{ define "main" }}
-  {{ partial "content-default.html" . }}
+{{ define "article" }}
+  <article class="prose dark:prose-invert max-w-4xl">
+    {{ partial "content-default.html" . }}
+  </article>
 {{ end }}

layouts/samples/single.html

@@ -1,6 +1,6 @@
-{{ define "main" }}
-  {{ partial "breadcrumbs.html" . }}
+{{ define "article" }}
   <article class="prose dark:prose-invert max-w-none">
+    {{ partial "breadcrumbs.html" . }}
     {{ with .Title }}
       <h1>{{ . }}</h1>
     {{ end }}
@@ -46,7 +46,3 @@
     </ul>
   </article>
 {{ end }}
-
-{{ define "right" }}
-  {{ partial "aside.html" . }}
-{{ end }}

layouts/scout-cli.html

@@ -1,287 +0,0 @@
-{{ define "main" }}
-  {{ $data := "" }}
-  {{ if .Params.datafolder }}
-    {{ $data = index (index site.Data .Params.datafolder) .Params.datafile }}
-  {{ else }}
-    {{ $data = index site.Data .Params.datafile }}
-  {{ end }}
-  
-  {{ $markdownFile := "" }}
-  {{ if .Params.markdownfile }}
-    {{ $markdownFile = .Params.markdownfile }}
-  {{ end }}
-  
-  {{/* Check if we should use markdown content early */}}
-  {{ $useMarkdownContent := false }}
-  {{ $markdownContent := "" }}
-  {{ if $markdownFile }}
-    {{ $markdownPath := printf "_vendor/github.com/docker/scout-cli/docs/%s" $markdownFile }}
-    {{ $fullMarkdownContent := readFile $markdownPath }}
-    {{ if $fullMarkdownContent }}
-      {{ $parts := split $fullMarkdownContent "<!---MARKER_GEN_END-->" }}
-      {{ 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 }}
-  <div class="flex w-full">
-    <article class="prose min-w-0 flex-[2_2_0%] max-w-4xl dark:prose-invert">
-    {{ partial "breadcrumbs.html" . }}
-    <h1>{{ .Title }}</h1>
-    <div class="overflow-x-auto">
-      <table>
-        <tbody>
-          {{ with $data.short }}
-          <tr>
-            <th class="text-left w-32">Description</th>
-            <td>{{ . }}</td>
-          </tr>
-          {{ end }}
-          {{ with $data.usage }}
-          <tr>
-            <th class="text-left w-32">Usage</th>
-            <td><code>{{ . }}</code></td>
-          </tr>
-          {{ end }}
-          {{ with $data.aliases }}
-          {{ $aliases := strings.Replace . (fmt.Printf "%s, " page.Title) "" }}
-          <tr>
-            <th class="text-left w-32 flex items-center gap-2">
-              <span>Aliases</span>
-              {{ partialCached "tooltip.html" "An alias is a short or memorable alternative for a longer command." "cli-alias" }}
-            </th>
-            <td>
-              <div class="flex gap-3">
-              {{ range (strings.Split $aliases ", ") }}
-                <code>{{ . }}</code>
-              {{ end }}
-              </div>
-            </td>
-          </tr>
-          {{ end }}
-        </tbody>
-      </table>
-    </div>
-    {{ .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 }}
-      <p>
-        {{ partialCached "components/badge.html" (dict "color" "blue" "content" "Kubernetes") "k8s" }}
-        This command works with the Kubernetes orchestrator.
-      </p>
-    {{ end }}
-    {{ with $data.swarm }}
-      <p>
-        {{ partialCached "components/badge.html" (dict "color" "blue" "content" "Swarm") "swarm" }}
-        This command works with the Swarm orchestrator.
-      </p>
-    {{ 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 }}
-        <div class="overflow-x-auto">
-          <table>
-            <thead class="bg-gray-100 dark:bg-gray-800">
-              <tr>
-                <th class="p-2">Option</th>
-                <th class="p-2">Default</th>
-                <th class="p-2">Description</th>
-              </tr>
-            </thead>
-            <tbody>
-              {{ range . }}
-                <tr class="p-2">
-                  {{ $short := .shorthand }}
-                  {{ $long := .option }}
-                  <td>
-                    {{ with .details_url }}
-                    <a class="link" href="{{ . }}">
-                      <code>{{ with $short }}-{{ . }}, {{end}}--{{ $long }}</code>
-                    </a>
-                    {{ else }}
-                    <code>{{ with $short }}-{{ . }}, {{end}}--{{ $long }}</code>
-                    {{ end }}
-                  </td>
-                  {{ $skipDefault := `[],map[],false,0,0s,default,'',""` }}
-                  <td>
-                    {{ with .default_value }}
-                      {{ cond (in $skipDefault .) "" (printf "<code>%s</code>" . | safeHTML) }}
-                    {{ end }}
-                  </td>
-                  <td>
-                    {{ 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" "<br>") }}
-                    {{ end }}
-                  </td>
-                </tr>
-              {{ end }}
-            </tbody>
-          </table>
-        </div>
-      {{ 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 }}
-      <table>
-        <thead>
-          <tr>
-            <th class="text-left">Command</th>
-            <th class="text-left">Description</th>
-          </tr>
-        </thead>
-        <tbody>
-          {{ range .Pages }}
-            {{- if and .Params.datafolder .Params.datafile }}
-              <tr>
-                <td class="text-left"><a class="link" href="{{ .Permalink }}"><code>{{ .Title }}</code></a></th>
-                {{ $data := index (index site.Data .Params.datafolder) .Params.datafile }}
-                <td class="text-left">{{ $data.short }}</th>
-              </tr>
-            {{- end }}
-          {{ end }}
-        </tbody>
-      </table>
-    {{ end }}
-  </article>
-
-  <div class="hidden flex-1 min-w-52 lg:block">
-    <aside
-      class="sticky top-16 h-[calc(100vh-64px)] min-w-52 space-y-4 overflow-y-auto py-4 w-full"
-      >
-      <div id="TableOfContents">
-        <div class="text-lg pb-2">{{ T "tableOfContents" }}</div>
-        <nav class="toc">
-          <ul>
-            {{ range (.Store.Get "headings") }}
-              {{/* add left padding depending on level (pl-2, pl-3, pl-4) */}}
-              {{ $slice := strings.Split .text "{#" }}
-              {{ $text := index $slice 0 }}
-              {{ $anchor := index $slice 1 | strings.TrimRight "}" }}
-              <li{{ with .level }} class="pl-{{ . }}"{{ end }}>
-                <a
-                  {{ if $anchor }}
-                    href="#{{ $anchor }}"
-                  {{ else }}
-                    href="#{{ $text | anchorize }}"
-                  {{ end }}
-                  >{{ markdownify $text }}</a>
-              </li>
-            {{ end }}
-          </ul>
-        </nav>
-      </div>
-    </aside>
-  </div>
-
-{{ end }}

layouts/series.html

@@ -1,7 +1,11 @@
-{{ define "main" }}
-{{ partial "breadcrumbs.html" . }}
+{{ define "article" }}
 <article class="prose max-w-none dark:prose-invert">
+  {{ partial "breadcrumbs.html" . }}
   <h1 data-pagefind-weight="10" class="scroll-mt-36">{{ .Title }}</h1>
+  <div class="block lg:hidden">
+    {{ partialCached "pagemeta.html" . . }}
+    <hr />
+  </div>
   <div class="text-lg">{{ .Summary }}</div>
   {{- if or .Params.proficiencyLevel .Params.time .Params.prerequisites }}
   <div class="not-prose">
@@ -39,3 +43,5 @@
   </ol>
 </article>
 {{ end }}
+
+{{ define "right" }}{{ end }}

layouts/single.html

@@ -1,3 +1,5 @@
-{{ define "main" }}
-  {{ partial "content-default.html" . }}
+{{ define "article" }}
+  <article class="prose dark:prose-invert max-w-4xl">
+    {{ partial "content-default.html" . }}
+  </article>
 {{ end }}

layouts/wide.html

@@ -1,11 +1 @@
-{{ define "main" }}
-  <article class="prose dark:prose-invert max-w-4xl min-w-0 flex-[2_2_0%]">
-    {{ partial "breadcrumbs.html" . }}
-    <h1 data-pagefind-weight="10">{{ .Title }}</h1>
-    <div class="block lg:hidden">
-      {{ partialCached "pagemeta.html" . . }}
-      <hr />
-    </div>
-    {{ .Content }}
-  </article>
-{{ end }}
+{{ define "right" }}{{ end }}