hugo: display command aliases

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson 2024-01-05 15:53:10 +01:00
parent 04de43a394
commit f0260dbf20
9 changed files with 29 additions and 2 deletions

View File

@ -1,6 +1,7 @@
--- ---
datafolder: engine-cli datafolder: engine-cli
datafile: docker_container_exec datafile: docker_container_exec
linkTitle: docker exec
title: docker container exec title: docker container exec
aliases: aliases:
- /edge/engine/reference/commandline/container_exec/ - /edge/engine/reference/commandline/container_exec/

View File

@ -1,6 +1,7 @@
--- ---
datafolder: engine-cli datafolder: engine-cli
datafile: docker_container_ls datafile: docker_container_ls
linkTitle: docker ps
title: docker container ls title: docker container ls
aliases: aliases:
- /edge/engine/reference/commandline/container_ls/ - /edge/engine/reference/commandline/container_ls/

View File

@ -1,6 +1,7 @@
--- ---
datafolder: engine-cli datafolder: engine-cli
datafile: docker_container_run datafile: docker_container_run
linkTitle: docker run
title: docker container run title: docker container run
aliases: aliases:
- /edge/engine/reference/commandline/container_rm/ - /edge/engine/reference/commandline/container_rm/

View File

@ -1,6 +1,7 @@
--- ---
datafolder: engine-cli datafolder: engine-cli
datafile: docker_image_build datafile: docker_image_build
linkTitle: docker build
title: docker image build title: docker image build
aliases: aliases:
- /edge/engine/reference/commandline/image_build/ - /edge/engine/reference/commandline/image_build/

View File

@ -1,6 +1,7 @@
--- ---
datafolder: engine-cli datafolder: engine-cli
datafile: docker_image_ls datafile: docker_image_ls
linkTitle: docker images
title: docker image ls title: docker image ls
aliases: aliases:
- /edge/engine/reference/commandline/image_ls/ - /edge/engine/reference/commandline/image_ls/

View File

@ -1,6 +1,7 @@
--- ---
datafolder: engine-cli datafolder: engine-cli
datafile: docker_image_pull datafile: docker_image_pull
linkTitle: docker pull
title: docker image pull title: docker image pull
aliases: aliases:
- /edge/engine/reference/commandline/image_pull/ - /edge/engine/reference/commandline/image_pull/

View File

@ -1,6 +1,7 @@
--- ---
datafolder: engine-cli datafolder: engine-cli
datafile: docker_image_push datafile: docker_image_push
linkTitle: docker push
title: docker image push title: docker image push
aliases: aliases:
- /edge/engine/reference/commandline/image_push/ - /edge/engine/reference/commandline/image_push/

View File

@ -1,6 +1,7 @@
--- ---
datafolder: engine-cli datafolder: engine-cli
datafile: docker_system_info datafile: docker_system_info
linkTitle: docker info
title: docker system info title: docker system info
aliases: aliases:
- /edge/engine/reference/commandline/system_info/ - /edge/engine/reference/commandline/system_info/

View File

@ -13,8 +13,16 @@
{{ .Scratch.Set "subheadings" slice }} {{ .Scratch.Set "subheadings" slice }}
{{ partial "breadcrumbs.html" . }} {{ partial "breadcrumbs.html" . }}
<article class="DocSearch-content prose max-w-none dark:prose-invert"> <article class="DocSearch-content prose max-w-none dark:prose-invert">
{{ with .Title }} {{ if ne .LinkTitle .Title }}
<h1 class="scroll-mt-36">{{ . }}</h1> {{/*
we use linkTitle for surfacing popular aliases like "docker run"
if linkTitle is set, use both alias and canonical cmd as title
*/}}
<h1 class="scroll-mt-36">{{ .LinkTitle }}<span
class="text-gray-light dark:text-gray-dark"> ({{ .Title }})</span>
</h1>
{{ else }}
<h1 class="scroll-mt-36">{{ .Title }}</h1>
{{ end }} {{ end }}
{{ $data.short | .RenderString (dict "display" "block") }} {{ $data.short | .RenderString (dict "display" "block") }}
{{ if $data.deprecated }} {{ if $data.deprecated }}
@ -57,6 +65,17 @@
{{ $.Scratch.Add "headings" $heading }} {{ $.Scratch.Add "headings" $heading }}
{{ highlight (strings.Replace . "\t" "") "console" }} {{ highlight (strings.Replace . "\t" "") "console" }}
{{ end }} {{ end }}
{{ with $data.aliases }}
{{ $heading := dict "level" 2 "text" "Aliases" }}
{{ partial "heading.html" $heading }}
{{ $aliases := strings.Split . ", " }}
<p>The following commands are equivalent and redirect here:</p>
<ul>
{{ range $aliases }}
<li><code>{{ . }}</code></li>
{{ end }}
</ul>
{{ end }}
{{ with $data.long }} {{ with $data.long }}
{{ $heading := dict "level" 2 "text" "Description" }} {{ $heading := dict "level" 2 "text" "Description" }}
{{ partial "heading.html" $heading }} {{ partial "heading.html" $heading }}