diff options
Diffstat (limited to 'exampleSite/public/tags')
22 files changed, 3384 insertions, 0 deletions
diff --git a/exampleSite/public/tags/development/index.html b/exampleSite/public/tags/development/index.html new file mode 100644 index 0000000..7192d3f --- /dev/null +++ b/exampleSite/public/tags/development/index.html @@ -0,0 +1,545 @@ +<!DOCTYPE html> +<html > +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="generator" content="Hugo 0.53" /> + + <title>Development - A Hugo Theme built with Bootstrap</title> + + + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto"> + <link href="https://gohugo.io//css/bootstrap.min.css" rel="stylesheet"> + <link href="https://gohugo.io//css/strange-case.css" rel="stylesheet"> + + + + + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> + <![endif]--> +</head> +<body class="scheme-darkbrown"> + + <div class="container-fluid"> + <div class="row"> + <div class="col-sm-4 col-md-3 col-lg-3 sidebar"> + + + <div class="sidebar-content"> + + <a href="https://gohugo.io/"><h1>Hugo Themes</h1></a> + <p>A Hugo Theme built with Bootstrap</p> + + + <div class="sidebar-freetext"> + <p>A optional paragraph of free text. Set to blank in config.toml to clear...</p> + </div> + + + <ul class="sidebar-menus"> + + <li>» <a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a> </li> + + <li>» <a href="https://gohugo.io/about/">About Hugo</a> </li> + + <li>» <a href="http://getbootstrap.com">Bootstrap</a> <span class='glyphicon glyphicon-ok'></span></li> + + <li>» <a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a> </li> + + <li>» <a href="http://gohugo.io">Hugo</a> <span class='glyphicon glyphicon-fire'></span></li> + + <li>» <a href="">tutorials</a> </li> + + </ul> + + <div class="sidebar-recent hidden-xs"> + <p>Recent Posts:</p> + <ul> + + <li><a href="https://gohugo.io/post/creating-a-new-theme/">Creating a New Theme</a></li> + + <li><a href="https://gohugo.io/post/migrate-from-jekyll/">Migrate to Hugo from Jekyll</a></li> + + <li><a href="https://gohugo.io/about/">About Hugo</a></li> + + <li><a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a></li> + + <li><a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a></li> + + </ul> + </div> + + <p class="copyright">© 2019. All rights reserved. </p> + <p class="attr">Powered by <a href="http://gohugo.io">Hugo</a> & <a href="https://github.com/ExchangeRate-API/strange-case">Strange Case</a> (inspired by <a href="https://github.com/poole/hyde">Hyde</a>).</p> + + </div> + + + </div> + <div class="col-sm-7 col-sm-offset-4 col-md-6 col-md-offset-3 col-lg-5 col-lg-offset-3 content"> + + + <div class="post"> + + <div class="post-heading"> + <h1><a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a></h1> + <span>Apr 2, 2014</span> + </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</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</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</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="https://gohugo.io/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</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="https://gohugo.io/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</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</h2> + +<p>Go templates provide the most basic iteration and conditional logic.</p> + +<h3 id="iteration">Iteration</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</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</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)</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</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</h2> + +<p>In each piece of content you can provide variables to be used by the +templates. This happens in the <a href="https://gohugo.io/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><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</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> + +<pre><code class="language-yaml">params: + CopyrightHTML: "Copyright &#xA9; 2013 John Doe. All Rights Reserved." + TwitterUser: "spf13" + SidebarRecentLimit: 5 +</code></pre> + +<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><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><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><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> + + + </div> + + <div class="post"> + + <div class="post-heading"> + <h1><a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a></h1> + <span>Apr 2, 2014</span> + </div> + + + +<h2 id="step-1-install-hugo">Step 1. Install Hugo</h2> + +<p>Go to <a href="https://github.com/spf13/hugo/releases">Hugo releases</a> and download the +appropriate version for your OS and architecture.</p> + +<p>Save it somewhere specific as we will be using it in the next step.</p> + +<p>More complete instructions are available at <a href="https://gohugo.io/getting-started/installing/">Install Hugo</a></p> + +<h2 id="step-2-build-the-docs">Step 2. Build the Docs</h2> + +<p>Hugo has its own example site which happens to also be the documentation site +you are reading right now.</p> + +<p>Follow the following steps:</p> + +<ol> +<li>Clone the <a href="http://github.com/spf13/hugo">Hugo repository</a></li> +<li>Go into the repo</li> +<li>Run hugo in server mode and build the docs</li> +<li>Open your browser to <a href="http://localhost:1313">http://localhost:1313</a></li> +</ol> + +<p>Corresponding pseudo commands:</p> + +<pre><code>git clone https://github.com/spf13/hugo +cd hugo +/path/to/where/you/installed/hugo server --source=./docs +> 29 pages created +> 0 tags index created +> in 27 ms +> Web Server is available at http://localhost:1313 +> Press ctrl+c to stop +</code></pre> + +<p>Once you’ve gotten here, follow along the rest of this page on your local build.</p> + +<h2 id="step-3-change-the-docs-site">Step 3. Change the docs site</h2> + +<p>Stop the Hugo process by hitting Ctrl+C.</p> + +<p>Now we are going to run hugo again, but this time with hugo in watch mode.</p> + +<pre><code>/path/to/hugo/from/step/1/hugo server --source=./docs --watch +> 29 pages created +> 0 tags index created +> in 27 ms +> Web Server is available at http://localhost:1313 +> Watching for changes in /Users/spf13/Code/hugo/docs/content +> Press ctrl+c to stop +</code></pre> + +<p>Open your <a href="http://vim.spf13.com">favorite editor</a> and change one of the source +content pages. How about changing this very file to <em>fix the typo</em>. How about changing this very file to <em>fix the typo</em>.</p> + +<p>Content files are found in <code>docs/content/</code>. Unless otherwise specified, files +are located at the same relative location as the url, in our case +<code>docs/content/overview/quickstart.md</code>.</p> + +<p>Change and save this file.. Notice what happened in your terminal.</p> + +<pre><code>> Change detected, rebuilding site + +> 29 pages created +> 0 tags index created +> in 26 ms +</code></pre> + +<p>Refresh the browser and observe that the typo is now fixed.</p> + +<p>Notice how quick that was. Try to refresh the site before it’s finished building. I double dare you. +Having nearly instant feedback enables you to have your creativity flow without waiting for long builds.</p> + +<h2 id="step-4-have-fun">Step 4. Have fun</h2> + +<p>The best way to learn something is to play with it.</p> + + + </div> + + + <div class="text-center"> + + + </div> + + </div> + <div class="col-sm-1 col-md-3 col-md-4"> + </div> + </div> + </div> + + + + + + + +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script> + +<script src="https://gohugo.io//js/bootstrap.min.js"></script> + +</body> +</html>
\ No newline at end of file diff --git a/exampleSite/public/tags/development/index.xml b/exampleSite/public/tags/development/index.xml new file mode 100644 index 0000000..f95cae8 --- /dev/null +++ b/exampleSite/public/tags/development/index.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="utf-8" standalone="yes" ?> +<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> + <channel> + <title>Development on Hugo Themes</title> + <link>https://gohugo.io/tags/development/</link> + <description>Recent content in Development on Hugo Themes</description> + <generator>Hugo -- gohugo.io</generator> + <copyright>Copyright (c) 2008 - 2014, Steve Francia; all rights reserved.</copyright> + <lastBuildDate>Wed, 02 Apr 2014 00:00:00 +0000</lastBuildDate> + + <atom:link href="https://gohugo.io/tags/development/index.xml" rel="self" type="application/rss+xml" /> + + + <item> + <title>(Hu)go Template Primer</title> + <link>https://gohugo.io/post/goisforlovers/</link> + <pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate> + + <guid>https://gohugo.io/post/goisforlovers/</guid> + <description>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.</description> + </item> + + <item> + <title>Getting Started with Hugo</title> + <link>https://gohugo.io/post/hugoisforlovers/</link> + <pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate> + + <guid>https://gohugo.io/post/hugoisforlovers/</guid> + <description>Step 1. Install Hugo Go to Hugo releases and download the appropriate version for your OS and architecture. +Save it somewhere specific as we will be using it in the next step. +More complete instructions are available at Install Hugo +Step 2. Build the Docs Hugo has its own example site which happens to also be the documentation site you are reading right now. +Follow the following steps: + Clone the Hugo repository Go into the repo Run hugo in server mode and build the docs Open your browser to http://localhost:1313 Corresponding pseudo commands:</description> + </item> + + </channel> +</rss>
\ No newline at end of file diff --git a/exampleSite/public/tags/development/page/1/index.html b/exampleSite/public/tags/development/page/1/index.html new file mode 100644 index 0000000..53769d3 --- /dev/null +++ b/exampleSite/public/tags/development/page/1/index.html @@ -0,0 +1 @@ +<!DOCTYPE html><html><head><title>https://gohugo.io/tags/development/</title><link rel="canonical" href="https://gohugo.io/tags/development/"/><meta name="robots" content="noindex"><meta charset="utf-8" /><meta http-equiv="refresh" content="0; url=https://gohugo.io/tags/development/" /></head></html>
\ No newline at end of file diff --git a/exampleSite/public/tags/go/index.html b/exampleSite/public/tags/go/index.html new file mode 100644 index 0000000..c9b7cab --- /dev/null +++ b/exampleSite/public/tags/go/index.html @@ -0,0 +1,545 @@ +<!DOCTYPE html> +<html > +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="generator" content="Hugo 0.53" /> + + <title>Go - A Hugo Theme built with Bootstrap</title> + + + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto"> + <link href="https://gohugo.io//css/bootstrap.min.css" rel="stylesheet"> + <link href="https://gohugo.io//css/strange-case.css" rel="stylesheet"> + + + + + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> + <![endif]--> +</head> +<body class="scheme-darkbrown"> + + <div class="container-fluid"> + <div class="row"> + <div class="col-sm-4 col-md-3 col-lg-3 sidebar"> + + + <div class="sidebar-content"> + + <a href="https://gohugo.io/"><h1>Hugo Themes</h1></a> + <p>A Hugo Theme built with Bootstrap</p> + + + <div class="sidebar-freetext"> + <p>A optional paragraph of free text. Set to blank in config.toml to clear...</p> + </div> + + + <ul class="sidebar-menus"> + + <li>» <a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a> </li> + + <li>» <a href="https://gohugo.io/about/">About Hugo</a> </li> + + <li>» <a href="http://getbootstrap.com">Bootstrap</a> <span class='glyphicon glyphicon-ok'></span></li> + + <li>» <a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a> </li> + + <li>» <a href="http://gohugo.io">Hugo</a> <span class='glyphicon glyphicon-fire'></span></li> + + <li>» <a href="">tutorials</a> </li> + + </ul> + + <div class="sidebar-recent hidden-xs"> + <p>Recent Posts:</p> + <ul> + + <li><a href="https://gohugo.io/post/creating-a-new-theme/">Creating a New Theme</a></li> + + <li><a href="https://gohugo.io/post/migrate-from-jekyll/">Migrate to Hugo from Jekyll</a></li> + + <li><a href="https://gohugo.io/about/">About Hugo</a></li> + + <li><a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a></li> + + <li><a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a></li> + + </ul> + </div> + + <p class="copyright">© 2019. All rights reserved. </p> + <p class="attr">Powered by <a href="http://gohugo.io">Hugo</a> & <a href="https://github.com/ExchangeRate-API/strange-case">Strange Case</a> (inspired by <a href="https://github.com/poole/hyde">Hyde</a>).</p> + + </div> + + + </div> + <div class="col-sm-7 col-sm-offset-4 col-md-6 col-md-offset-3 col-lg-5 col-lg-offset-3 content"> + + + <div class="post"> + + <div class="post-heading"> + <h1><a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a></h1> + <span>Apr 2, 2014</span> + </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</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</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</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="https://gohugo.io/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</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="https://gohugo.io/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</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</h2> + +<p>Go templates provide the most basic iteration and conditional logic.</p> + +<h3 id="iteration">Iteration</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</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</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)</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</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</h2> + +<p>In each piece of content you can provide variables to be used by the +templates. This happens in the <a href="https://gohugo.io/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><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</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> + +<pre><code class="language-yaml">params: + CopyrightHTML: "Copyright &#xA9; 2013 John Doe. All Rights Reserved." + TwitterUser: "spf13" + SidebarRecentLimit: 5 +</code></pre> + +<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><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><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><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> + + + </div> + + <div class="post"> + + <div class="post-heading"> + <h1><a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a></h1> + <span>Apr 2, 2014</span> + </div> + + + +<h2 id="step-1-install-hugo">Step 1. Install Hugo</h2> + +<p>Go to <a href="https://github.com/spf13/hugo/releases">Hugo releases</a> and download the +appropriate version for your OS and architecture.</p> + +<p>Save it somewhere specific as we will be using it in the next step.</p> + +<p>More complete instructions are available at <a href="https://gohugo.io/getting-started/installing/">Install Hugo</a></p> + +<h2 id="step-2-build-the-docs">Step 2. Build the Docs</h2> + +<p>Hugo has its own example site which happens to also be the documentation site +you are reading right now.</p> + +<p>Follow the following steps:</p> + +<ol> +<li>Clone the <a href="http://github.com/spf13/hugo">Hugo repository</a></li> +<li>Go into the repo</li> +<li>Run hugo in server mode and build the docs</li> +<li>Open your browser to <a href="http://localhost:1313">http://localhost:1313</a></li> +</ol> + +<p>Corresponding pseudo commands:</p> + +<pre><code>git clone https://github.com/spf13/hugo +cd hugo +/path/to/where/you/installed/hugo server --source=./docs +> 29 pages created +> 0 tags index created +> in 27 ms +> Web Server is available at http://localhost:1313 +> Press ctrl+c to stop +</code></pre> + +<p>Once you’ve gotten here, follow along the rest of this page on your local build.</p> + +<h2 id="step-3-change-the-docs-site">Step 3. Change the docs site</h2> + +<p>Stop the Hugo process by hitting Ctrl+C.</p> + +<p>Now we are going to run hugo again, but this time with hugo in watch mode.</p> + +<pre><code>/path/to/hugo/from/step/1/hugo server --source=./docs --watch +> 29 pages created +> 0 tags index created +> in 27 ms +> Web Server is available at http://localhost:1313 +> Watching for changes in /Users/spf13/Code/hugo/docs/content +> Press ctrl+c to stop +</code></pre> + +<p>Open your <a href="http://vim.spf13.com">favorite editor</a> and change one of the source +content pages. How about changing this very file to <em>fix the typo</em>. How about changing this very file to <em>fix the typo</em>.</p> + +<p>Content files are found in <code>docs/content/</code>. Unless otherwise specified, files +are located at the same relative location as the url, in our case +<code>docs/content/overview/quickstart.md</code>.</p> + +<p>Change and save this file.. Notice what happened in your terminal.</p> + +<pre><code>> Change detected, rebuilding site + +> 29 pages created +> 0 tags index created +> in 26 ms +</code></pre> + +<p>Refresh the browser and observe that the typo is now fixed.</p> + +<p>Notice how quick that was. Try to refresh the site before it’s finished building. I double dare you. +Having nearly instant feedback enables you to have your creativity flow without waiting for long builds.</p> + +<h2 id="step-4-have-fun">Step 4. Have fun</h2> + +<p>The best way to learn something is to play with it.</p> + + + </div> + + + <div class="text-center"> + + + </div> + + </div> + <div class="col-sm-1 col-md-3 col-md-4"> + </div> + </div> + </div> + + + + + + + +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script> + +<script src="https://gohugo.io//js/bootstrap.min.js"></script> + +</body> +</html>
\ No newline at end of file diff --git a/exampleSite/public/tags/go/index.xml b/exampleSite/public/tags/go/index.xml new file mode 100644 index 0000000..384320e --- /dev/null +++ b/exampleSite/public/tags/go/index.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="utf-8" standalone="yes" ?> +<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> + <channel> + <title>Go on Hugo Themes</title> + <link>https://gohugo.io/tags/go/</link> + <description>Recent content in Go on Hugo Themes</description> + <generator>Hugo -- gohugo.io</generator> + <copyright>Copyright (c) 2008 - 2014, Steve Francia; all rights reserved.</copyright> + <lastBuildDate>Wed, 02 Apr 2014 00:00:00 +0000</lastBuildDate> + + <atom:link href="https://gohugo.io/tags/go/index.xml" rel="self" type="application/rss+xml" /> + + + <item> + <title>(Hu)go Template Primer</title> + <link>https://gohugo.io/post/goisforlovers/</link> + <pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate> + + <guid>https://gohugo.io/post/goisforlovers/</guid> + <description>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.</description> + </item> + + <item> + <title>Getting Started with Hugo</title> + <link>https://gohugo.io/post/hugoisforlovers/</link> + <pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate> + + <guid>https://gohugo.io/post/hugoisforlovers/</guid> + <description>Step 1. Install Hugo Go to Hugo releases and download the appropriate version for your OS and architecture. +Save it somewhere specific as we will be using it in the next step. +More complete instructions are available at Install Hugo +Step 2. Build the Docs Hugo has its own example site which happens to also be the documentation site you are reading right now. +Follow the following steps: + Clone the Hugo repository Go into the repo Run hugo in server mode and build the docs Open your browser to http://localhost:1313 Corresponding pseudo commands:</description> + </item> + + </channel> +</rss>
\ No newline at end of file diff --git a/exampleSite/public/tags/go/page/1/index.html b/exampleSite/public/tags/go/page/1/index.html new file mode 100644 index 0000000..dc6df93 --- /dev/null +++ b/exampleSite/public/tags/go/page/1/index.html @@ -0,0 +1 @@ +<!DOCTYPE html><html><head><title>https://gohugo.io/tags/go/</title><link rel="canonical" href="https://gohugo.io/tags/go/"/><meta name="robots" content="noindex"><meta charset="utf-8" /><meta http-equiv="refresh" content="0; url=https://gohugo.io/tags/go/" /></head></html>
\ No newline at end of file diff --git a/exampleSite/public/tags/golang/index.html b/exampleSite/public/tags/golang/index.html new file mode 100644 index 0000000..6333ad5 --- /dev/null +++ b/exampleSite/public/tags/golang/index.html @@ -0,0 +1,545 @@ +<!DOCTYPE html> +<html > +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="generator" content="Hugo 0.53" /> + + <title>Golang - A Hugo Theme built with Bootstrap</title> + + + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto"> + <link href="https://gohugo.io//css/bootstrap.min.css" rel="stylesheet"> + <link href="https://gohugo.io//css/strange-case.css" rel="stylesheet"> + + + + + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> + <![endif]--> +</head> +<body class="scheme-darkbrown"> + + <div class="container-fluid"> + <div class="row"> + <div class="col-sm-4 col-md-3 col-lg-3 sidebar"> + + + <div class="sidebar-content"> + + <a href="https://gohugo.io/"><h1>Hugo Themes</h1></a> + <p>A Hugo Theme built with Bootstrap</p> + + + <div class="sidebar-freetext"> + <p>A optional paragraph of free text. Set to blank in config.toml to clear...</p> + </div> + + + <ul class="sidebar-menus"> + + <li>» <a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a> </li> + + <li>» <a href="https://gohugo.io/about/">About Hugo</a> </li> + + <li>» <a href="http://getbootstrap.com">Bootstrap</a> <span class='glyphicon glyphicon-ok'></span></li> + + <li>» <a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a> </li> + + <li>» <a href="http://gohugo.io">Hugo</a> <span class='glyphicon glyphicon-fire'></span></li> + + <li>» <a href="">tutorials</a> </li> + + </ul> + + <div class="sidebar-recent hidden-xs"> + <p>Recent Posts:</p> + <ul> + + <li><a href="https://gohugo.io/post/creating-a-new-theme/">Creating a New Theme</a></li> + + <li><a href="https://gohugo.io/post/migrate-from-jekyll/">Migrate to Hugo from Jekyll</a></li> + + <li><a href="https://gohugo.io/about/">About Hugo</a></li> + + <li><a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a></li> + + <li><a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a></li> + + </ul> + </div> + + <p class="copyright">© 2019. All rights reserved. </p> + <p class="attr">Powered by <a href="http://gohugo.io">Hugo</a> & <a href="https://github.com/ExchangeRate-API/strange-case">Strange Case</a> (inspired by <a href="https://github.com/poole/hyde">Hyde</a>).</p> + + </div> + + + </div> + <div class="col-sm-7 col-sm-offset-4 col-md-6 col-md-offset-3 col-lg-5 col-lg-offset-3 content"> + + + <div class="post"> + + <div class="post-heading"> + <h1><a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a></h1> + <span>Apr 2, 2014</span> + </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</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</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</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="https://gohugo.io/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</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="https://gohugo.io/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</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</h2> + +<p>Go templates provide the most basic iteration and conditional logic.</p> + +<h3 id="iteration">Iteration</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</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</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)</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</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</h2> + +<p>In each piece of content you can provide variables to be used by the +templates. This happens in the <a href="https://gohugo.io/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><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</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> + +<pre><code class="language-yaml">params: + CopyrightHTML: "Copyright &#xA9; 2013 John Doe. All Rights Reserved." + TwitterUser: "spf13" + SidebarRecentLimit: 5 +</code></pre> + +<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><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><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><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> + + + </div> + + <div class="post"> + + <div class="post-heading"> + <h1><a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a></h1> + <span>Apr 2, 2014</span> + </div> + + + +<h2 id="step-1-install-hugo">Step 1. Install Hugo</h2> + +<p>Go to <a href="https://github.com/spf13/hugo/releases">Hugo releases</a> and download the +appropriate version for your OS and architecture.</p> + +<p>Save it somewhere specific as we will be using it in the next step.</p> + +<p>More complete instructions are available at <a href="https://gohugo.io/getting-started/installing/">Install Hugo</a></p> + +<h2 id="step-2-build-the-docs">Step 2. Build the Docs</h2> + +<p>Hugo has its own example site which happens to also be the documentation site +you are reading right now.</p> + +<p>Follow the following steps:</p> + +<ol> +<li>Clone the <a href="http://github.com/spf13/hugo">Hugo repository</a></li> +<li>Go into the repo</li> +<li>Run hugo in server mode and build the docs</li> +<li>Open your browser to <a href="http://localhost:1313">http://localhost:1313</a></li> +</ol> + +<p>Corresponding pseudo commands:</p> + +<pre><code>git clone https://github.com/spf13/hugo +cd hugo +/path/to/where/you/installed/hugo server --source=./docs +> 29 pages created +> 0 tags index created +> in 27 ms +> Web Server is available at http://localhost:1313 +> Press ctrl+c to stop +</code></pre> + +<p>Once you’ve gotten here, follow along the rest of this page on your local build.</p> + +<h2 id="step-3-change-the-docs-site">Step 3. Change the docs site</h2> + +<p>Stop the Hugo process by hitting Ctrl+C.</p> + +<p>Now we are going to run hugo again, but this time with hugo in watch mode.</p> + +<pre><code>/path/to/hugo/from/step/1/hugo server --source=./docs --watch +> 29 pages created +> 0 tags index created +> in 27 ms +> Web Server is available at http://localhost:1313 +> Watching for changes in /Users/spf13/Code/hugo/docs/content +> Press ctrl+c to stop +</code></pre> + +<p>Open your <a href="http://vim.spf13.com">favorite editor</a> and change one of the source +content pages. How about changing this very file to <em>fix the typo</em>. How about changing this very file to <em>fix the typo</em>.</p> + +<p>Content files are found in <code>docs/content/</code>. Unless otherwise specified, files +are located at the same relative location as the url, in our case +<code>docs/content/overview/quickstart.md</code>.</p> + +<p>Change and save this file.. Notice what happened in your terminal.</p> + +<pre><code>> Change detected, rebuilding site + +> 29 pages created +> 0 tags index created +> in 26 ms +</code></pre> + +<p>Refresh the browser and observe that the typo is now fixed.</p> + +<p>Notice how quick that was. Try to refresh the site before it’s finished building. I double dare you. +Having nearly instant feedback enables you to have your creativity flow without waiting for long builds.</p> + +<h2 id="step-4-have-fun">Step 4. Have fun</h2> + +<p>The best way to learn something is to play with it.</p> + + + </div> + + + <div class="text-center"> + + + </div> + + </div> + <div class="col-sm-1 col-md-3 col-md-4"> + </div> + </div> + </div> + + + + + + + +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script> + +<script src="https://gohugo.io//js/bootstrap.min.js"></script> + +</body> +</html>
\ No newline at end of file diff --git a/exampleSite/public/tags/golang/index.xml b/exampleSite/public/tags/golang/index.xml new file mode 100644 index 0000000..a7194c9 --- /dev/null +++ b/exampleSite/public/tags/golang/index.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="utf-8" standalone="yes" ?> +<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> + <channel> + <title>Golang on Hugo Themes</title> + <link>https://gohugo.io/tags/golang/</link> + <description>Recent content in Golang on Hugo Themes</description> + <generator>Hugo -- gohugo.io</generator> + <copyright>Copyright (c) 2008 - 2014, Steve Francia; all rights reserved.</copyright> + <lastBuildDate>Wed, 02 Apr 2014 00:00:00 +0000</lastBuildDate> + + <atom:link href="https://gohugo.io/tags/golang/index.xml" rel="self" type="application/rss+xml" /> + + + <item> + <title>(Hu)go Template Primer</title> + <link>https://gohugo.io/post/goisforlovers/</link> + <pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate> + + <guid>https://gohugo.io/post/goisforlovers/</guid> + <description>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.</description> + </item> + + <item> + <title>Getting Started with Hugo</title> + <link>https://gohugo.io/post/hugoisforlovers/</link> + <pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate> + + <guid>https://gohugo.io/post/hugoisforlovers/</guid> + <description>Step 1. Install Hugo Go to Hugo releases and download the appropriate version for your OS and architecture. +Save it somewhere specific as we will be using it in the next step. +More complete instructions are available at Install Hugo +Step 2. Build the Docs Hugo has its own example site which happens to also be the documentation site you are reading right now. +Follow the following steps: + Clone the Hugo repository Go into the repo Run hugo in server mode and build the docs Open your browser to http://localhost:1313 Corresponding pseudo commands:</description> + </item> + + </channel> +</rss>
\ No newline at end of file diff --git a/exampleSite/public/tags/golang/page/1/index.html b/exampleSite/public/tags/golang/page/1/index.html new file mode 100644 index 0000000..82add61 --- /dev/null +++ b/exampleSite/public/tags/golang/page/1/index.html @@ -0,0 +1 @@ +<!DOCTYPE html><html><head><title>https://gohugo.io/tags/golang/</title><link rel="canonical" href="https://gohugo.io/tags/golang/"/><meta name="robots" content="noindex"><meta charset="utf-8" /><meta http-equiv="refresh" content="0; url=https://gohugo.io/tags/golang/" /></head></html>
\ No newline at end of file diff --git a/exampleSite/public/tags/hugo/index.html b/exampleSite/public/tags/hugo/index.html new file mode 100644 index 0000000..f70ccb6 --- /dev/null +++ b/exampleSite/public/tags/hugo/index.html @@ -0,0 +1,197 @@ +<!DOCTYPE html> +<html > +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="generator" content="Hugo 0.53" /> + + <title>Hugo - A Hugo Theme built with Bootstrap</title> + + + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto"> + <link href="https://gohugo.io//css/bootstrap.min.css" rel="stylesheet"> + <link href="https://gohugo.io//css/strange-case.css" rel="stylesheet"> + + + + + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> + <![endif]--> +</head> +<body class="scheme-darkbrown"> + + <div class="container-fluid"> + <div class="row"> + <div class="col-sm-4 col-md-3 col-lg-3 sidebar"> + + + <div class="sidebar-content"> + + <a href="https://gohugo.io/"><h1>Hugo Themes</h1></a> + <p>A Hugo Theme built with Bootstrap</p> + + + <div class="sidebar-freetext"> + <p>A optional paragraph of free text. Set to blank in config.toml to clear...</p> + </div> + + + <ul class="sidebar-menus"> + + <li>» <a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a> </li> + + <li>» <a href="https://gohugo.io/about/">About Hugo</a> </li> + + <li>» <a href="http://getbootstrap.com">Bootstrap</a> <span class='glyphicon glyphicon-ok'></span></li> + + <li>» <a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a> </li> + + <li>» <a href="http://gohugo.io">Hugo</a> <span class='glyphicon glyphicon-fire'></span></li> + + <li>» <a href="">tutorials</a> </li> + + </ul> + + <div class="sidebar-recent hidden-xs"> + <p>Recent Posts:</p> + <ul> + + <li><a href="https://gohugo.io/post/creating-a-new-theme/">Creating a New Theme</a></li> + + <li><a href="https://gohugo.io/post/migrate-from-jekyll/">Migrate to Hugo from Jekyll</a></li> + + <li><a href="https://gohugo.io/about/">About Hugo</a></li> + + <li><a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a></li> + + <li><a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a></li> + + </ul> + </div> + + <p class="copyright">© 2019. All rights reserved. </p> + <p class="attr">Powered by <a href="http://gohugo.io">Hugo</a> & <a href="https://github.com/ExchangeRate-API/strange-case">Strange Case</a> (inspired by <a href="https://github.com/poole/hyde">Hyde</a>).</p> + + </div> + + + </div> + <div class="col-sm-7 col-sm-offset-4 col-md-6 col-md-offset-3 col-lg-5 col-lg-offset-3 content"> + + + <div class="post"> + + <div class="post-heading"> + <h1><a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a></h1> + <span>Apr 2, 2014</span> + </div> + + + +<h2 id="step-1-install-hugo">Step 1. Install Hugo</h2> + +<p>Go to <a href="https://github.com/spf13/hugo/releases">Hugo releases</a> and download the +appropriate version for your OS and architecture.</p> + +<p>Save it somewhere specific as we will be using it in the next step.</p> + +<p>More complete instructions are available at <a href="https://gohugo.io/getting-started/installing/">Install Hugo</a></p> + +<h2 id="step-2-build-the-docs">Step 2. Build the Docs</h2> + +<p>Hugo has its own example site which happens to also be the documentation site +you are reading right now.</p> + +<p>Follow the following steps:</p> + +<ol> +<li>Clone the <a href="http://github.com/spf13/hugo">Hugo repository</a></li> +<li>Go into the repo</li> +<li>Run hugo in server mode and build the docs</li> +<li>Open your browser to <a href="http://localhost:1313">http://localhost:1313</a></li> +</ol> + +<p>Corresponding pseudo commands:</p> + +<pre><code>git clone https://github.com/spf13/hugo +cd hugo +/path/to/where/you/installed/hugo server --source=./docs +> 29 pages created +> 0 tags index created +> in 27 ms +> Web Server is available at http://localhost:1313 +> Press ctrl+c to stop +</code></pre> + +<p>Once you’ve gotten here, follow along the rest of this page on your local build.</p> + +<h2 id="step-3-change-the-docs-site">Step 3. Change the docs site</h2> + +<p>Stop the Hugo process by hitting Ctrl+C.</p> + +<p>Now we are going to run hugo again, but this time with hugo in watch mode.</p> + +<pre><code>/path/to/hugo/from/step/1/hugo server --source=./docs --watch +> 29 pages created +> 0 tags index created +> in 27 ms +> Web Server is available at http://localhost:1313 +> Watching for changes in /Users/spf13/Code/hugo/docs/content +> Press ctrl+c to stop +</code></pre> + +<p>Open your <a href="http://vim.spf13.com">favorite editor</a> and change one of the source +content pages. How about changing this very file to <em>fix the typo</em>. How about changing this very file to <em>fix the typo</em>.</p> + +<p>Content files are found in <code>docs/content/</code>. Unless otherwise specified, files +are located at the same relative location as the url, in our case +<code>docs/content/overview/quickstart.md</code>.</p> + +<p>Change and save this file.. Notice what happened in your terminal.</p> + +<pre><code>> Change detected, rebuilding site + +> 29 pages created +> 0 tags index created +> in 26 ms +</code></pre> + +<p>Refresh the browser and observe that the typo is now fixed.</p> + +<p>Notice how quick that was. Try to refresh the site before it’s finished building. I double dare you. +Having nearly instant feedback enables you to have your creativity flow without waiting for long builds.</p> + +<h2 id="step-4-have-fun">Step 4. Have fun</h2> + +<p>The best way to learn something is to play with it.</p> + + + </div> + + + <div class="text-center"> + + + </div> + + </div> + <div class="col-sm-1 col-md-3 col-md-4"> + </div> + </div> + </div> + + + + + + + +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script> + +<script src="https://gohugo.io//js/bootstrap.min.js"></script> + +</body> +</html>
\ No newline at end of file diff --git a/exampleSite/public/tags/hugo/index.xml b/exampleSite/public/tags/hugo/index.xml new file mode 100644 index 0000000..d568b5e --- /dev/null +++ b/exampleSite/public/tags/hugo/index.xml @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="utf-8" standalone="yes" ?> +<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> + <channel> + <title>Hugo on Hugo Themes</title> + <link>https://gohugo.io/tags/hugo/</link> + <description>Recent content in Hugo on Hugo Themes</description> + <generator>Hugo -- gohugo.io</generator> + <copyright>Copyright (c) 2008 - 2014, Steve Francia; all rights reserved.</copyright> + <lastBuildDate>Wed, 02 Apr 2014 00:00:00 +0000</lastBuildDate> + + <atom:link href="https://gohugo.io/tags/hugo/index.xml" rel="self" type="application/rss+xml" /> + + + <item> + <title>Getting Started with Hugo</title> + <link>https://gohugo.io/post/hugoisforlovers/</link> + <pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate> + + <guid>https://gohugo.io/post/hugoisforlovers/</guid> + <description>Step 1. Install Hugo Go to Hugo releases and download the appropriate version for your OS and architecture. +Save it somewhere specific as we will be using it in the next step. +More complete instructions are available at Install Hugo +Step 2. Build the Docs Hugo has its own example site which happens to also be the documentation site you are reading right now. +Follow the following steps: + Clone the Hugo repository Go into the repo Run hugo in server mode and build the docs Open your browser to http://localhost:1313 Corresponding pseudo commands:</description> + </item> + + </channel> +</rss>
\ No newline at end of file diff --git a/exampleSite/public/tags/hugo/page/1/index.html b/exampleSite/public/tags/hugo/page/1/index.html new file mode 100644 index 0000000..ae1c002 --- /dev/null +++ b/exampleSite/public/tags/hugo/page/1/index.html @@ -0,0 +1 @@ +<!DOCTYPE html><html><head><title>https://gohugo.io/tags/hugo/</title><link rel="canonical" href="https://gohugo.io/tags/hugo/"/><meta name="robots" content="noindex"><meta charset="utf-8" /><meta http-equiv="refresh" content="0; url=https://gohugo.io/tags/hugo/" /></head></html>
\ No newline at end of file diff --git a/exampleSite/public/tags/index.html b/exampleSite/public/tags/index.html new file mode 100644 index 0000000..da35ecf --- /dev/null +++ b/exampleSite/public/tags/index.html @@ -0,0 +1,184 @@ +<!DOCTYPE html> +<html > +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="generator" content="Hugo 0.53" /> + + <title>Tags - A Hugo Theme built with Bootstrap</title> + + + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto"> + <link href="https://gohugo.io//css/bootstrap.min.css" rel="stylesheet"> + <link href="https://gohugo.io//css/strange-case.css" rel="stylesheet"> + + + + + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> + <![endif]--> +</head> +<body class="scheme-darkbrown"> + + <div class="container-fluid"> + <div class="row"> + <div class="col-sm-4 col-md-3 col-lg-3 sidebar"> + + + <div class="sidebar-content"> + + <a href="https://gohugo.io/"><h1>Hugo Themes</h1></a> + <p>A Hugo Theme built with Bootstrap</p> + + + <div class="sidebar-freetext"> + <p>A optional paragraph of free text. Set to blank in config.toml to clear...</p> + </div> + + + <ul class="sidebar-menus"> + + <li>» <a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a> </li> + + <li>» <a href="https://gohugo.io/about/">About Hugo</a> </li> + + <li>» <a href="http://getbootstrap.com">Bootstrap</a> <span class='glyphicon glyphicon-ok'></span></li> + + <li>» <a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a> </li> + + <li>» <a href="http://gohugo.io">Hugo</a> <span class='glyphicon glyphicon-fire'></span></li> + + <li>» <a href="">tutorials</a> </li> + + </ul> + + <div class="sidebar-recent hidden-xs"> + <p>Recent Posts:</p> + <ul> + + <li><a href="https://gohugo.io/post/creating-a-new-theme/">Creating a New Theme</a></li> + + <li><a href="https://gohugo.io/post/migrate-from-jekyll/">Migrate to Hugo from Jekyll</a></li> + + <li><a href="https://gohugo.io/about/">About Hugo</a></li> + + <li><a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a></li> + + <li><a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a></li> + + </ul> + </div> + + <p class="copyright">© 2019. All rights reserved. </p> + <p class="attr">Powered by <a href="http://gohugo.io">Hugo</a> & <a href="https://github.com/ExchangeRate-API/strange-case">Strange Case</a> (inspired by <a href="https://github.com/poole/hyde">Hyde</a>).</p> + + </div> + + + </div> + <div class="col-sm-7 col-sm-offset-4 col-md-6 col-md-offset-3 col-lg-5 col-lg-offset-3 content"> + + + <div class="post"> + + <div class="post-heading"> + <h1><a href="https://gohugo.io/tags/development/">Development</a></h1> + <span>Apr 2, 2014</span> + </div> + + + + </div> + + <div class="post"> + + <div class="post-heading"> + <h1><a href="https://gohugo.io/tags/go/">Go</a></h1> + <span>Apr 2, 2014</span> + </div> + + + + </div> + + <div class="post"> + + <div class="post-heading"> + <h1><a href="https://gohugo.io/tags/golang/">Golang</a></h1> + <span>Apr 2, 2014</span> + </div> + + + + </div> + + + <div class="text-center"> + + +<ul class="pagination"> + + <li class="page-item"> + <a href="https://gohugo.io/tags/" class="page-link" aria-label="First"><span aria-hidden="true">««</span></a> + </li> + + <li class="page-item disabled"> + <a href="" class="page-link" aria-label="Previous"><span aria-hidden="true">«</span></a> + </li> + + + + + + + + + + + <li class="page-item active"><a class="page-link" href="https://gohugo.io/tags/">1</a></li> + + + + + + + + + + + <li class="page-item"><a class="page-link" href="https://gohugo.io/tags/page/2/">2</a></li> + + + <li class="page-item"> + <a href="https://gohugo.io/tags/page/2/" class="page-link" aria-label="Next"><span aria-hidden="true">»</span></a> + </li> + + <li class="page-item"> + <a href="https://gohugo.io/tags/page/2/" class="page-link" aria-label="Last"><span aria-hidden="true">»»</span></a> + </li> + +</ul> + + </div> + + </div> + <div class="col-sm-1 col-md-3 col-md-4"> + </div> + </div> + </div> + + + + + + + +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script> + +<script src="https://gohugo.io//js/bootstrap.min.js"></script> + +</body> +</html>
\ No newline at end of file diff --git a/exampleSite/public/tags/index.xml b/exampleSite/public/tags/index.xml new file mode 100644 index 0000000..fff9e51 --- /dev/null +++ b/exampleSite/public/tags/index.xml @@ -0,0 +1,69 @@ +<?xml version="1.0" encoding="utf-8" standalone="yes" ?> +<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> + <channel> + <title>Tags on Hugo Themes</title> + <link>https://gohugo.io/tags/</link> + <description>Recent content in Tags on Hugo Themes</description> + <generator>Hugo -- gohugo.io</generator> + <copyright>Copyright (c) 2008 - 2014, Steve Francia; all rights reserved.</copyright> + <lastBuildDate>Wed, 02 Apr 2014 00:00:00 +0000</lastBuildDate> + + <atom:link href="https://gohugo.io/tags/index.xml" rel="self" type="application/rss+xml" /> + + + <item> + <title>Development</title> + <link>https://gohugo.io/tags/development/</link> + <pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate> + + <guid>https://gohugo.io/tags/development/</guid> + <description></description> + </item> + + <item> + <title>Go</title> + <link>https://gohugo.io/tags/go/</link> + <pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate> + + <guid>https://gohugo.io/tags/go/</guid> + <description></description> + </item> + + <item> + <title>Golang</title> + <link>https://gohugo.io/tags/golang/</link> + <pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate> + + <guid>https://gohugo.io/tags/golang/</guid> + <description></description> + </item> + + <item> + <title>Hugo</title> + <link>https://gohugo.io/tags/hugo/</link> + <pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate> + + <guid>https://gohugo.io/tags/hugo/</guid> + <description></description> + </item> + + <item> + <title>Templates</title> + <link>https://gohugo.io/tags/templates/</link> + <pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate> + + <guid>https://gohugo.io/tags/templates/</guid> + <description></description> + </item> + + <item> + <title>Themes</title> + <link>https://gohugo.io/tags/themes/</link> + <pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate> + + <guid>https://gohugo.io/tags/themes/</guid> + <description></description> + </item> + + </channel> +</rss>
\ No newline at end of file diff --git a/exampleSite/public/tags/page/1/index.html b/exampleSite/public/tags/page/1/index.html new file mode 100644 index 0000000..f4d7cf6 --- /dev/null +++ b/exampleSite/public/tags/page/1/index.html @@ -0,0 +1 @@ +<!DOCTYPE html><html><head><title>https://gohugo.io/tags/</title><link rel="canonical" href="https://gohugo.io/tags/"/><meta name="robots" content="noindex"><meta charset="utf-8" /><meta http-equiv="refresh" content="0; url=https://gohugo.io/tags/" /></head></html>
\ No newline at end of file diff --git a/exampleSite/public/tags/page/2/index.html b/exampleSite/public/tags/page/2/index.html new file mode 100644 index 0000000..b9a0f30 --- /dev/null +++ b/exampleSite/public/tags/page/2/index.html @@ -0,0 +1,184 @@ +<!DOCTYPE html> +<html > +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="generator" content="Hugo 0.53" /> + + <title>Tags - A Hugo Theme built with Bootstrap</title> + + + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto"> + <link href="https://gohugo.io//css/bootstrap.min.css" rel="stylesheet"> + <link href="https://gohugo.io//css/strange-case.css" rel="stylesheet"> + + + + + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> + <![endif]--> +</head> +<body class="scheme-darkbrown"> + + <div class="container-fluid"> + <div class="row"> + <div class="col-sm-4 col-md-3 col-lg-3 sidebar"> + + + <div class="sidebar-content"> + + <a href="https://gohugo.io/"><h1>Hugo Themes</h1></a> + <p>A Hugo Theme built with Bootstrap</p> + + + <div class="sidebar-freetext"> + <p>A optional paragraph of free text. Set to blank in config.toml to clear...</p> + </div> + + + <ul class="sidebar-menus"> + + <li>» <a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a> </li> + + <li>» <a href="https://gohugo.io/about/">About Hugo</a> </li> + + <li>» <a href="http://getbootstrap.com">Bootstrap</a> <span class='glyphicon glyphicon-ok'></span></li> + + <li>» <a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a> </li> + + <li>» <a href="http://gohugo.io">Hugo</a> <span class='glyphicon glyphicon-fire'></span></li> + + <li>» <a href="">tutorials</a> </li> + + </ul> + + <div class="sidebar-recent hidden-xs"> + <p>Recent Posts:</p> + <ul> + + <li><a href="https://gohugo.io/post/creating-a-new-theme/">Creating a New Theme</a></li> + + <li><a href="https://gohugo.io/post/migrate-from-jekyll/">Migrate to Hugo from Jekyll</a></li> + + <li><a href="https://gohugo.io/about/">About Hugo</a></li> + + <li><a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a></li> + + <li><a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a></li> + + </ul> + </div> + + <p class="copyright">© 2019. All rights reserved. </p> + <p class="attr">Powered by <a href="http://gohugo.io">Hugo</a> & <a href="https://github.com/ExchangeRate-API/strange-case">Strange Case</a> (inspired by <a href="https://github.com/poole/hyde">Hyde</a>).</p> + + </div> + + + </div> + <div class="col-sm-7 col-sm-offset-4 col-md-6 col-md-offset-3 col-lg-5 col-lg-offset-3 content"> + + + <div class="post"> + + <div class="post-heading"> + <h1><a href="https://gohugo.io/tags/hugo/">Hugo</a></h1> + <span>Apr 2, 2014</span> + </div> + + + + </div> + + <div class="post"> + + <div class="post-heading"> + <h1><a href="https://gohugo.io/tags/templates/">Templates</a></h1> + <span>Apr 2, 2014</span> + </div> + + + + </div> + + <div class="post"> + + <div class="post-heading"> + <h1><a href="https://gohugo.io/tags/themes/">Themes</a></h1> + <span>Apr 2, 2014</span> + </div> + + + + </div> + + + <div class="text-center"> + + +<ul class="pagination"> + + <li class="page-item"> + <a href="https://gohugo.io/tags/" class="page-link" aria-label="First"><span aria-hidden="true">««</span></a> + </li> + + <li class="page-item"> + <a href="https://gohugo.io/tags/" class="page-link" aria-label="Previous"><span aria-hidden="true">«</span></a> + </li> + + + + + + + + + + + <li class="page-item"><a class="page-link" href="https://gohugo.io/tags/">1</a></li> + + + + + + + + + + + <li class="page-item active"><a class="page-link" href="https://gohugo.io/tags/page/2/">2</a></li> + + + <li class="page-item disabled"> + <a href="" class="page-link" aria-label="Next"><span aria-hidden="true">»</span></a> + </li> + + <li class="page-item"> + <a href="https://gohugo.io/tags/page/2/" class="page-link" aria-label="Last"><span aria-hidden="true">»»</span></a> + </li> + +</ul> + + </div> + + </div> + <div class="col-sm-1 col-md-3 col-md-4"> + </div> + </div> + </div> + + + + + + + +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script> + +<script src="https://gohugo.io//js/bootstrap.min.js"></script> + +</body> +</html>
\ No newline at end of file diff --git a/exampleSite/public/tags/templates/index.html b/exampleSite/public/tags/templates/index.html new file mode 100644 index 0000000..a3dddc4 --- /dev/null +++ b/exampleSite/public/tags/templates/index.html @@ -0,0 +1,456 @@ +<!DOCTYPE html> +<html > +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="generator" content="Hugo 0.53" /> + + <title>Templates - A Hugo Theme built with Bootstrap</title> + + + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto"> + <link href="https://gohugo.io//css/bootstrap.min.css" rel="stylesheet"> + <link href="https://gohugo.io//css/strange-case.css" rel="stylesheet"> + + + + + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> + <![endif]--> +</head> +<body class="scheme-darkbrown"> + + <div class="container-fluid"> + <div class="row"> + <div class="col-sm-4 col-md-3 col-lg-3 sidebar"> + + + <div class="sidebar-content"> + + <a href="https://gohugo.io/"><h1>Hugo Themes</h1></a> + <p>A Hugo Theme built with Bootstrap</p> + + + <div class="sidebar-freetext"> + <p>A optional paragraph of free text. Set to blank in config.toml to clear...</p> + </div> + + + <ul class="sidebar-menus"> + + <li>» <a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a> </li> + + <li>» <a href="https://gohugo.io/about/">About Hugo</a> </li> + + <li>» <a href="http://getbootstrap.com">Bootstrap</a> <span class='glyphicon glyphicon-ok'></span></li> + + <li>» <a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a> </li> + + <li>» <a href="http://gohugo.io">Hugo</a> <span class='glyphicon glyphicon-fire'></span></li> + + <li>» <a href="">tutorials</a> </li> + + </ul> + + <div class="sidebar-recent hidden-xs"> + <p>Recent Posts:</p> + <ul> + + <li><a href="https://gohugo.io/post/creating-a-new-theme/">Creating a New Theme</a></li> + + <li><a href="https://gohugo.io/post/migrate-from-jekyll/">Migrate to Hugo from Jekyll</a></li> + + <li><a href="https://gohugo.io/about/">About Hugo</a></li> + + <li><a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a></li> + + <li><a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a></li> + + </ul> + </div> + + <p class="copyright">© 2019. All rights reserved. </p> + <p class="attr">Powered by <a href="http://gohugo.io">Hugo</a> & <a href="https://github.com/ExchangeRate-API/strange-case">Strange Case</a> (inspired by <a href="https://github.com/poole/hyde">Hyde</a>).</p> + + </div> + + + </div> + <div class="col-sm-7 col-sm-offset-4 col-md-6 col-md-offset-3 col-lg-5 col-lg-offset-3 content"> + + + <div class="post"> + + <div class="post-heading"> + <h1><a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a></h1> + <span>Apr 2, 2014</span> + </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</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</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</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="https://gohugo.io/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</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="https://gohugo.io/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</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</h2> + +<p>Go templates provide the most basic iteration and conditional logic.</p> + +<h3 id="iteration">Iteration</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</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</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)</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</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</h2> + +<p>In each piece of content you can provide variables to be used by the +templates. This happens in the <a href="https://gohugo.io/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><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</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> + +<pre><code class="language-yaml">params: + CopyrightHTML: "Copyright &#xA9; 2013 John Doe. All Rights Reserved." + TwitterUser: "spf13" + SidebarRecentLimit: 5 +</code></pre> + +<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><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><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><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> + + + </div> + + + <div class="text-center"> + + + </div> + + </div> + <div class="col-sm-1 col-md-3 col-md-4"> + </div> + </div> + </div> + + + + + + + +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script> + +<script src="https://gohugo.io//js/bootstrap.min.js"></script> + +</body> +</html>
\ No newline at end of file diff --git a/exampleSite/public/tags/templates/index.xml b/exampleSite/public/tags/templates/index.xml new file mode 100644 index 0000000..9dbf982 --- /dev/null +++ b/exampleSite/public/tags/templates/index.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="utf-8" standalone="yes" ?> +<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> + <channel> + <title>Templates on Hugo Themes</title> + <link>https://gohugo.io/tags/templates/</link> + <description>Recent content in Templates on Hugo Themes</description> + <generator>Hugo -- gohugo.io</generator> + <copyright>Copyright (c) 2008 - 2014, Steve Francia; all rights reserved.</copyright> + <lastBuildDate>Wed, 02 Apr 2014 00:00:00 +0000</lastBuildDate> + + <atom:link href="https://gohugo.io/tags/templates/index.xml" rel="self" type="application/rss+xml" /> + + + <item> + <title>(Hu)go Template Primer</title> + <link>https://gohugo.io/post/goisforlovers/</link> + <pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate> + + <guid>https://gohugo.io/post/goisforlovers/</guid> + <description>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.</description> + </item> + + </channel> +</rss>
\ No newline at end of file diff --git a/exampleSite/public/tags/templates/page/1/index.html b/exampleSite/public/tags/templates/page/1/index.html new file mode 100644 index 0000000..6aec491 --- /dev/null +++ b/exampleSite/public/tags/templates/page/1/index.html @@ -0,0 +1 @@ +<!DOCTYPE html><html><head><title>https://gohugo.io/tags/templates/</title><link rel="canonical" href="https://gohugo.io/tags/templates/"/><meta name="robots" content="noindex"><meta charset="utf-8" /><meta http-equiv="refresh" content="0; url=https://gohugo.io/tags/templates/" /></head></html>
\ No newline at end of file diff --git a/exampleSite/public/tags/themes/index.html b/exampleSite/public/tags/themes/index.html new file mode 100644 index 0000000..bd3a933 --- /dev/null +++ b/exampleSite/public/tags/themes/index.html @@ -0,0 +1,456 @@ +<!DOCTYPE html> +<html > +<head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <meta name="generator" content="Hugo 0.53" /> + + <title>Themes - A Hugo Theme built with Bootstrap</title> + + + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto"> + <link href="https://gohugo.io//css/bootstrap.min.css" rel="stylesheet"> + <link href="https://gohugo.io//css/strange-case.css" rel="stylesheet"> + + + + + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> + <![endif]--> +</head> +<body class="scheme-darkbrown"> + + <div class="container-fluid"> + <div class="row"> + <div class="col-sm-4 col-md-3 col-lg-3 sidebar"> + + + <div class="sidebar-content"> + + <a href="https://gohugo.io/"><h1>Hugo Themes</h1></a> + <p>A Hugo Theme built with Bootstrap</p> + + + <div class="sidebar-freetext"> + <p>A optional paragraph of free text. Set to blank in config.toml to clear...</p> + </div> + + + <ul class="sidebar-menus"> + + <li>» <a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a> </li> + + <li>» <a href="https://gohugo.io/about/">About Hugo</a> </li> + + <li>» <a href="http://getbootstrap.com">Bootstrap</a> <span class='glyphicon glyphicon-ok'></span></li> + + <li>» <a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a> </li> + + <li>» <a href="http://gohugo.io">Hugo</a> <span class='glyphicon glyphicon-fire'></span></li> + + <li>» <a href="">tutorials</a> </li> + + </ul> + + <div class="sidebar-recent hidden-xs"> + <p>Recent Posts:</p> + <ul> + + <li><a href="https://gohugo.io/post/creating-a-new-theme/">Creating a New Theme</a></li> + + <li><a href="https://gohugo.io/post/migrate-from-jekyll/">Migrate to Hugo from Jekyll</a></li> + + <li><a href="https://gohugo.io/about/">About Hugo</a></li> + + <li><a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a></li> + + <li><a href="https://gohugo.io/post/hugoisforlovers/">Getting Started with Hugo</a></li> + + </ul> + </div> + + <p class="copyright">© 2019. All rights reserved. </p> + <p class="attr">Powered by <a href="http://gohugo.io">Hugo</a> & <a href="https://github.com/ExchangeRate-API/strange-case">Strange Case</a> (inspired by <a href="https://github.com/poole/hyde">Hyde</a>).</p> + + </div> + + + </div> + <div class="col-sm-7 col-sm-offset-4 col-md-6 col-md-offset-3 col-lg-5 col-lg-offset-3 content"> + + + <div class="post"> + + <div class="post-heading"> + <h1><a href="https://gohugo.io/post/goisforlovers/">(Hu)go Template Primer</a></h1> + <span>Apr 2, 2014</span> + </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</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</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</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="https://gohugo.io/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</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="https://gohugo.io/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</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</h2> + +<p>Go templates provide the most basic iteration and conditional logic.</p> + +<h3 id="iteration">Iteration</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</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</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)</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</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</h2> + +<p>In each piece of content you can provide variables to be used by the +templates. This happens in the <a href="https://gohugo.io/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><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</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> + +<pre><code class="language-yaml">params: + CopyrightHTML: "Copyright &#xA9; 2013 John Doe. All Rights Reserved." + TwitterUser: "spf13" + SidebarRecentLimit: 5 +</code></pre> + +<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><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><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><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> + + + </div> + + + <div class="text-center"> + + + </div> + + </div> + <div class="col-sm-1 col-md-3 col-md-4"> + </div> + </div> + </div> + + + + + + + +<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script> + +<script src="https://gohugo.io//js/bootstrap.min.js"></script> + +</body> +</html>
\ No newline at end of file diff --git a/exampleSite/public/tags/themes/index.xml b/exampleSite/public/tags/themes/index.xml new file mode 100644 index 0000000..c54c7ca --- /dev/null +++ b/exampleSite/public/tags/themes/index.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="utf-8" standalone="yes" ?> +<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> + <channel> + <title>Themes on Hugo Themes</title> + <link>https://gohugo.io/tags/themes/</link> + <description>Recent content in Themes on Hugo Themes</description> + <generator>Hugo -- gohugo.io</generator> + <copyright>Copyright (c) 2008 - 2014, Steve Francia; all rights reserved.</copyright> + <lastBuildDate>Wed, 02 Apr 2014 00:00:00 +0000</lastBuildDate> + + <atom:link href="https://gohugo.io/tags/themes/index.xml" rel="self" type="application/rss+xml" /> + + + <item> + <title>(Hu)go Template Primer</title> + <link>https://gohugo.io/post/goisforlovers/</link> + <pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate> + + <guid>https://gohugo.io/post/goisforlovers/</guid> + <description>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.</description> + </item> + + </channel> +</rss>
\ No newline at end of file diff --git a/exampleSite/public/tags/themes/page/1/index.html b/exampleSite/public/tags/themes/page/1/index.html new file mode 100644 index 0000000..4b99b08 --- /dev/null +++ b/exampleSite/public/tags/themes/page/1/index.html @@ -0,0 +1 @@ +<!DOCTYPE html><html><head><title>https://gohugo.io/tags/themes/</title><link rel="canonical" href="https://gohugo.io/tags/themes/"/><meta name="robots" content="noindex"><meta charset="utf-8" /><meta http-equiv="refresh" content="0; url=https://gohugo.io/tags/themes/" /></head></html>
\ No newline at end of file |