diff options
Diffstat (limited to 'docs/layouts')
22 files changed, 309 insertions, 0 deletions
diff --git a/docs/layouts/index.rss.xml b/docs/layouts/index.rss.xml new file mode 100644 index 000000000..1d3498a1e --- /dev/null +++ b/docs/layouts/index.rss.xml @@ -0,0 +1,38 @@ +<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 new file mode 100644 index 000000000..50059ad9e --- /dev/null +++ b/docs/layouts/maintenance/list.html @@ -0,0 +1,36 @@ +{{ 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> + </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" $recent }} + <h2 id="least-recently-updated">Least Recently Updated</h2> + {{ partial "maintenance-pages-table" $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" (.Scratch.Get "todos") }} + + </div> + </div> +</div> +{{ end }}
\ No newline at end of file diff --git a/docs/layouts/partials/maintenance-pages-table.html b/docs/layouts/partials/maintenance-pages-table.html new file mode 100644 index 000000000..a29f0405c --- /dev/null +++ b/docs/layouts/partials/maintenance-pages-table.html @@ -0,0 +1,24 @@ +<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/{{.Path}}"> + {{ with .GitInfo }}{{ .Subject }}{{ else }}Source{{ end }} + </a> + </td> + </tr> + {{ end }} + </tbody> +</table>
\ No newline at end of file diff --git a/docs/layouts/shortcodes/asciicast.html b/docs/layouts/shortcodes/asciicast.html new file mode 100644 index 000000000..ee23adc2d --- /dev/null +++ b/docs/layouts/shortcodes/asciicast.html @@ -0,0 +1,2 @@ +{{ $id := .Get 0 }} +<script type="text/javascript" src="https://asciinema.org/a/{{ $id }}.js" id="asciicast-{{ $id }}" data-rows="10" async></script> diff --git a/docs/layouts/shortcodes/code.html b/docs/layouts/shortcodes/code.html new file mode 100644 index 000000000..83220c47d --- /dev/null +++ b/docs/layouts/shortcodes/code.html @@ -0,0 +1,22 @@ +{{ $file := .Get "file" }} +{{ $.Scratch.Set "codeLang" "" }} +{{ $suffix := findRE "(\\.[^.]+)$" $file 1 }} +{{ with $suffix }} +{{ $.Scratch.Set "codeLang" (index . 0 | strings.TrimPrefix ".") }} +{{ end }} +{{ with .Get "codeLang" }}{{ $.Scratch.Set "codeLang" . }}{{ end }} +<div class="code relative" id="{{ $file | urlize}}"> + {{- with $file -}} + <div class="filename san-serif f6 dib lh-solid pl2 pv2">{{.}}</div> + {{- end -}} + + {{ if ne (.Get "copy") "false" }} + <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> + {{/* 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}} + <div class="code-copy-content nt3" {{with .Get "download"}}id="{{.}}"{{end}}> + {{ if .Get "nocode" }}{{ $.Inner }}{{ else }}{{ with $.Scratch.Get "codeLang" }}{{- highlight $.Inner . "" | -}}{{ else }}<pre><code>{{- .Inner | string -}}</code></pre>{{ end }}{{ end }} + </div> + +</div> diff --git a/docs/layouts/shortcodes/datatable-filtered.html b/docs/layouts/shortcodes/datatable-filtered.html new file mode 100644 index 000000000..576ddab6f --- /dev/null +++ b/docs/layouts/shortcodes/datatable-filtered.html @@ -0,0 +1,28 @@ +{{ $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) $listname) }} +{{ $fields := after 3 .Params }} +{{ $list := where $list $filter1 $filter2 $filter3 }} + +<table class="table table-bordered"> + <tr> + {{ range $fields }} + <th>{{ . }}</th> + {{ end }} + </tr> + {{ range $list }} + <tr> + {{ range $k, $v := . }} + {{ $.Scratch.Set $k $v }} + {{ end }} + {{ range $fields }} + <td>{{ $.Scratch.Get . }}</td> + {{ end }} + </tr> + {{ end }} +</table> diff --git a/docs/layouts/shortcodes/datatable.html b/docs/layouts/shortcodes/datatable.html new file mode 100644 index 000000000..4e2814f5a --- /dev/null +++ b/docs/layouts/shortcodes/datatable.html @@ -0,0 +1,22 @@ +{{ $package := (index .Params 0) }} +{{ $listname := (index .Params 1) }} +{{ $list := (index (index .Site.Data.docs $package) $listname) }} +{{ $fields := after 2 .Params }} + +<table class="table table-bordered"> + <tr> + {{ range $fields }} + <th>{{ . }}</th> + {{ end }} + </tr> + {{ range $list }} + <tr> + {{ range $k, $v := . }} + {{ $.Scratch.Set $k $v }} + {{ end }} + {{ range $fields }} + <td>{{ $.Scratch.Get . }}</td> + {{ end }} + </tr> + {{ end }} +</table> diff --git a/docs/layouts/shortcodes/directoryindex.html b/docs/layouts/shortcodes/directoryindex.html new file mode 100644 index 000000000..37e7d3ad1 --- /dev/null +++ b/docs/layouts/shortcodes/directoryindex.html @@ -0,0 +1,13 @@ +{{- $pathURL := .Get "pathURL" -}} +{{- $path := .Get "path" -}} +{{- $files := readDir $path -}} +<table> + <th>Size in bytes</th> + <th>Name</th> +{{- range $files }} + <tr> + <td>{{ .Size }}</td> + <td><a href="{{ $pathURL }}{{ .Name | relURL }}" target="_blank"> {{ .Name }}</a></td> + </tr> +{{- end }} +</table> diff --git a/docs/layouts/shortcodes/docfile.html b/docs/layouts/shortcodes/docfile.html new file mode 100644 index 000000000..2f982aae8 --- /dev/null +++ b/docs/layouts/shortcodes/docfile.html @@ -0,0 +1,11 @@ +{{ $file := .Get 0}} +{{ $filepath := $file }} +{{ $syntax := index (split $file ".") 1 }} +{{ $syntaxoverride := eq (len .Params) 2 }} +<div class="code-copy" id="{{$file | urlize}}"> + <div class="code-copy-header"><div class="action-buttons"></div><span title="" class="filename">{{$filepath}}</span><i class="icon-{{$syntax}} input"></i></div> + <button class="copy-button" title="Copy to clipboard" data-clipboard-snippet> + <div class="copy-text"><i class="icon-clipboard"></i> COPY</div> + </button> + <pre><code class="language-{{if $syntaxoverride}}{{.Get 1}}{{else}}{{$syntax}}{{end}}">{{- readFile $file -}}</code></pre> +</div> diff --git a/docs/layouts/shortcodes/exfile.html b/docs/layouts/shortcodes/exfile.html new file mode 100644 index 000000000..226782957 --- /dev/null +++ b/docs/layouts/shortcodes/exfile.html @@ -0,0 +1,12 @@ +{{ $file := .Get 0}} +{{ $filepath := replace $file "static/" ""}} +{{ $syntax := index (split $file ".") 1 }} +{{ $syntaxoverride := eq (len .Params) 2 }} +<div class="code-copy" id="{{$file | urlize}}"> + <div class="code-copy-header examplesite"><div class="action-buttons"></div><span class="filename"><i class="icon-website"></i>{{$filepath}}</span><i class="icon-{{$syntax}} input"></i></div> + <button class="copy-button" title="Copy to clipboard" data-clipboard-snippet> + <div class="copy-text"><i class="icon-clipboard"></i> COPY</div> + </button> + <pre><code class="language-{{if $syntaxoverride}}{{.Get 1}}{{else}}{{$syntax}}{{end}}">{{- readFile $file -}}</code></pre> + <a role="button" target="_blank" href="{{$.Site.Params.ghdocsrepo}}{{$file}}" title="See {{$filepath}} source on GitHub" class="tooltip see-on-github" data-tooltip="See {{$filepath}} source on GitHub">Source<i class="icon-github"></i></a> +</div> diff --git a/docs/layouts/shortcodes/exfm.html b/docs/layouts/shortcodes/exfm.html new file mode 100644 index 000000000..c0429bbe1 --- /dev/null +++ b/docs/layouts/shortcodes/exfm.html @@ -0,0 +1,13 @@ +<!-- Similar to exfile.html but *only* pulls the front matter from the example/content/*md --> +{{ $file := .Get 0}} +{{ $filepath := replace $file "static/" ""}} +{{ $syntax := index (split $file ".") 1 }} +{{ $syntaxoverride := eq (len .Params) 2 }} +<div class="code-copy" id="{{$file | urlize}}"> + <div class="code-copy-header examplesite"><div class="action-buttons"></div><span title="" class="filename">{{$filepath}}</span><i class="icon-{{$syntax}} input"></i></div> + <button class="copy-button" title="Copy to clipboard" data-clipboard-snippet> + <div class="copy-text"><i class="icon-clipboard"></i> COPY</div> + </button> + <pre><code class="language-{{if $syntaxoverride}}{{.Get 1}}{{else}}{{$syntax}}{{end}}">{{- readFile $file -}}</code></pre> + <a role="button" target="_blank" href="{{$.Site.Params.ghdocsrepo}}{{$file}}" title="See {{$filepath}} on GitHub" class="see-on-github">Source<i class="icon-github"></i></a> +</div>
\ No newline at end of file diff --git a/docs/layouts/shortcodes/gh.html b/docs/layouts/shortcodes/gh.html new file mode 100644 index 000000000..981f4b838 --- /dev/null +++ b/docs/layouts/shortcodes/gh.html @@ -0,0 +1,9 @@ +{{ range .Params }} + {{ if eq (substr . 0 1) "@" }} + <a href="//github.com/{{ substr . 1 }}">{{ . }}</a> + {{ else if eq (substr . 0 2) "0x" }} + <a href="//github.com/gohugoio/hugo/commit/{{ substr . 2 }}">{{ substr . 2 6 }}</a> + {{ else }} + <a href="//github.com/gohugoio/hugo/issues/{{ . }}">#{{ . }}</a> + {{ end }} +{{ end }} diff --git a/docs/layouts/shortcodes/ghrepo.html b/docs/layouts/shortcodes/ghrepo.html new file mode 100644 index 000000000..e9df40d6a --- /dev/null +++ b/docs/layouts/shortcodes/ghrepo.html @@ -0,0 +1 @@ +<a href="{{$.Site.Params.ghrepo}}" target="_blank">GitHub repository</a>
\ No newline at end of file diff --git a/docs/layouts/shortcodes/imgproc.html b/docs/layouts/shortcodes/imgproc.html new file mode 100644 index 000000000..6ff73e1f9 --- /dev/null +++ b/docs/layouts/shortcodes/imgproc.html @@ -0,0 +1,25 @@ +{{ $original := .Page.Resources.GetMatch (printf "%s*" (.Get 0)) }} +{{ $command := .Get 1 }} +{{ $options := .Get 2 }} +{{ if eq $command "Fit"}} +{{ .Scratch.Set "image" ($original.Fit $options) }} +{{ else if eq $command "Resize"}} +{{ .Scratch.Set "image" ($original.Resize $options) }} +{{ else if eq $command "Fill"}} +{{ .Scratch.Set "image" ($original.Fill $options) }} +{{ else }} +{{ errorf "Invalid image processing command: Must be one of Fit, Fill or Resize."}} +{{ end }} +{{ $image := .Scratch.Get "image" }} +<figure style="width: {{ add $image.Width 3 }}px; padding: 3px; background-color: #cccc"> + <img src="{{ $image.RelPermalink }}" width="{{ $image.Width }}" height="{{ $image.Height }}"> + <figcaption> + <small> + {{ with .Inner }} + {{ . }} + {{ else }} + .{{ $command }} "{{ $options }}" + {{ end }} + </small> + </figcaption> +</figure>
\ No newline at end of file diff --git a/docs/layouts/shortcodes/nohighlight.html b/docs/layouts/shortcodes/nohighlight.html new file mode 100644 index 000000000..238234f17 --- /dev/null +++ b/docs/layouts/shortcodes/nohighlight.html @@ -0,0 +1 @@ +<pre><code class="hljs nohighlight">{{ .Inner }}</code></pre>
\ No newline at end of file diff --git a/docs/layouts/shortcodes/note.html b/docs/layouts/shortcodes/note.html new file mode 100644 index 000000000..fcf081bd5 --- /dev/null +++ b/docs/layouts/shortcodes/note.html @@ -0,0 +1,8 @@ +<aside class="admonition note"> + <div class="note-icon"> + {{partial "svg/exclamation.svg" (dict "size" "20px" ) }} + </div> + <!-- <h2 id="{{if .Get 0}}{{.Get 0 | urlize}}{{else}}note{{end}}">{{if .Get 0}}{{.Get 0 | markdownify}}{{else}}Note{{end}}</h2> --> + <!-- <h3>Note</h3> --> + <div class="admonition-content">{{- .Inner -}}</div> +</aside> diff --git a/docs/layouts/shortcodes/output.html b/docs/layouts/shortcodes/output.html new file mode 100644 index 000000000..e51d284bb --- /dev/null +++ b/docs/layouts/shortcodes/output.html @@ -0,0 +1,8 @@ +{{$file := .Get "file"}} +{{$icon := index (split $file ".") 1 }} +<div class="code" id="{{$file | urlize}}"> + <div class="filename" title="{{$file}}">{{$file}}</div> + <div class="code-copy-content output-content"> + <pre><code>{{- .Inner | string -}}</code></pre> + </div> +</div>
\ No newline at end of file diff --git a/docs/layouts/shortcodes/readfile.html b/docs/layouts/shortcodes/readfile.html new file mode 100644 index 000000000..36400ac55 --- /dev/null +++ b/docs/layouts/shortcodes/readfile.html @@ -0,0 +1,8 @@ +{{$file := .Get "file"}} +{{- if eq (.Get "markdown") "true" -}} +{{- $file | readFile | markdownify -}} +{{- else if (.Get "highlight") -}} +{{- highlight ($file | readFile) (.Get "highlight") "" -}} +{{- else -}} +{{ $file | readFile | safeHTML }} +{{- end -}}
\ No newline at end of file diff --git a/docs/layouts/shortcodes/tip.html b/docs/layouts/shortcodes/tip.html new file mode 100644 index 000000000..0b56ac560 --- /dev/null +++ b/docs/layouts/shortcodes/tip.html @@ -0,0 +1,8 @@ +<aside class="admonition tip"> + <div class="tip-icon"> + {{partial "svg/exclamation.svg" .}} + </div> + <!-- <h2 id="{{if .Get 0}}{{.Get 0 | urlize}}{{else}}tip{{end}}">{{if .Get 0}}{{.Get 0 | markdownify}}{{else}}Tip{{end}}</h2> --> + <!-- <h3>Tip</h3> --> + <div class="admonition-content">{{- .Inner -}}</div> +</aside> diff --git a/docs/layouts/shortcodes/todo.html b/docs/layouts/shortcodes/todo.html new file mode 100644 index 000000000..50a099267 --- /dev/null +++ b/docs/layouts/shortcodes/todo.html @@ -0,0 +1 @@ +{{ if .Inner }}{{ end }}
\ No newline at end of file diff --git a/docs/layouts/shortcodes/warning.html b/docs/layouts/shortcodes/warning.html new file mode 100644 index 000000000..d05057e59 --- /dev/null +++ b/docs/layouts/shortcodes/warning.html @@ -0,0 +1,8 @@ +<aside class="admonition warning"> + <div class="admonition-icon"> + {{partial "svg/exclamation.svg" .}} + </div> + <!-- <h2 id="{{if .Get 0}}{{.Get 0 | urlize}}{{else}}warning{{end}}">{{if .Get 0}}{{.Get 0 | markdownify}}{{else}}Warning{{end}}</h2> --> + <!-- <h3>Warning</h3> --> + <div class="admonition-content">{{- .Inner -}}</div> +</aside> diff --git a/docs/layouts/shortcodes/yt.html b/docs/layouts/shortcodes/yt.html new file mode 100644 index 000000000..6915cec5f --- /dev/null +++ b/docs/layouts/shortcodes/yt.html @@ -0,0 +1,11 @@ +<div class="video-wrapper" data-streaming="youtube" data-videoid="{{.Get "id"}}" > + <i class="icon-video-play-button shortcode"></i> + {{if (.Get "thumbnail")}} + <div style="background-image:url(/images/thumbnails/{{.Get "thumbnail"}})" alt="YouTube Thumbnail" class="video-thumbnail"></div> + {{else}} + <div style="background-image:url(//img.youtube.com/vi/{{.Get "id"}}/0.jpg)" alt="YouTube Thumbnail" class="video-thumbnail"></div> + {{end}} +</div> +{{ if (.Get "description") }} +<div class="video-description">{{ .Get "description" | markdownify }}</div> +{{ end }}
\ No newline at end of file |