diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2023-12-04 15:24:01 +0100 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2023-12-04 15:24:01 +0100 |
commit | d19ed4d4e69f51873135f05a51831d25ecc2071e (patch) | |
tree | 74dfd9af2b0f4a6c0933266c50ceaa569d388c71 /docs/layouts | |
parent | 9f978d387f8b7cb6bc03fe6b4dd52bb16862a784 (diff) | |
parent | 35dec7c96f7ee3eb17dd444f7067f0c776fb56ae (diff) |
Merge commit '35dec7c96f7ee3eb17dd444f7067f0c776fb56ae'
Diffstat (limited to 'docs/layouts')
27 files changed, 36 insertions, 706 deletions
diff --git a/docs/layouts/_default/_markup/render-codeblock-mermaid.html b/docs/layouts/_default/_markup/render-codeblock-mermaid.html deleted file mode 100644 index 94ea0cad0..000000000 --- a/docs/layouts/_default/_markup/render-codeblock-mermaid.html +++ /dev/null @@ -1,4 +0,0 @@ -<pre class="mermaid"> - {{- .Inner | safeHTML }} -</pre> -{{ .Page.Store.Set "hasMermaid" true }} diff --git a/docs/layouts/_default/page.html b/docs/layouts/_default/page.html deleted file mode 100644 index 2435e3ed7..000000000 --- a/docs/layouts/_default/page.html +++ /dev/null @@ -1,34 +0,0 @@ -<header class="flex-none w-100"> - {{ if .Params.categories }} - {{ range .Params.categories }} - <a href="{{ "/categories/" | relLangURL }}{{ . | urlize }}" class="f6 fw8 mb0 link mid-gray dim mr3"> - {{ humanize . | upper }} - </a> - {{ end }} - {{end}} - <h1 class="lh-title mb3 mv0 pt3 primary-color-dark"> - {{ .Title }} - </h1> -</header> - -<aside class="bt bw1 pt3 mt2 mid-gray b--mid-gray fn w-100"> - {{ with .Params.description }} - <div class="f4 fw4 lh-copy"> - {{ . | markdownify }} - </div> - {{ end }} - - <!-- - NOTE: Removed to test builds without it. - partial "components/author-github-data" (dict "context" . "size" "110") --> -</aside> - -{{ with .Params.featured_image_path }} - <img src="{{ . }}" alt="Featured Image for {{ $.Title }}" class="mw-100"> -{{ end }} - -<div class="prose prose-{{ .Type }}" id="prose"> - {{- partial "docs/functions-signatures.html" . -}} - {{- partial "docs/functions-aliases.html" . -}} - {{ .Content }} -</div> diff --git a/docs/layouts/index.rss.xml b/docs/layouts/index.rss.xml deleted file mode 100644 index 1d3498a1e..000000000 --- a/docs/layouts/index.rss.xml +++ /dev/null @@ -1,38 +0,0 @@ -<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> - <channel> - <title>{{ .Site.Title }} – {{ .Title }}</title> - <link>{{ .Permalink }}</link> - <description>Recent Hugo news from gohugo.io</description> - <generator>Hugo -- gohugo.io</generator>{{ with .Site.LanguageCode }} - <language>{{.}}</language>{{end}}{{ with .Site.Author.email }} - <managingEditor>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</managingEditor>{{end}}{{ with .Site.Author.email }} - <webMaster>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</webMaster>{{end}}{{ with .Site.Copyright }} - <copyright>{{.}}</copyright>{{end}}{{ if not .Date.IsZero }} - <lastBuildDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</lastBuildDate>{{ end }} - <image> - <url>{{ "img/hugo.png" | absURL }}</url> - <title>GoHugo.io</title> - <link>{{ .Permalink }}</link> - </image> - {{ with .OutputFormats.Get "RSS" }} - {{ printf "<atom:link href=%q rel=\"self\" type=%q />" .Permalink .MediaType | safeHTML }} - {{ end }} - {{ range first 50 (where .Site.RegularPages "Type" "in" (slice "news" "showcase")) }} - <item> - <title>{{ .Section | title }}: {{ .Title }}</title> - <link>{{ .Permalink }}</link> - <pubDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</pubDate> - {{ with .Site.Author.email }}<author>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</author>{{end}} - <guid>{{ .Permalink }}</guid> - <description> - {{ $img := (.Resources.ByType "image").GetMatch "*featured*" }} - {{ with $img }} - {{ $img := .Resize "640x" }} - {{ printf "<![CDATA[<img src=\"%s\" width=\"%d\" height=\"%d\"/>]]>" $img.Permalink $img.Width $img.Height | safeHTML }} - {{ end }} - {{ .Content | html }} - </description> - </item> - {{ end }} - </channel> -</rss>
\ No newline at end of file diff --git a/docs/layouts/maintenance/list.html b/docs/layouts/maintenance/list.html deleted file mode 100644 index f78bbd08f..000000000 --- a/docs/layouts/maintenance/list.html +++ /dev/null @@ -1,78 +0,0 @@ -{{ define "main" }} - <div class="w-100 ph4 pb5 pb6-ns pt1 mt4 pt3-ns"> - <div class="flex-l"> - <div class="order-2 w-100 w-20-l ph5-m ph0-l mb4 sticky"> - <aside - class="fixed-lTK mw5-l right-0 f6 bl-l b--moon-gray pv4 pv0-ns ph4-l nested-list-reset nested-links nested-copy-line-height"> - <p class="b">What's on this Page</p> - <ul> - <li><a href="#last-updated">Last Updated</a></li> - <li> - <a href="#least-recently-updated">Least Recently Updated</a> - </li> - <li><a href="#todos">Pages marked with TODO</a></li> - <li> - <a href="#dependencies">Project dependencies (Hugo Modules)</a> - </li> - </ul> - </aside> - </div> - <div class="w-100"> - {{ $byLastMod := .Site.RegularPages.ByLastmod }} - {{ $recent := ($byLastMod | last 30).Reverse }} - {{ $leastRecent := $byLastMod | first 10 }} - <h2 id="last-updated">Last Updated</h2> - {{ partial "maintenance-pages-table.html" $recent }} - <h2 id="least-recently-updated">Least Recently Updated</h2> - {{ partial "maintenance-pages-table.html" $leastRecent }} - - {{/* Don't think this is possible with where directly. Should investigate. */}} - {{ .Scratch.Set "todos" slice }} - {{ range .Site.RegularPages }} - {{ if .HasShortcode "todo" }} - {{ $.Scratch.Add "todos" . }} - {{ end }} - {{ end }} - <h2 id="todos">Pages marked with TODO</h2> - {{ partial "maintenance-pages-table.html" (.Scratch.Get "todos") }} - - - <h2 id="dependencies">Dependencies</h2> - <table class="collapse ba br2 b--black-10 pv2 ph3"> - <thead> - <tr> - <th class="pv2 ph3 tl f6 fw6 ttu">#</th> - <th class="pv2 ph3 tl f6 fw6 ttu">Owner</th> - <th class="pv2 ph3 tl f6 fw6 ttu">Path</th> - <th class="pv2 ph3 tl f6 fw6 ttu">Version</th> - <th class="pv2 ph3 tl f6 fw6 ttu">Time</th> - <th class="pv2 ph3 tl f6 fw6 ttu">Vendor</th> - </tr> - </thead> - <tbody> - {{ range $index, $element := hugo.Deps }} - <tr class="striped--light-gray"> - <th class="pv2 ph3">{{ add $index 1 }}</th> - <td class="pv2 ph3"> - {{ with $element.Owner }}{{ .Path }}{{ end }} - </td> - <td class="pv2 ph3"> - {{ $element.Path }} - {{ with $element.Replace }} - => - {{ .Path }} - {{ end }} - </td> - <td class="pv2 ph3">{{ $element.Version }}</td> - <td class="pv2 ph3"> - {{ with $element.Time }}{{ . }}{{ end }} - </td> - <td class="pv2 ph3">{{ $element.Vendor }}</td> - </tr> - {{ end }} - </tbody> - </table> - </div> - </div> - </div> -{{ end }} diff --git a/docs/layouts/news/list.html b/docs/layouts/news/list.html deleted file mode 100644 index 32f72a446..000000000 --- a/docs/layouts/news/list.html +++ /dev/null @@ -1,70 +0,0 @@ -{{ define "main" }} -<div class="w-100 ph4 ph5-ns pb5 pb6-ns pt1 pt3-ns "> - - <article class="cf pa3 pa4-m pa4-l nested-copy-line-height nested-img"> - <h1 class="primary-color-dark"> - {{ .Title }} - </h1> - <div class="nested-copy-line-height"> - {{ .Content }} - </div> - </article> - - <div class="flex flex-wrap"> - {{ $interior_classes := $.Site.Params.flex_box_interior_classes }} - <section class="flex-ns flex-wrap justify-between w-100 w-80-nsTK v-top"> - - {{ $news_items := slice }} - - {{/* Get releases from GitHub. */}} - {{ $u := "https://api.github.com/repos/gohugoio/hugo/releases" }} - {{ $releases := partial "inline/get-remote-data.html" $u }} - {{ $releases = where $releases "draft" false }} - {{ $releases = where $releases "prerelease" false }} - {{ range $releases | first 20 }} - {{ $ctx := dict - "Date" (.published_at | time.AsTime) - "Title" (printf "Release %s" .name) - "Permalink" .html_url - "Section" "news" - "Summary" "" - }} - {{ $news_items = $news_items | append $ctx }} - {{ end }} - - {{/* Get content pages from news section. */}} - {{ range .Pages }} - {{ $ctx := dict - "Date" .Date - "Title" .Title - "RelPermalink" .RelPermalink - "Section" "news" - "Summary" .Summary - "Params" (dict "description" .Description) - }} - {{ $news_items = $news_items | append $ctx }} - {{ end }} - - {{/* Sort by date (descending) and render. */}} - {{ range sort $news_items "Date" "desc" }} - {{ partial "boxes-section-summaries" (dict "context" . "classes" $interior_classes "fullcontent" false) }} - {{ end }} - - </section> - </div> - -</div> -{{ end }} - -{{ define "partials/inline/get-remote-data.html" }} - {{ $u := . }} - {{ $r := "" }} - {{ with $r = resources.GetRemote $u }} - {{ with .Err }} - {{ errorf "%s" . }} - {{ end }} - {{ else }} - {{ errorf "Unable to get remote resource %q" $u }} - {{ end }} - {{ return ($r | transform.Unmarshal) }} -{{ end }} diff --git a/docs/layouts/partials/boxes-section-summaries.html b/docs/layouts/partials/boxes-section-summaries.html deleted file mode 100644 index 268336cf5..000000000 --- a/docs/layouts/partials/boxes-section-summaries.html +++ /dev/null @@ -1,38 +0,0 @@ -<div class="relative {{ .classes }} weight-{{ .context.Weight }}"> - <div class="bg-white mb2 pa3 pa4-l gray"> - - {{ $href := .context.RelPermalink }} - {{ if eq .context.Section "news" }} - {{ $href = .context.Permalink }} - <time class="f6 db" datetime="{{ .context.Date.Format `2006-01-02T15:04:05Z07:00` }}"> - {{ .context.Date.Format "January 2, 2006" }} - </time> - {{ end }} - - <h1 class="near-black f3"> - <a href="{{ $href }}" class="link primary-color dim"> - {{- if eq .context.Section "functions" -}} - {{ .context.LinkTitle }} - {{- else -}} - {{ .context.Title }} - {{- end -}} - </a> - </h1> - - <div class="lh-copy links"> - {{ if eq .context.Section "commands" }} - {{ replaceRE `(?s).*?##\s.*?\n\n(.*?)\n.*` "$1" .context.RawContent }} - {{ else }} - {{ if .context.Params.description }} - {{ .context.Params.description | markdownify }} - {{ else }} - {{ .context.Summary }} - {{ end }} - {{ end }} - <a href="{{ $href }}" class="f6 mt2 db link primary-color dim"> - Read More » - </a> - </div> - - </div> -</div> diff --git a/docs/layouts/partials/boxes-small-news.html b/docs/layouts/partials/boxes-small-news.html deleted file mode 100644 index 0d53c5465..000000000 --- a/docs/layouts/partials/boxes-small-news.html +++ /dev/null @@ -1 +0,0 @@ -{{/* Empty for now. */}} diff --git a/docs/layouts/partials/docs/functions-aliases.html b/docs/layouts/partials/docs/functions-aliases.html deleted file mode 100644 index b0ba9be02..000000000 --- a/docs/layouts/partials/docs/functions-aliases.html +++ /dev/null @@ -1,12 +0,0 @@ -{{- with .Params.function.aliases }} - {{- $label := "Alias" }} - {{- if gt (len .) 1 }} - {{- $label = "Aliases" }} - {{- end }} - <h2 class="minor mb1 primary-color-dark">{{ $label }}</h2> - {{- range . }} - <pre class="f5 mb4 ph3 pv2 bg-light-gray" style="border-left:4px solid #0594CB;"> - {{- . -}} - </pre> - {{- end }} -{{- end -}} diff --git a/docs/layouts/partials/docs/functions-signatures.html b/docs/layouts/partials/docs/functions-signatures.html deleted file mode 100644 index b349739e9..000000000 --- a/docs/layouts/partials/docs/functions-signatures.html +++ /dev/null @@ -1,12 +0,0 @@ -{{- with .Params.function.signatures }} - <h2 class="minor mb1 pt4 primary-color-dark">Syntax</h2> - {{- range . }} - {{- $signature := . }} - {{- if $.Params.function.returnType }} - {{- $signature = printf "%s ⟼ %s" . $.Params.function.returnType }} - {{- end }} - <pre class="f5 mb4 ph3 pv2 bg-light-gray overflow-x-auto" style="border-left:4px solid #0594CB;"> - {{- $signature -}} - </pre> - {{- end }} -{{- end -}} diff --git a/docs/layouts/partials/hooks/before-body-end.html b/docs/layouts/partials/hooks/before-body-end.html deleted file mode 100644 index dab653508..000000000 --- a/docs/layouts/partials/hooks/before-body-end.html +++ /dev/null @@ -1,7 +0,0 @@ -{{ if .Page.Store.Get "hasMermaid" }} - <script type="module" async> - import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@9/+esm'; - - mermaid.initialize({ startOnLoad: true }); - </script> -{{ end }} diff --git a/docs/layouts/partials/maintenance-pages-table.html b/docs/layouts/partials/maintenance-pages-table.html deleted file mode 100644 index a2429a335..000000000 --- a/docs/layouts/partials/maintenance-pages-table.html +++ /dev/null @@ -1,24 +0,0 @@ -<table class="collapse ba br2 b--black-10 pv2 ph3"> - <thead> - <tr> - <th class="pv2 ph3 tl f6 fw6 ttu">LastMod</th> - <th class="pv2 ph3 tl f6 fw6 ttu">Link</th> - <th class="pv2 ph3 tl f6 fw6 ttu">GitHub</th> - </tr> - </thead> - <tbody> - {{ range . }} - <tr class="striped--light-gray"> - <td class="pv2 ph3">{{ .Lastmod.Format "2006-01-02" }}</td> - <td class="pv2 ph3"> - <a href="{{ .Permalink }}">{{ .Title }}</a> - </td> - <td class="pv2 ph3"> - <a href="{{.Site.Params.ghrepo}}blob/master/content/{{.Lang }}/{{.File.Path}}"> - {{ with .GitInfo }}{{ .Subject }}{{ else }}Source{{ end }} - </a> - </td> - </tr> - {{ end }} - </tbody> -</table>
\ No newline at end of file diff --git a/docs/layouts/partials/related.html b/docs/layouts/partials/related.html deleted file mode 100644 index 05a2e9160..000000000 --- a/docs/layouts/partials/related.html +++ /dev/null @@ -1,17 +0,0 @@ -{{- $heading := "See also" }} -{{- $related := site.RegularPages.Related . | first 5 }} - -{{- if eq .Type "functions" }} - {{- $heading = "Related functions" }} - {{- $opts := dict "document" . "indices" (slice "relatedFunctions") }} - {{- $related = site.RegularPages.Related $opts | first 7 }} -{{- end }} - -{{- with $related }} - <h2>{{ $heading }}</h2> - <ul> - {{- range . }} - <li><a href="{{ .RelPermalink }}">{{ .Title }}</a></li> - {{- end }} - </ul> -{{- end }} diff --git a/docs/layouts/shortcodes/chroma-lexers.html b/docs/layouts/shortcodes/chroma-lexers.html deleted file mode 100644 index 2e10c3dee..000000000 --- a/docs/layouts/shortcodes/chroma-lexers.html +++ /dev/null @@ -1,6 +0,0 @@ -<dl> - {{ range .Site.Data.docs.chroma.lexers }} - <dt>{{ .Name }}</dt> - <dd>{{ with .Aliases }}{{ delimit . ", " }}{{ end }}</dd> - {{ end }} -</dl> diff --git a/docs/layouts/shortcodes/code-toggle.html b/docs/layouts/shortcodes/code-toggle.html deleted file mode 100644 index 6e0e3d73e..000000000 --- a/docs/layouts/shortcodes/code-toggle.html +++ /dev/null @@ -1,101 +0,0 @@ -{{- /* - Renders syntax-highlighted configuration data in JSON, TOML, and YAML formats. - - @param {string} [config] The section of site.Data.docs.config to render. - @param {bool} [copy=true] If true, display a copy to clipboard button. - @param {string} [file] The file name to display above the rendered code. - @param {bool} [fm=false] If true, render the code as front matter. - @param {bool} [skipHeader=false] If false, omit top level key(s) when rendering a section of site.Data.docs.config. - - @returns {template.HTML} -*/}} - -{{- /* Initialize. */}} -{{- $config := "" }} -{{- $dataKey := "" }} -{{- $copy := true }} -{{- $file := "" }} -{{- $fm := false }} -{{- $skipHeader := false }} - -{{- /* Get parameters. */}} -{{- $config = .Get "config" }} -{{- $dataKey = .Get "dataKey" }} -{{- $file = .Get "file" }} -{{- if in (slice "false" false 0) (.Get "copy") }} - {{- $copy = false }} -{{- else if in (slice "true" true 1) (.Get "copy") }} - {{- $copy = true }} -{{- end }} -{{- if in (slice "false" false 0) (.Get "fm") }} - {{- $fm = false }} -{{- else if in (slice "true" true 1) (.Get "fm") }} - {{- $fm = true }} -{{- end }} -{{- if in (slice "false" false 0) (.Get "skipHeader") }} - {{- $skipHeader = false }} -{{- else if in (slice "true" true 1) (.Get "skipHeader") }} - {{- $skipHeader = true }} -{{- end }} - -{{- /* Define constants. */}} -{{- $delimiters := dict "toml" "+++" "yaml" "---" }} -{{- $langs := slice "yaml" "toml" "json" }} -{{- $placeHolder := "#-hugo-placeholder-#" }} - -{{- /* Render. */}} -{{- $code := "" }} -{{- if $config }} - {{- $file = $file | default "hugo" }} - {{- $sections := (split $config ".") }} - {{- $configSection := index $.Site.Data.docs.config $sections }} - {{- $code = dict $sections $configSection }} - {{- if $skipHeader }} - {{- $code = $configSection }} - {{- end }} -{{- else if $dataKey }} - {{- $file = $file | default $dataKey }} - {{- $sections := (split $dataKey ".") }} - {{- $code = index $.Site.Data.docs $sections }} -{{- else }} - {{- $code = $.Inner }} -{{- end }} -<div class="code relative" {{ with $file }}id="{{ . | urlize }}"{{ end }}> - <div class="code-nav flex flex-nowrap items-stretch"> - {{- with $file }} - <div class="san-serif f6 dib lh-solid pl2 pv2 mr2"> - {{ . }}{{ if not $fm }}.{{ end }} - </div> - {{- end }} - {{- range $langs }} - <button - data-toggle-tab="{{ . }}" - class="tab-button {{ cond (eq . "yaml") "active" "" }} ba san-serif f6 dib lh-solid ph2 pv2"> - {{ . }} - </button> - - {{- end }} - </div> - <div class="tab-content"> - {{- range $langs }} - <div - data-pane="{{ . }}" - class="code-copy-content nt3 tab-pane {{ cond (eq . "yaml") "active" "" }}"> - {{- $hCode := $code | transform.Remarshal . }} - {{- if and $fm (in (slice "toml" "yaml") .) }} - {{- $hCode = printf "%s\n%s\n%s" $placeHolder $hCode $placeHolder }} - {{- end }} - {{- $hCode = $hCode | replaceRE `\n+` "\n" }} - {{ highlight $hCode . "" | replaceRE $placeHolder (index $delimiters .) | safeHTML }} - </div> - {{- if $copy }} - <button - class="needs-js copy copy-toggle bg-accent-color-dark f6 absolute top-0 right-0 lh-solid hover-bg-primary-color-dark bn white ph3 pv2" - title="Copy this code to your clipboard." - data-clipboard-action="copy" - aria-label="copy button"></button> - {{- /* Functionality located within filesaver.js The copy here is located in the css with .copy class so it can be replaced with JS on success */}} - {{- end }} - {{- end }} - </div> -</div> diff --git a/docs/layouts/shortcodes/code.html b/docs/layouts/shortcodes/code.html deleted file mode 100644 index 31ca27596..000000000 --- a/docs/layouts/shortcodes/code.html +++ /dev/null @@ -1,39 +0,0 @@ -{{- /* -Renders syntax highlighted code. - -@param {bool} [copy=true] If true, display a copy to clipboard button. -@param {string} [file] The file name to display above the rendered code. -@param {string} [lang] The code language of the inner content. - -@returns {template.HTML} -*/}} - -{{- /* Initialize. */}} -{{- $copy := true }} -{{- $file := " " }} -{{- $lang := "" }} - -{{- /* Get parameters. */}} -{{- $file = .Get "file" }} -{{- $lang = or (.Get "lang") (path.Ext $file | strings.TrimPrefix ".") "text" }} -{{- if in (slice "false" false 0) (.Get "copy") }} - {{- $copy = false }} -{{- else if in (slice "true" true 1) (.Get "copy")}} - {{- $copy = true }} -{{- end }} - -{{- /* Use the go-html-template Chroma lexer for HTML. */}} -{{- if eq $lang "html" }} - {{- $lang = "go-html-template" }} -{{- end }} - -{{- /* Render. */}} -<div class="code relative" id="{{ $file | urlize }}"> - <div class="f6 dib lh-solid pl2 pv2">{{ or $file "nbsp;" }}</div> - {{- if $copy }} - <button class="needs-js copy bg-accent-color-dark f6 absolute top-0 right-0 lh-solid hover-bg-primary-color-dark bn white ph3 pv2" title="Copy this code to your clipboard." data-clipboard-action="copy" aria-label="copy button"></button> - {{- end }} - <div class="code-copy-content nt3"> - {{- highlight (trim .Inner "\n\r") $lang }} - </div> -</div> diff --git a/docs/layouts/shortcodes/datatable-filtered.html b/docs/layouts/shortcodes/datatable-filtered.html deleted file mode 100644 index ff3f299bd..000000000 --- a/docs/layouts/shortcodes/datatable-filtered.html +++ /dev/null @@ -1,39 +0,0 @@ -{{ $package := (index .Params 0) }} -{{ $listname := (index .Params 1) }} -{{ $filter := split (index .Params 2) " " }} -{{ $filter1 := index $filter 0 }} -{{ $filter2 := index $filter 1 }} -{{ $filter3 := index $filter 2 }} - -{{ $list := (index (index .Site.Data.docs $package) $l |