summaryrefslogtreecommitdiffstats
path: root/docs/layouts/shortcodes
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2019-10-21 10:22:28 +0200
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2019-10-21 10:22:28 +0200
commit27aef3f1fbf657137e825f30bb50dda393618a6f (patch)
treebcc05254f2977e3cc75d7dcb4cbaac5625cf7a1b /docs/layouts/shortcodes
parent39121de4d991bdcf5f202da4d8d81a8ac6c149fc (diff)
parentb9bd35d72e14932fb6588ff62b90cddef0a060fc (diff)
Diffstat (limited to 'docs/layouts/shortcodes')
-rw-r--r--docs/layouts/shortcodes/asciicast.html2
-rw-r--r--docs/layouts/shortcodes/chroma-lexers.html6
-rw-r--r--docs/layouts/shortcodes/code.html25
-rw-r--r--docs/layouts/shortcodes/datatable-filtered.html28
-rw-r--r--docs/layouts/shortcodes/datatable.html22
-rw-r--r--docs/layouts/shortcodes/directoryindex.html13
-rw-r--r--docs/layouts/shortcodes/docfile.html11
-rw-r--r--docs/layouts/shortcodes/exfile.html12
-rw-r--r--docs/layouts/shortcodes/exfm.html13
-rw-r--r--docs/layouts/shortcodes/funcsig.html4
-rw-r--r--docs/layouts/shortcodes/gh.html9
-rw-r--r--docs/layouts/shortcodes/ghrepo.html1
-rw-r--r--docs/layouts/shortcodes/gomodules-info.html17
-rw-r--r--docs/layouts/shortcodes/imgproc.html25
-rw-r--r--docs/layouts/shortcodes/module-mounts-note.html1
-rw-r--r--docs/layouts/shortcodes/nohighlight.html1
-rw-r--r--docs/layouts/shortcodes/note.html9
-rw-r--r--docs/layouts/shortcodes/output.html8
-rw-r--r--docs/layouts/shortcodes/readfile.html8
-rw-r--r--docs/layouts/shortcodes/tip.html9
-rw-r--r--docs/layouts/shortcodes/todo.html1
-rw-r--r--docs/layouts/shortcodes/warning.html9
-rw-r--r--docs/layouts/shortcodes/yt.html11
23 files changed, 245 insertions, 0 deletions
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/chroma-lexers.html b/docs/layouts/shortcodes/chroma-lexers.html
new file mode 100644
index 000000000..0df2b868f
--- /dev/null
+++ b/docs/layouts/shortcodes/chroma-lexers.html
@@ -0,0 +1,6 @@
+<dl>
+{{ range .Site.Data.docs.chroma.lexers }}
+<dt>{{ .Name }}</dt>
+<dd>{{ delimit .Aliases ", " }}</dd>
+{{ end }}
+</dl> \ No newline at end of file
diff --git a/docs/layouts/shortcodes/code.html b/docs/layouts/shortcodes/code.html
new file mode 100644
index 000000000..eafc02e6b
--- /dev/null
+++ b/docs/layouts/shortcodes/code.html
@@ -0,0 +1,25 @@
+{{ $file := .Get "file" }}
+{{ $codeLang := "" }}
+{{ $suffix := findRE "(\\.[^.]+)$" $file 1 }}
+{{ with $suffix }}
+{{ $codeLang = (index . 0 | strings.TrimPrefix ".") }}
+{{ end }}
+{{ with .Get "codeLang" }}{{ $codeLang = . }}{{ end }}
+{{ if eq $codeLang "html"}}
+{{ $codeLang = "go-html-template" }}
+{{ 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 $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/funcsig.html b/docs/layouts/shortcodes/funcsig.html
new file mode 100644
index 000000000..1709c60b0
--- /dev/null
+++ b/docs/layouts/shortcodes/funcsig.html
@@ -0,0 +1,4 @@
+<h4 class="minor mb1 pt2 primary-color-dark">Syntax</h4>
+<pre class="f5 mb4 ph3 pv2 bg-light-gray" style="border-left:4px solid #0594CB;">
+ {{- .Inner -}}
+</pre> \ 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/gomodules-info.html b/docs/layouts/shortcodes/gomodules-info.html
new file mode 100644
index 000000000..3c9d486ae
--- /dev/null
+++ b/docs/layouts/shortcodes/gomodules-info.html
@@ -0,0 +1,17 @@
+{{ $text := `
+Most of the commands for **Hugo Modules** requires a newer version of Go installed (see https://golang.org/dl/) and the relevant VCS client (e.g. Git, see https://git-scm.com/downloads). If you have an "older" site running on Netlify, you may have to set GO_VERSION to 1.12 in your Environment settings.
+
+For more information about Go Modules, see:
+
+* https://github.com/golang/go/wiki/Modules
+* https://blog.golang.org/using-go-modules
+` }}
+
+<aside class="admonition note">
+ <div class="note-icon">
+ {{partial "svg/exclamation.svg" (dict "size" "20px" ) }}
+ </div>
+ <div class="admonition-content">
+ {{- $text | markdownify -}}
+ </div>
+</aside>
diff --git a/docs/layouts/shortcodes/imgproc.html b/docs/layouts/shortcodes/imgproc.html
new file mode 100644
index 000000000..5e02317c6
--- /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="padding: 0.25rem; margin: 2rem 0; background-color: #cccc">
+ <img style="max-width: 100%; width: auto; height: auto;" 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/module-mounts-note.html b/docs/layouts/shortcodes/module-mounts-note.html
new file mode 100644
index 000000000..654aafef4
--- /dev/null
+++ b/docs/layouts/shortcodes/module-mounts-note.html
@@ -0,0 +1 @@
+Also see [Module Mounts Config](/hugo-modules/configuration/#module-config-mounts) for an alternative way to configure this directory (from Hugo 0.56). \ 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..24d2cd0b2
--- /dev/null
+++ b/docs/layouts/shortcodes/note.html
@@ -0,0 +1,9 @@
+{{ $_hugo_config := `{ "version": 1 }` }}
+<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..139e3376b
--- /dev/null
+++ b/docs/layouts/shortcodes/tip.html
@@ -0,0 +1,9 @@
+{{ $_hugo_config := `{ "version": 1 }` }}
+<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..c9147be64
--- /dev/null
+++ b/docs/layouts/shortcodes/warning.html
@@ -0,0 +1,9 @@
+{{ $_hugo_config := `{ "version": 1 }` }}
+<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