hugo-book
Code Issues

Review and update whitespaces in shortcodes to improve shortcode nesting

Browse Source
This commit is contained in:
Alex Shpak
2025-09-26 15:48:57 +02:00
parent 48157b18c7
commit 5ffdf5bfaf
18 changed files with 89 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files
layouts/_markup/render-heading.html
+1 -1
View File
@@ -1,6 +1,6 @@
<h{{ .Level }} id="{{ .Anchor }}" {{- with .Attributes.class -}}class="{{ . }}"{{- end -}}>
{{- .Text -}}
{{- if default true .Attributes.anchor }}
{{- if default true .Attributes.anchor -}}
<a class="anchor" href="#{{ .Anchor }}">#</a>
{{- end -}}
</h{{ .Level }}>
layouts/_partials/docs/links/portable-link.html
+1 -1
View File
@@ -16,7 +16,7 @@
{{- else with (resources.Get $path) -}}
{{- $destination = .RelPermalink -}}
{{- else -}}
{{- warnf "Reference '%s' not found in '%s'" .Destination .Page.Permalink -}}
{{- warnf "Reference '%s' not found in '%s'" .Destination .Page.RelPermalink -}}
{{- end -}}
{{- with $url.RawQuery -}}
layouts/_partials/docs/menu-hugo.html
+7 -7
View File
@@ -19,16 +19,16 @@
<li>
{{- $isRemote := (urls.Parse .URL).IsAbs -}}
<a href="{{ .URL }}"
{{- with $class }}class="{{ delimit . " " }}"{{ end -}}
{{- with .Title }}title="{{ . }}"{{ end -}}
{{- if $isRemote }}target="_blank" rel="noopener"{{ end -}}>
{{- with $class }} class="{{ delimit . " " }}"{{- end -}}
{{- with .Title }} title="{{ . }}"{{- end -}}
{{- if $isRemote }} target="_blank" rel="noopener"{{- end -}}>
{{- .Pre -}}
{{ template "book-menu-title" . }}
{{- template "book-menu-title" . -}}
{{- .Post -}}
</a>
{{- with .Children }}
{{ template "book-menu-hugo" (dict "Page" $.Page "Menu" .) }}
{{- end }}
{{- with .Children -}}
{{- template "book-menu-hugo" (dict "Page" $.Page "Menu" .) -}}
{{- end -}}
</li>
{{- end -}}
</ul>
layouts/_shortcodes/asciinema.html
+12 -10
View File
@@ -1,15 +1,17 @@
{{- if not (.Page.Store.Get "asciinema") -}}
<!-- Include asciinema player only first time -->
<link rel="stylesheet" href="{{ "asciinema/asciinema-player.css" | relURL }}" />
<script defer src="{{ "asciinema/asciinema-player.min.js" | relURL }}"></script>
<script defer src="{{ "asciinema/asciinema-auto.js" | relURL }}"></script>
{{- .Page.Store.Set "asciinema" true -}}
<!-- Include asciinema player only first time -->
{{- /* remove whitespaces */ -}}
<link rel="stylesheet" href="{{ "asciinema/asciinema-player.css" | relURL }}" />
{{- /* remove whitespaces */ -}}
<script defer src="{{ "asciinema/asciinema-player.min.js" | relURL }}"></script>
{{- /* remove whitespaces */ -}}
<script defer src="{{ "asciinema/asciinema-auto.js" | relURL }}"></script>
{{- .Page.Store.Set "asciinema" true -}}
{{- end -}}
{{- with (partial "docs/links/portable-image" (dict "Page" .Page "Destination" (index .Params "cast"))) -}}
{{- $opts := newScratch -}}
{{- $opts.Set "asciinema" $.Params -}}
{{- $opts.DeleteInMap "asciinema" "cast" -}}
<div class="asciinema" id="asciinema-{{ $.Ordinal }}" x-data-cast="{{ . | safeHTMLAttr }}" x-data-opts="{{ $opts.Get "asciinema" | jsonify | safeHTMLAttr }}"></div>
{{- $opts := newScratch -}}
{{- $opts.Set "asciinema" $.Params -}}
{{- $opts.DeleteInMap "asciinema" "cast" -}}
<div class="asciinema" id="asciinema-{{ $.Ordinal }}" x-data-cast="{{ . | safeHTMLAttr }}" x-data-opts="{{ $opts.Get "asciinema" | jsonify | safeHTMLAttr }}"></div>
{{- end -}}
layouts/_shortcodes/badge.html
+4 -3
View File
@@ -1,5 +1,6 @@
{{- $style := default "default" (.Get "style") -}}
<span class="book-badge {{ $style }}">
{{- with .Get "title" }}<span class="book-badge-title">{{ . | plainify }}</span>{{ end -}}
{{- with .Get "value" }}<span class="book-badge-value">{{ . | plainify }}</span>{{ end -}}
</span>
{{- with .Get "title" -}}<span class="book-badge-title">{{ . | plainify }}</span>{{- end -}}
{{- with .Get "value" -}}<span class="book-badge-value">{{ . | plainify }}</span>{{- end -}}
</span>
{{- /* remove whitespaces */ -}}
layouts/_shortcodes/button.html
+1
View File
@@ -3,3 +3,4 @@
<a {{ with $href }}href="{{ $href }}"{{ end }} {{ with $isRemote }}target="_blank" rel="noopener"{{ end }} class="book-btn{{ with .Get "class" }} {{ . }}{{ end }}">
{{- .InnerDeindent -}}
</a>
{{- /* remove whitespaces */ -}}
layouts/_shortcodes/card.html
+4 -7
View File
@@ -1,9 +1,7 @@
{{- /* remove whitespace */ -}}
{{- with .Get "href" -}}
{{- $destination := partial "docs/links/portable-link" (dict "Page" $.Page "Destination" .) -}}
<a class="book-card{{ with $.Get "class" }} {{ . }}{{ end }}" href="{{ $destination | safeURL }}">
<div><a class="book-card{{ with $.Get "class" }} {{ . }}{{ end }}" href="{{ . | safeURL }}">
{{- template "book-card-content" $ -}}
</a>
</a></div>
{{- else -}}
<div class="book-card{{ with .Get "class" }} {{ . }}{{ end }}">
{{- template "book-card-content" $ -}}
@@ -14,9 +12,8 @@
{{- with .Get "image" -}}
{{- $destination := partial "docs/links/portable-image" (dict "Page" $.Page "Destination" .) -}}
<img src="{{ $destination | safeURL }}" />
{{- end }}
{{- end -}}
<div class="markdown-inner">
{{ with .Inner }}{{ . }}{{ end }}
{{ with .Inner }}{{ . }}{{ end -}}
</div>
{{- end -}}
{{- /* remove whitespace */ -}}
layouts/_shortcodes/columns.html
+10 -10
View File
@@ -1,21 +1,21 @@
{{- $ratio := (split (.Get "ratio") ":") -}}
{{- if strings.Contains .InnerDeindent "<--->" -}}
{{ warnf "Columns shortcode seprator '<--->' is deprecated, use markdown list instead." -}}
{{- warnf "Columns shortcode seprator '<--->' is deprecated, use markdown list instead." -}}
<div class="book-columns flex flex-wrap{{ with .Get "class" }} {{ . }}{{ end }}">
{{ range $index, $content := split .InnerDeindent "<--->" }}
{{- range $index, $content := split .InnerDeindent "<--->" -}}
{{- $grow := default 1 (index $ratio $index) -}}
<div class="flex-even markdown-inner" style="flex-grow: {{ $grow }};">
{{ $content | safeHTML }}
{{- $content | safeHTML -}}
</div>
{{ end }}
{{- end -}}
</div>
{{ else }}
{{- if .Get "ratio" }}<style>{{ range $index, $grow := $ratio }}
{{- else -}}
{{- if .Get "ratio" -}}<style>{{- range $index, $grow := $ratio -}}
.book-columns-{{ $.Ordinal }}>ul>li:nth-child({{ $index | add 1 }}){
flex-grow: {{ default 1 $grow }};
}
{{ end }}</style>{{ end -}}
<div class="book-columns book-columns-{{ .Ordinal }} {{ with .Get "class" }}{{ . }}{{ end }}">
{{ .InnerDeindent | safeHTML }}
{{- end -}}</style>{{- end -}}
<div class="book-columns book-columns-{{ .Ordinal }}{{ with .Get "class" }} {{ . }}{{ end }}">
{{ .Inner | safeHTML -}}
</div>
{{ end -}}
{{- end -}}
layouts/_shortcodes/details.html
+8 -6
View File
@@ -1,7 +1,9 @@
{{- /* remove whitespaces */ -}}
<details {{ if or (.Get "open") (in .Params "open") }}open{{ end }}>
{{- $summary := cond .IsNamedParams (.Get "title") (.Get 0) -}}
<summary>{{ $summary | .Page.RenderString }}</summary>
<div class="markdown-inner">
{{ .InnerDeindent | safeHTML }}
</div>
</details>
{{- $summary := cond .IsNamedParams (.Get "title") (.Get 0) -}}
<summary>{{ $summary | .Page.RenderString }}</summary>
{{- /* remove whitespaces */ -}}
<div class="markdown-inner">
{{ .Inner | safeHTML -}}
</div></details>
{{- /* remove whitespaces */ -}}
layouts/_shortcodes/hint.html
+3 -1
View File
@@ -1,3 +1,5 @@
{{- /* remove whitespaces */ -}}
<blockquote class="book-hint {{ default "default" (.Get 0) }}">
{{ .Inner | safeHTML }}
{{ .Inner | safeHTML -}}
</blockquote>
{{- /* remove whitespaces */ -}}
layouts/_shortcodes/image.html
-1
View File
@@ -1,4 +1,3 @@
{{- /* remove whitespaces */ -}}
{{- $destination := partial "docs/links/portable-image" (dict "Page" .Page "Destination" (.Get "src")) -}}
<label class="book-image" for="book-image-toggle-{{ .Ordinal }}">
<input class="hidden toggle" type="checkbox" id="book-image-toggle-{{ .Ordinal }}" />
layouts/_shortcodes/katex.html
+14 -12
View File
@@ -1,19 +1,21 @@
{{- if not (.Page.Store.Get "katex") -}}
<!-- Include katex only first time -->
<link rel="stylesheet" href="{{ "katex/katex.min.css" | relURL }}" />
<script defer src="{{ "katex/katex.min.js" | relURL }}"></script>
{{ with resources.Get "katex.json" }}
<script defer src="{{ "katex/auto-render.min.js" | relURL }}" onload="renderMathInElement(document.body, {{ .Content | safeJS }});"></script>
{{ end }}
{{- .Page.Store.Set "katex" true -}}
<!-- Include katex only first time -->
{{- /* remove whitespaces */ -}}
<link rel="stylesheet" href="{{ "katex/katex.min.css" | relURL }}" />
{{- /* remove whitespaces */ -}}
<script defer src="{{ "katex/katex.min.js" | relURL }}"></script>
{{- with resources.Get "katex.json" -}}
<script defer src="{{ "katex/auto-render.min.js" | relURL }}" onload="renderMathInElement(document.body, {{ . | minify }});"></script>
{{- end -}}
{{- .Page.Store.Set "katex" true -}}
{{- end -}}
{{ if .Inner }}
{{- if .Inner -}}
<span>
{{- if .Get "display" }}
{{- if .Get "display" -}}
\[ {{ .Inner }} \]
{{ else }}
{{- else -}}
\( {{ .Inner }} \)
{{ end -}}
{{- end -}}
</span>
{{ end }}
{{- end -}}
layouts/_shortcodes/mermaid.html
+11 -9
View File
@@ -1,12 +1,14 @@
{{ if not (.Page.Store.Get "mermaid") }}
<!-- Include mermaid only first time -->
<script src="{{ "mermaid.min.js" | relURL }}"></script>
{{ with resources.Get "mermaid.json" }}
<script>mermaid.initialize({{ .Content | safeJS }})</script>
{{ end }}
{{ .Page.Store.Set "mermaid" true }}
{{ end }}
{{- if not (.Page.Store.Get "mermaid") -}}
<!-- Include mermaid only first time -->
{{- /* remove whitespaces */ -}}
<script src="{{ "mermaid.min.js" | relURL }}"></script>
{{- with resources.Get "mermaid.json" -}}
<script>mermaid.initialize({{ .Content | safeJS }})</script>
{{- end -}}
{{- .Page.Store.Set "mermaid" true -}}
{{- end -}}
<pre class="mermaid{{ with .Get "class" }} {{ . }}{{ end }}">
{{- .Inner | htmlEscape | safeHTML -}}
{{- .Inner | htmlEscape | safeHTML -}}
</pre>
{{- /* remove whitespaces */ -}}
layouts/_shortcodes/steps.html
+4 -2
View File
@@ -1,3 +1,5 @@
{{- /* remove whitespaces */ -}}
<div class="book-steps {{ with .Get "class" }}{{ . }}{{ end }}">
{{ .Inner }}
</div>
{{ .Inner -}}
</div>
{{- /* remove whitespaces */ -}}
layouts/_shortcodes/tab.html
+5 -2
View File
@@ -1,9 +1,12 @@
{{- $group := printf "tabs-%v" (default .Parent.Ordinal (.Parent.Get 0)) -}}
{{- $tab := printf "%s-%d" $group .Ordinal }}
{{- $tab := printf "%s-%d" $group .Ordinal -}}
<input type="radio" class="toggle" name="{{ $group }}" id="{{ $tab }}" {{ if not .Ordinal }}checked="checked"{{ end }} />
{{- /* remove whitespaces */ -}}
<label for="{{ $tab }}">
{{- .Get 0 -}}
</label>
{{- /* remove whitespaces */ -}}
<div class="book-tabs-content markdown-inner">
{{- .Inner -}}
{{ .Inner -}}
</div>
{{- /* remove whitespaces */ -}}
layouts/_shortcodes/tabs.html
+3 -1
View File
@@ -1,3 +1,5 @@
{{- /* remove whitespaces */ -}}
<div class="book-tabs">
{{ .Inner }}
{{- .Inner -}}
</div>
{{- /* remove whitespaces */ -}}