544 lines
19 KiB
HTML
544 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" dir="ltr">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="description" content="Hugo uses the excellent Go html/template library for its template engine. It is an extremely lightweight engine that provides a very small amount of logic. In our experience that it is just the right amount of logic to be able to create a good static website. If you have used other template systems from different languages or frameworks you will find a lot of similarities in Go templates.
|
|
This document is a brief primer on using Go templates.">
|
|
<meta name="theme-color" content="#FFFFFF">
|
|
<meta name="color-scheme" content="light dark"><meta property="og:title" content="(Hu)go Template Primer" />
|
|
<meta property="og:description" content="Hugo uses the excellent Go html/template library for its template engine. It is an extremely lightweight engine that provides a very small amount of logic. In our experience that it is just the right amount of logic to be able to create a good static website. If you have used other template systems from different languages or frameworks you will find a lot of similarities in Go templates.
|
|
This document is a brief primer on using Go templates." />
|
|
<meta property="og:type" content="article" />
|
|
<meta property="og:url" content="https://blog.echosec.top/epic-awesome-gamer/posts/goisforlovers/" /><meta property="article:section" content="posts" />
|
|
<meta property="article:published_time" content="2014-04-02T00:00:00+00:00" />
|
|
<meta property="article:modified_time" content="2014-04-02T00:00:00+00:00" />
|
|
|
|
<title>(Hu)go Template Primer | Epic 免费人</title>
|
|
<link rel="manifest" href="/epic-awesome-gamer/manifest.json">
|
|
<link rel="icon" href="/epic-awesome-gamer/favicon.png" type="image/x-icon">
|
|
<link rel="stylesheet" href="/epic-awesome-gamer/book.min.31cccedbc2b6812eb37d0d37cdf4cb30cb89bd41421d3d51da624e11baccfe92.css" integrity="sha256-MczO28K2gS6zfQ03zfTLMMuJvUFCHT1R2mJOEbrM/pI=" crossorigin="anonymous">
|
|
<script defer src="/epic-awesome-gamer/flexsearch.min.js"></script>
|
|
<script defer src="/epic-awesome-gamer/en.search.min.29376e9f40a2395f81355c89199d51cebfa619adc77d7a286e33659b38c14e2e.js" integrity="sha256-KTdun0CiOV+BNVyJGZ1Rzr+mGa3HfXoobjNlmzjBTi4=" crossorigin="anonymous"></script>
|
|
|
|
<script defer src="/epic-awesome-gamer/sw.min.fce957f404884887d3e2471bff9b46e9879d096ba64fd4ac8f550d0dd48d105a.js" integrity="sha256-/OlX9ASISIfT4kcb/5tG6YedCWumT9Ssj1UNDdSNEFo=" crossorigin="anonymous"></script>
|
|
<!--
|
|
Made with Book Theme
|
|
https://github.com/alex-shpak/hugo-book
|
|
-->
|
|
|
|
</head>
|
|
<body dir="ltr">
|
|
<input type="checkbox" class="hidden toggle" id="menu-control" />
|
|
<input type="checkbox" class="hidden toggle" id="toc-control" />
|
|
<main class="container flex">
|
|
<aside class="book-menu">
|
|
<div class="book-menu-content">
|
|
|
|
<nav>
|
|
<h2 class="book-brand">
|
|
<a class="flex align-center" href="/epic-awesome-gamer/"><span>Epic 免费人</span>
|
|
</a>
|
|
</h2>
|
|
|
|
|
|
<div class="book-search">
|
|
<input type="text" id="book-search-input" placeholder="Search" aria-label="Search" maxlength="64" data-hotkeys="s/" />
|
|
<div class="book-search-spinner hidden"></div>
|
|
<ul id="book-search-results"></ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="book-languages">
|
|
<li>
|
|
<input type="checkbox" id="languages" class="toggle" />
|
|
<label for="languages" class="flex justify-between">
|
|
<a role="button" class="flex align-center">
|
|
<img src="/epic-awesome-gamer/svg/translate.svg" class="book-icon" alt="Languages" />
|
|
English
|
|
</a>
|
|
</label>
|
|
|
|
<ul>
|
|
|
|
<li>
|
|
<a href="https://blog.echosec.top/epic-awesome-gamer/zh/">
|
|
简体中文
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
<li>
|
|
<a href="https://blog.echosec.top" target="_blank" rel="noopener">
|
|
Blog
|
|
</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="https://github.com/QIN2DIM/epic-awesome-gamer/" target="_blank" rel="noopener">
|
|
GitHub
|
|
</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="https://github.com/QIN2DIM/epic-awesome-gamer/issues" target="_blank" rel="noopener">
|
|
Discussions
|
|
</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="https://t.me/joinchat/HlB9SQJubb5VmNU5" target="_blank" rel="noopener">
|
|
TG Studio
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<script>(function(){var a=document.querySelector("aside .book-menu-content");addEventListener("beforeunload",function(b){localStorage.setItem("menu.scrollTop",a.scrollTop)}),a.scrollTop=localStorage.getItem("menu.scrollTop")})()</script>
|
|
|
|
|
|
|
|
</div>
|
|
</aside>
|
|
|
|
<div class="book-page">
|
|
<header class="book-header">
|
|
|
|
<div class="flex align-center justify-between">
|
|
<label for="menu-control">
|
|
<img src="/epic-awesome-gamer/svg/menu.svg" class="book-icon" alt="Menu" />
|
|
</label>
|
|
|
|
<strong>(Hu)go Template Primer</strong>
|
|
|
|
<label for="toc-control">
|
|
|
|
</label>
|
|
</div>
|
|
<link rel="stylesheet" href="//cdn.bootcss.com/font-awesome/4.3.0/css/font-awesome.min.css">
|
|
|
|
|
|
|
|
</header>
|
|
|
|
|
|
|
|
<article class="markdown">
|
|
<h1>
|
|
<a href="/epic-awesome-gamer/posts/goisforlovers/">(Hu)go Template Primer</a>
|
|
</h1>
|
|
|
|
<h5>April 2, 2014</h5>
|
|
|
|
|
|
|
|
|
|
<div>
|
|
|
|
<a href="/epic-awesome-gamer/categories/Development/">Development</a>,
|
|
<a href="/epic-awesome-gamer/categories/golang/">golang</a>
|
|
</div>
|
|
|
|
|
|
|
|
<div>
|
|
|
|
<a href="/epic-awesome-gamer/tags/go/">go</a>,
|
|
<a href="/epic-awesome-gamer/tags/golang/">golang</a>,
|
|
<a href="/epic-awesome-gamer/tags/templates/">templates</a>,
|
|
<a href="/epic-awesome-gamer/tags/themes/">themes</a>,
|
|
<a href="/epic-awesome-gamer/tags/development/">development</a>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<p>Hugo uses the excellent
|
|
<a href="https://golang.org/">Go</a>
|
|
<a href="https://golang.org/pkg/html/template/">html/template</a> library for
|
|
its template engine. It is an extremely lightweight engine that provides a very
|
|
small amount of logic. In our experience that it is just the right amount of
|
|
logic to be able to create a good static website. If you have used other
|
|
template systems from different languages or frameworks you will find a lot of
|
|
similarities in Go templates.</p>
|
|
<p>This document is a brief primer on using Go templates. The
|
|
<a href="https://golang.org/pkg/html/template/">Go docs</a>
|
|
provide more details.</p>
|
|
<h2 id="introduction-to-go-templates">
|
|
Introduction to Go Templates
|
|
<a class="anchor" href="#introduction-to-go-templates">#</a>
|
|
</h2>
|
|
<p>Go templates provide an extremely simple template language. It adheres to the
|
|
belief that only the most basic of logic belongs in the template or view layer.
|
|
One consequence of this simplicity is that Go templates parse very quickly.</p>
|
|
<p>A unique characteristic of Go templates is they are content aware. Variables and
|
|
content will be sanitized depending on the context of where they are used. More
|
|
details can be found in the
|
|
<a href="https://golang.org/pkg/html/template/">Go docs</a>.</p>
|
|
<h2 id="basic-syntax">
|
|
Basic Syntax
|
|
<a class="anchor" href="#basic-syntax">#</a>
|
|
</h2>
|
|
<p>Golang templates are HTML files with the addition of variables and
|
|
functions.</p>
|
|
<p><strong>Go variables and functions are accessible within {{ }}</strong></p>
|
|
<p>Accessing a predefined variable “foo”:</p>
|
|
<pre><code>{{ foo }}
|
|
</code></pre>
|
|
<p><strong>Parameters are separated using spaces</strong></p>
|
|
<p>Calling the add function with input of 1, 2:</p>
|
|
<pre><code>{{ add 1 2 }}
|
|
</code></pre>
|
|
<p><strong>Methods and fields are accessed via dot notation</strong></p>
|
|
<p>Accessing the Page Parameter “bar”</p>
|
|
<pre><code>{{ .Params.bar }}
|
|
</code></pre>
|
|
<p><strong>Parentheses can be used to group items together</strong></p>
|
|
<pre><code>{{ if or (isset .Params "alt") (isset .Params "caption") }} Caption {{ end }}
|
|
</code></pre>
|
|
<h2 id="variables">
|
|
Variables
|
|
<a class="anchor" href="#variables">#</a>
|
|
</h2>
|
|
<p>Each Go template has a struct (object) made available to it. In hugo each
|
|
template is passed either a page or a node struct depending on which type of
|
|
page you are rendering. More details are available on the
|
|
|
|
<a href="/layout/variables">variables</a> page.</p>
|
|
<p>A variable is accessed by referencing the variable name.</p>
|
|
<pre><code><title>{{ .Title }}</title>
|
|
</code></pre>
|
|
<p>Variables can also be defined and referenced.</p>
|
|
<pre><code>{{ $address := "123 Main St."}}
|
|
{{ $address }}
|
|
</code></pre>
|
|
<h2 id="functions">
|
|
Functions
|
|
<a class="anchor" href="#functions">#</a>
|
|
</h2>
|
|
<p>Go template ship with a few functions which provide basic functionality. The Go
|
|
template system also provides a mechanism for applications to extend the
|
|
available functions with their own.
|
|
<a href="/layout/functions">Hugo template
|
|
functions</a> provide some additional functionality we believe
|
|
are useful for building websites. Functions are called by using their name
|
|
followed by the required parameters separated by spaces. Template
|
|
functions cannot be added without recompiling hugo.</p>
|
|
<p><strong>Example:</strong></p>
|
|
<pre><code>{{ add 1 2 }}
|
|
</code></pre>
|
|
<h2 id="includes">
|
|
Includes
|
|
<a class="anchor" href="#includes">#</a>
|
|
</h2>
|
|
<p>When including another template you will pass to it the data it will be
|
|
able to access. To pass along the current context please remember to
|
|
include a trailing dot. The templates location will always be starting at
|
|
the /layout/ directory within Hugo.</p>
|
|
<p><strong>Example:</strong></p>
|
|
<pre><code>{{ template "chrome/header.html" . }}
|
|
</code></pre>
|
|
<h2 id="logic">
|
|
Logic
|
|
<a class="anchor" href="#logic">#</a>
|
|
</h2>
|
|
<p>Go templates provide the most basic iteration and conditional logic.</p>
|
|
<h3 id="iteration">
|
|
Iteration
|
|
<a class="anchor" href="#iteration">#</a>
|
|
</h3>
|
|
<p>Just like in Go, the Go templates make heavy use of range to iterate over
|
|
a map, array or slice. The following are different examples of how to use
|
|
range.</p>
|
|
<p><strong>Example 1: Using Context</strong></p>
|
|
<pre><code>{{ range array }}
|
|
{{ . }}
|
|
{{ end }}
|
|
</code></pre>
|
|
<p><strong>Example 2: Declaring value variable name</strong></p>
|
|
<pre><code>{{range $element := array}}
|
|
{{ $element }}
|
|
{{ end }}
|
|
</code></pre>
|
|
<p><strong>Example 2: Declaring key and value variable name</strong></p>
|
|
<pre><code>{{range $index, $element := array}}
|
|
{{ $index }}
|
|
{{ $element }}
|
|
{{ end }}
|
|
</code></pre>
|
|
<h3 id="conditionals">
|
|
Conditionals
|
|
<a class="anchor" href="#conditionals">#</a>
|
|
</h3>
|
|
<p>If, else, with, or, & and provide the framework for handling conditional
|
|
logic in Go Templates. Like range, each statement is closed with <code>end</code>.</p>
|
|
<p>Go Templates treat the following values as false:</p>
|
|
<ul>
|
|
<li>false</li>
|
|
<li>0</li>
|
|
<li>any array, slice, map, or string of length zero</li>
|
|
</ul>
|
|
<p><strong>Example 1: If</strong></p>
|
|
<pre><code>{{ if isset .Params "title" }}<h4>{{ index .Params "title" }}</h4>{{ end }}
|
|
</code></pre>
|
|
<p><strong>Example 2: If -> Else</strong></p>
|
|
<pre><code>{{ if isset .Params "alt" }}
|
|
{{ index .Params "alt" }}
|
|
{{else}}
|
|
{{ index .Params "caption" }}
|
|
{{ end }}
|
|
</code></pre>
|
|
<p><strong>Example 3: And & Or</strong></p>
|
|
<pre><code>{{ if and (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}}
|
|
</code></pre>
|
|
<p><strong>Example 4: With</strong></p>
|
|
<p>An alternative way of writing “if” and then referencing the same value
|
|
is to use “with” instead. With rebinds the context <code>.</code> within its scope,
|
|
and skips the block if the variable is absent.</p>
|
|
<p>The first example above could be simplified as:</p>
|
|
<pre><code>{{ with .Params.title }}<h4>{{ . }}</h4>{{ end }}
|
|
</code></pre>
|
|
<p><strong>Example 5: If -> Else If</strong></p>
|
|
<pre><code>{{ if isset .Params "alt" }}
|
|
{{ index .Params "alt" }}
|
|
{{ else if isset .Params "caption" }}
|
|
{{ index .Params "caption" }}
|
|
{{ end }}
|
|
</code></pre>
|
|
<h2 id="pipes">
|
|
Pipes
|
|
<a class="anchor" href="#pipes">#</a>
|
|
</h2>
|
|
<p>One of the most powerful components of Go templates is the ability to
|
|
stack actions one after another. This is done by using pipes. Borrowed
|
|
from unix pipes, the concept is simple, each pipeline’s output becomes the
|
|
input of the following pipe.</p>
|
|
<p>Because of the very simple syntax of Go templates, the pipe is essential
|
|
to being able to chain together function calls. One limitation of the
|
|
pipes is that they only can work with a single value and that value
|
|
becomes the last parameter of the next pipeline.</p>
|
|
<p>A few simple examples should help convey how to use the pipe.</p>
|
|
<p><strong>Example 1 :</strong></p>
|
|
<pre><code>{{ if eq 1 1 }} Same {{ end }}
|
|
</code></pre>
|
|
<p>is the same as</p>
|
|
<pre><code>{{ eq 1 1 | if }} Same {{ end }}
|
|
</code></pre>
|
|
<p>It does look odd to place the if at the end, but it does provide a good
|
|
illustration of how to use the pipes.</p>
|
|
<p><strong>Example 2 :</strong></p>
|
|
<pre><code>{{ index .Params "disqus_url" | html }}
|
|
</code></pre>
|
|
<p>Access the page parameter called “disqus_url” and escape the HTML.</p>
|
|
<p><strong>Example 3 :</strong></p>
|
|
<pre><code>{{ if or (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}}
|
|
Stuff Here
|
|
{{ end }}
|
|
</code></pre>
|
|
<p>Could be rewritten as</p>
|
|
<pre><code>{{ isset .Params "caption" | or isset .Params "title" | or isset .Params "attr" | if }}
|
|
Stuff Here
|
|
{{ end }}
|
|
</code></pre>
|
|
<h2 id="context-aka-the-dot">
|
|
Context (aka. the dot)
|
|
<a class="anchor" href="#context-aka-the-dot">#</a>
|
|
</h2>
|
|
<p>The most easily overlooked concept to understand about Go templates is that {{ . }}
|
|
always refers to the current context. In the top level of your template this
|
|
will be the data set made available to it. Inside of a iteration it will have
|
|
the value of the current item. When inside of a loop the context has changed. .
|
|
will no longer refer to the data available to the entire page. If you need to
|
|
access this from within the loop you will likely want to set it to a variable
|
|
instead of depending on the context.</p>
|
|
<p><strong>Example:</strong></p>
|
|
<pre><code> {{ $title := .Site.Title }}
|
|
{{ range .Params.tags }}
|
|
<li> <a href="{{ $baseurl }}/tags/{{ . | urlize }}">{{ . }}</a> - {{ $title }} </li>
|
|
{{ end }}
|
|
</code></pre>
|
|
<p>Notice how once we have entered the loop the value of {{ . }} has changed. We
|
|
have defined a variable outside of the loop so we have access to it from within
|
|
the loop.</p>
|
|
<h1 id="hugo-parameters">
|
|
Hugo Parameters
|
|
<a class="anchor" href="#hugo-parameters">#</a>
|
|
</h1>
|
|
<p>Hugo provides the option of passing values to the template language
|
|
through the site configuration (for sitewide values), or through the meta
|
|
data of each specific piece of content. You can define any values of any
|
|
type (supported by your front matter/config format) and use them however
|
|
you want to inside of your templates.</p>
|
|
<h2 id="using-content-page-parameters">
|
|
Using Content (page) Parameters
|
|
<a class="anchor" href="#using-content-page-parameters">#</a>
|
|
</h2>
|
|
<p>In each piece of content you can provide variables to be used by the
|
|
templates. This happens in the
|
|
<a href="/content/front-matter">front matter</a>.</p>
|
|
<p>An example of this is used in this documentation site. Most of the pages
|
|
benefit from having the table of contents provided. Sometimes the TOC just
|
|
doesn’t make a lot of sense. We’ve defined a variable in our front matter
|
|
of some pages to turn off the TOC from being displayed.</p>
|
|
<p>Here is the example front matter:</p>
|
|
<pre tabindex="0"><code>---
|
|
title: "Permalinks"
|
|
date: "2013-11-18"
|
|
aliases:
|
|
- "/doc/permalinks/"
|
|
groups: ["extras"]
|
|
groups_weight: 30
|
|
notoc: true
|
|
---
|
|
</code></pre><p>Here is the corresponding code inside of the template:</p>
|
|
<pre><code> {{ if not .Params.notoc }}
|
|
<div id="toc" class="well col-md-4 col-sm-6">
|
|
{{ .TableOfContents }}
|
|
</div>
|
|
{{ end }}
|
|
</code></pre>
|
|
<h2 id="using-site-config-parameters">
|
|
Using Site (config) Parameters
|
|
<a class="anchor" href="#using-site-config-parameters">#</a>
|
|
</h2>
|
|
<p>In your top-level configuration file (eg, <code>config.yaml</code>) you can define site
|
|
parameters, which are values which will be available to you in chrome.</p>
|
|
<p>For instance, you might declare:</p>
|
|
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="color:#f92672">params</span>:
|
|
<span style="color:#f92672">CopyrightHTML</span>: <span style="color:#e6db74">"Copyright &#xA9; 2013 John Doe. All Rights Reserved."</span>
|
|
<span style="color:#f92672">TwitterUser</span>: <span style="color:#e6db74">"spf13"</span>
|
|
<span style="color:#f92672">SidebarRecentLimit</span>: <span style="color:#ae81ff">5</span>
|
|
</code></pre></div><p>Within a footer layout, you might then declare a <code><footer></code> which is only
|
|
provided if the <code>CopyrightHTML</code> parameter is provided, and if it is given,
|
|
you would declare it to be HTML-safe, so that the HTML entity is not escaped
|
|
again. This would let you easily update just your top-level config file each
|
|
January 1st, instead of hunting through your templates.</p>
|
|
<pre tabindex="0"><code>{{if .Site.Params.CopyrightHTML}}<footer>
|
|
<div class="text-center">{{.Site.Params.CopyrightHTML | safeHtml}}</div>
|
|
</footer>{{end}}
|
|
</code></pre><p>An alternative way of writing the “if” and then referencing the same value
|
|
is to use “with” instead. With rebinds the context <code>.</code> within its scope,
|
|
and skips the block if the variable is absent:</p>
|
|
<pre tabindex="0"><code>{{with .Site.Params.TwitterUser}}<span class="twitter">
|
|
<a href="https://twitter.com/{{.}}" rel="author">
|
|
<img src="/images/twitter.png" width="48" height="48" title="Twitter: {{.}}"
|
|
alt="Twitter"></a>
|
|
</span>{{end}}
|
|
</code></pre><p>Finally, if you want to pull “magic constants” out of your layouts, you can do
|
|
so, such as in this example:</p>
|
|
<pre tabindex="0"><code><nav class="recent">
|
|
<h1>Recent Posts</h1>
|
|
<ul>{{range first .Site.Params.SidebarRecentLimit .Site.Recent}}
|
|
<li><a href="{{.RelPermalink}}">{{.Title}}</a></li>
|
|
{{end}}</ul>
|
|
</nav>
|
|
</code></pre></article>
|
|
|
|
|
|
|
|
<footer class="book-footer">
|
|
|
|
<div class="flex flex-wrap justify-between">
|
|
|
|
|
|
|
|
|
|
<div>
|
|
<a class="flex align-center" href="https://github.com/qin2dim/v2rss-docs/tree/main/content/posts/goisforlovers.md" target="_blank" rel="noopener">
|
|
<img src="/epic-awesome-gamer/svg/edit.svg" class="book-icon" alt="Edit" />
|
|
<span>Edit this page</span>
|
|
</a>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<script>(function(){function a(c){const a=window.getSelection(),b=document.createRange();b.selectNodeContents(c),a.removeAllRanges(),a.addRange(b)}document.querySelectorAll("pre code").forEach(b=>{b.addEventListener("click",function(c){a(b.parentElement),navigator.clipboard&&navigator.clipboard.writeText(b.parentElement.textContent)})})})()</script>
|
|
|
|
|
|
|
|
|
|
</footer>
|
|
|
|
|
|
|
|
<div class="book-comments">
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<label for="menu-control" class="hidden book-menu-overlay"></label>
|
|
</div>
|
|
|
|
|
|
</main>
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|