From b0cd2078f74f9f83f8d2e441c1707288e088d0ae Mon Sep 17 00:00:00 2001 From: XhmikosR Date: Wed, 8 Sep 2021 09:16:38 +0300 Subject: [PATCH] docs: backport layouts updates from the main branch --- site/layouts/partials/home/masthead.html | 2 +- site/layouts/partials/scripts.html | 2 +- site/layouts/partials/stylesheet.html | 2 +- site/layouts/shortcodes/callout.html | 3 +-- site/layouts/shortcodes/docsref.html | 2 +- site/layouts/shortcodes/example.html | 18 +++++++++------- site/layouts/shortcodes/param.html | 4 +++- site/layouts/shortcodes/placeholder.html | 27 +++++++++++++----------- site/layouts/shortcodes/year.html | 4 +--- 9 files changed, 34 insertions(+), 30 deletions(-) diff --git a/site/layouts/partials/home/masthead.html b/site/layouts/partials/home/masthead.html index 3fad86bcc9b2..beb00ec98bcd 100644 --- a/site/layouts/partials/home/masthead.html +++ b/site/layouts/partials/home/masthead.html @@ -18,6 +18,6 @@

Build fast, responsive sites with Bootstrap

- {{ partial "ads.html" . }} + {{ partial "ads" . }} diff --git a/site/layouts/partials/scripts.html b/site/layouts/partials/scripts.html index 9b05f24f01f8..19ac0c2eb7bc 100644 --- a/site/layouts/partials/scripts.html +++ b/site/layouts/partials/scripts.html @@ -13,7 +13,7 @@ {{- $vendor := resources.Match "js/vendor/*.js" -}} {{- $js := resources.Match "js/*.js" -}} -{{- $targetDocsJSPath := printf "/docs/%s/assets/js/docs.js" .Site.Params.docs_version -}} +{{- $targetDocsJSPath := path.Join "/docs" .Site.Params.docs_version "assets/js/docs.js" -}} {{- $docsJs := append $js $vendor | resources.Concat $targetDocsJSPath -}} {{- if eq hugo.Environment "production" -}} diff --git a/site/layouts/partials/stylesheet.html b/site/layouts/partials/stylesheet.html index 8013e6f9d98d..d34604424c47 100644 --- a/site/layouts/partials/stylesheet.html +++ b/site/layouts/partials/stylesheet.html @@ -11,7 +11,7 @@ {{- end -}} {{- if (ne .Page.Layout "examples") }} -{{- $targetDocsCssPath := printf "/docs/%s/assets/css/docs.css" .Site.Params.docs_version -}} +{{- $targetDocsCssPath := path.Join "/docs" .Site.Params.docs_version "assets/css/docs.css" -}} {{- $sassOptions := dict "targetPath" $targetDocsCssPath "outputStyle" "expanded" "precision" 6 -}} {{- $postcssOptions := dict "use" "autoprefixer" "noMap" true -}} diff --git a/site/layouts/shortcodes/callout.html b/site/layouts/shortcodes/callout.html index 007f8a8e8eaf..86683ecf4c8c 100644 --- a/site/layouts/shortcodes/callout.html +++ b/site/layouts/shortcodes/callout.html @@ -1,6 +1,5 @@ {{- /* - Usage: `callout "type"`, - where type is one of info (default), danger, warning + Usage: `callout "type"`, where `type` is one of info (default), danger, or warning */ -}} {{- $css_class := .Get 0 | default "info" -}} diff --git a/site/layouts/shortcodes/docsref.html b/site/layouts/shortcodes/docsref.html index 88e43d1725e0..2379de2b12e1 100644 --- a/site/layouts/shortcodes/docsref.html +++ b/site/layouts/shortcodes/docsref.html @@ -1 +1 @@ -{{- relref . ((printf "docs/%s%s" $.Site.Params.docs_version (.Get 0)) | relURL) -}} +{{- relref . ((path.Join "docs" $.Site.Params.docs_version (.Get 0)) | relURL) -}} diff --git a/site/layouts/shortcodes/example.html b/site/layouts/shortcodes/example.html index fd20839cbea7..0592adc6b5f7 100644 --- a/site/layouts/shortcodes/example.html +++ b/site/layouts/shortcodes/example.html @@ -1,26 +1,28 @@ {{- /* - Usage: `example [args]` + Usage: `example args` - `args` are optional and can be one of the following: - id: the `div`'s id - default: "" - class: any extra class(es) to be added to the `div` - default "" - show_preview: if the preview should be output in the HTML - default: `true` - show_markup: if the markup should be output in the HTML - default: `true` + `args` are all optional and can be one of the following: + * id: the `div`'s id - default: "" + * class: any extra class(es) to be added to the `div` - default: "" + * show_preview: if the preview should be output in the HTML - default: `true` + * show_markup: if the markup should be output in the HTML - default: `true` */ -}} +{{- $id := .Get "id" -}} +{{- $class := .Get "class" -}} {{- $lang := .Get "lang" | default "html" -}} {{- $show_preview := .Get "show_preview" | default true -}} {{- $show_markup := .Get "show_markup" | default true -}} {{- $input := .Inner -}} {{- if eq $show_preview true -}} - + {{- $input -}} {{- end -}} {{- if eq $show_markup true -}} - {{- $content := replaceRE `\n` `...` $input -}} + {{- $content := replaceRE `\n` `...` $input -}} {{- $content = replaceRE ` (class=" *?")` "" $content -}} {{- highlight (trim $content "\n") $lang "" -}} {{- end -}} diff --git a/site/layouts/shortcodes/param.html b/site/layouts/shortcodes/param.html index 50e2060ae2dc..34ad00c87a86 100644 --- a/site/layouts/shortcodes/param.html +++ b/site/layouts/shortcodes/param.html @@ -1,11 +1,13 @@ {{- /* Work around wrong escapes in integrity attributes. + Original: https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/shortcodes/param.html */ -}} {{- $name := .Get 0 -}} {{- with $name -}} {{- $value := $.Page.Param . -}} -{{- if in $name "_hash" -}} +{{- /* If any parameter ends with `_hash`, mark the string as safe HTML */ -}} +{{- if (strings.HasSuffix $name "_hash") -}} {{- $value = $value | safeHTML -}} {{- end -}} {{- with $value }}{{ . }}{{ else }}{{ errorf "Param %q not found: %s" $name $.Position }}{{ end -}} diff --git a/site/layouts/shortcodes/placeholder.html b/site/layouts/shortcodes/placeholder.html index 2373bc927468..c267bf4a75d0 100644 --- a/site/layouts/shortcodes/placeholder.html +++ b/site/layouts/shortcodes/placeholder.html @@ -1,21 +1,24 @@ {{- /* Usage: `placeholder args` - args can be one of the following: - title: Used in the SVG `title` tag, default "Placeholder" - text: The text to show in the image - default: "width x height" - class: default: "bd-placeholder-img" - color: The text color (foreground) - default: "#dee2e6" - background: The background color - default: "#868e96" - width: default: 100% - height: default: 180px + `args` are all optional and can be one of the following: + * title: Used in the SVG `title` tag - default: "Placeholder" + * text: The text to show in the image - default: "width x height" + * class: Class to add to the `svg` - default: "bd-placeholder-img" + * color: The text color (foreground) - default: "#dee2e6" + * background: The background color - default: "#868e96" + * width: default: "100%" + * height: default: "180px" */ -}} {{- $grays := $.Site.Data.grays -}} +{{- $default_color := (index $grays 2).hex -}} +{{- $default_background := (index $grays 5).hex -}} + {{- $title := .Get "title" | default "Placeholder" -}} {{- $class := .Get "class" -}} -{{- $color := .Get "color" | default (index $grays 2).hex -}} -{{- $background := .Get "background" | default (index $grays 5).hex -}} +{{- $color := .Get "color" | default $default_color -}} +{{- $background := .Get "background" | default $default_background -}} {{- $width := .Get "width" | default "100%" -}} {{- $height := .Get "height" | default "180" -}} {{- $text := .Get "text" | default (printf "%sx%s" $width $height) -}} @@ -24,7 +27,7 @@ {{- $show_text := not (eq $text "false") -}} diff --git a/site/layouts/shortcodes/year.html b/site/layouts/shortcodes/year.html index bc9dd300d18e..db7f18e3fcc7 100644 --- a/site/layouts/shortcodes/year.html +++ b/site/layouts/shortcodes/year.html @@ -1,5 +1,3 @@ -{{- /* - Output the current year -*/ -}} +{{- /* Outputs the current year */ -}} {{- now.Format "2006" -}}