mirror of
https://github.com/Noettore/cocoa-eh-hugo-theme.git
synced 2025-10-15 03:36:41 +02:00
Add example site
* Revert back to using author in params
This commit is contained in:
Nishanth Shanmugham
21
exampleSite/LICENSE
Executable file
21
exampleSite/LICENSE
Executable file
@@ -0,0 +1,21 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2014 Steve Francia
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
25
exampleSite/README.md
Executable file
25
exampleSite/README.md
Executable file
@@ -0,0 +1,25 @@
|
||||
hugoBasicExample
|
||||
==========
|
||||
|
||||
This is an example site for [Hugo](http://gohugo.io/).
|
||||
|
||||
It is intended to be a demo site for the various [Hugo themes][].
|
||||
|
||||
# Using
|
||||
|
||||
1. First, [install Hugo](http://gohugo.io/overview/installing/);
|
||||
2. Then, clone this repository;
|
||||
3. Clone the [Hugo themes][];
|
||||
4. Run Hugo and select the theme of your choosing.
|
||||
|
||||
In other words:
|
||||
|
||||
<pre><code>git clone https://github.com/spf13/HugoBasicExample.git
|
||||
cd HugoBasicExample
|
||||
git clone --recursive https://github.com/spf13/hugoThemes.git themes
|
||||
hugo server -t <em>themename</em>
|
||||
</code></pre>
|
||||
|
||||
Enjoy!
|
||||
|
||||
[Hugo themes]: https://github.com/spf13/hugoThemes
|
||||
25
exampleSite/config.toml
Executable file
25
exampleSite/config.toml
Executable file
@@ -0,0 +1,25 @@
|
||||
baseurl = "http://hugo.spf13.com/"
|
||||
title = "Hugo Themes"
|
||||
author = "Steve Francia"
|
||||
canonifyurls = true
|
||||
contentdir = "content"
|
||||
languageCode = "en-US"
|
||||
layoutdir = "layouts"
|
||||
publishdir = "public"
|
||||
pygmentsuseclasses = true
|
||||
|
||||
[permalinks]
|
||||
fixed = ":title/"
|
||||
posts = "posts/:slug/"
|
||||
|
||||
[params]
|
||||
Author = "Steve Francia"
|
||||
DateForm = "Jan 2, 2006" # required
|
||||
Email = "username@hogwarts.edu"
|
||||
Facebook = "//facebook.com/username"
|
||||
GATracker = "<Google-Analytics-ID>"
|
||||
GitHub = "//github.com/username"
|
||||
Lang = "en" # <body lang="en">
|
||||
LinkedIn = "//linkedin.com/in/username"
|
||||
Twitter = "//twitter.com/username"
|
||||
# WebfontsFile = "css/mywebfontsfile.css" # relative to static/ directory, defaults to empty string
|
||||
17
exampleSite/content/fixed/about.md
Normal file
17
exampleSite/content/fixed/about.md
Normal file
@@ -0,0 +1,17 @@
|
||||
+++
|
||||
date = "2015-08-22T06:42:21-07:00"
|
||||
draft = false
|
||||
title = "about"
|
||||
|
||||
+++
|
||||
|
||||
TODO: Page not complete yet.
|
||||
|
||||
Information about you.
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
15
exampleSite/content/fixed/code.md
Normal file
15
exampleSite/content/fixed/code.md
Normal file
@@ -0,0 +1,15 @@
|
||||
+++
|
||||
date = "2015-08-19T20:29:37-07:00"
|
||||
draft = false
|
||||
title = "code"
|
||||
|
||||
+++
|
||||
|
||||
TODO: Page not complete yet.
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
|
||||
22
exampleSite/content/posts/redirect-webpages.md
Normal file
22
exampleSite/content/posts/redirect-webpages.md
Normal file
@@ -0,0 +1,22 @@
|
||||
+++
|
||||
date = "2015-08-22T15:45:30-07:00"
|
||||
draft = false
|
||||
title = "Redirect webpages using HTML"
|
||||
slug = "redirect-webpages-html"
|
||||
|
||||
+++
|
||||
|
||||
Webpage redirection is great for automatically redirecting people visiting an old URL to a new URL where the content has moved to. It can be done using JavaScript, but there is also a convenient HTML-only solution.
|
||||
|
||||
To redirect visitors reaching `yourwebsite.com/blog` to `yourwebsite.com/posts`, add this to the `<head>` section of the HTML at `yourwebsite.com/blog`:
|
||||
|
||||
{{< highlight html "linenos=inline" >}}
|
||||
<meta http-equiv="refresh" content="0;url='/posts'" />
|
||||
<link rel="canonical" href="/posts" />
|
||||
{{</highlight>}}
|
||||
|
||||
### walkthrough
|
||||
|
||||
Setting `http-equiv="refresh"` in the first line performs the actual redirect. The number in the `content` attribute specified in seconds tells the browser how long to wait before redirecting. In this example, `0` redirects immediately. Increasing the wait may be useful for briefly displaying a 404 page before automatically switching to the home page. The `url` specfies the destination for the redirect. In this example, we wanted to switch to `/posts`.
|
||||
|
||||
The second line is optional; it helps search engines know which the preferred version of the page is. Usually, this is the redirect destination.
|
||||
0
exampleSite/public/.gitignore
vendored
Executable file
0
exampleSite/public/.gitignore
vendored
Executable file
123
exampleSite/public/404/index.html
Normal file
123
exampleSite/public/404/index.html
Normal file
@@ -0,0 +1,123 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
404 Page not found · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/404/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container f04">
|
||||
<div class="content">
|
||||
<div class="num">404</div>
|
||||
<div class="detail">Sorry, this page does not exist.</div>
|
||||
<div class="suggestion"><a href="http://localhost:1313/">Visit home page</a></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
159
exampleSite/public/about-hugo/index.html
Normal file
159
exampleSite/public/about-hugo/index.html
Normal file
@@ -0,0 +1,159 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
About Hugo · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/about-hugo/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="page-heading">
|
||||
|
||||
About Hugo
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="markdown">
|
||||
|
||||
|
||||
<p>Hugo is a static site engine written in Go.</p>
|
||||
|
||||
<p>It makes use of a variety of open source projects including:</p>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/spf13/cobra">Cobra</a></li>
|
||||
<li><a href="https://github.com/spf13/viper">Viper</a></li>
|
||||
<li><a href="https://github.com/spf13/jWalterWeatherman">J Walter Weatherman</a></li>
|
||||
<li><a href="https://github.com/spf13/cast">Cast</a></li>
|
||||
</ul>
|
||||
|
||||
<p>Learn more and contribute on <a href="https://github.com/spf13">GitHub</a>.</p>
|
||||
|
||||
<h2 id="setup:6083a88ee3411b0d17ce02d738f69d47">Setup</h2>
|
||||
|
||||
<p>Some fun facts about <a href="http://gohugo.io/">Hugo</a>:</p>
|
||||
|
||||
<ul>
|
||||
<li>Built in <a href="http://golang.org/">Go</a></li>
|
||||
<li>Loosely inspired by <a href="http://jekyllrb.com/">Jekyll</a></li>
|
||||
<li>Primarily developed by <a href="http://spf13.com/">spf13</a> on the train while commuting to and from Manhattan.</li>
|
||||
<li>Coded in <a href="http://vim.org">Vim</a> using <a href="http://vim.spf13.com/">spf13-vim</a></li>
|
||||
</ul>
|
||||
|
||||
<p>Have questions or suggestions? Feel free to <a href="https://github.com/spf13/hugo/issues/new">open an issue on GitHub</a> or <a href="https://twitter.com/spf13">ask me on Twitter</a>.</p>
|
||||
|
||||
<p>Thanks for reading!</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
8
exampleSite/public/about-this-site/index.html
Normal file
8
exampleSite/public/about-this-site/index.html
Normal file
@@ -0,0 +1,8 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<link rel="canonical" href="http://localhost:1313/colophon"/>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
|
||||
<meta http-equiv="refresh" content="0;url=/colophon"/>
|
||||
</head>
|
||||
</html>
|
||||
140
exampleSite/public/about/index.html
Normal file
140
exampleSite/public/about/index.html
Normal file
@@ -0,0 +1,140 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
about · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/about/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="page-heading">
|
||||
|
||||
about
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="markdown">
|
||||
<p>TODO: Page not complete yet.</p>
|
||||
|
||||
<p>Information about you.</p>
|
||||
|
||||
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
8
exampleSite/public/blog/index.html
Normal file
8
exampleSite/public/blog/index.html
Normal file
@@ -0,0 +1,8 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<link rel="canonical" href="http://localhost:1313/posts"/>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
|
||||
<meta http-equiv="refresh" content="0;url=/posts"/>
|
||||
</head>
|
||||
</html>
|
||||
141
exampleSite/public/categories/development/index.html
Normal file
141
exampleSite/public/categories/development/index.html
Normal file
@@ -0,0 +1,141 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
Development · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/categories/development/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="page-heading">
|
||||
|
||||
Development
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Apr 2, 2014</div>
|
||||
<a href="http://localhost:1313/post/goisforlovers/"><div>(Hu)go Template Primer</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Apr 2, 2014</div>
|
||||
<a href="http://localhost:1313/post/hugoisforlovers/"><div>Getting Started with Hugo</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
|
||||
446
exampleSite/public/categories/development/index.xml
Normal file
446
exampleSite/public/categories/development/index.xml
Normal file
@@ -0,0 +1,446 @@
|
||||
<?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>http://localhost:1313/categories/development/</link>
|
||||
<description>Recent content in Development on Hugo Themes</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-US</language>
|
||||
<lastBuildDate>Wed, 02 Apr 2014 00:00:00 +0000</lastBuildDate>
|
||||
<atom:link href="http://localhost:1313/categories/development/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
<item>
|
||||
<title>(Hu)go Template Primer</title>
|
||||
<link>http://localhost:1313/post/goisforlovers/</link>
|
||||
<pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/post/goisforlovers/</guid>
|
||||
<description>
|
||||
|
||||
<p>Hugo uses the excellent <a href="http://golang.org/&gt;">go</a> <a href="http://golang.org/pkg/html/template/&gt;">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="http://golang.org/pkg/html/template/&gt;">go docs</a>
|
||||
provide more details.</p>
|
||||
|
||||
<h2 id="introduction-to-go-templates:4d30d99f79bd431d57546bbed04b7347">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="http://golang.org/pkg/html/template/&gt;">go docs</a>.</p>
|
||||
|
||||
<h2 id="basic-syntax:4d30d99f79bd431d57546bbed04b7347">Basic Syntax</h2>
|
||||
|
||||
<p>Go lang 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 &ldquo;foo&rdquo;:</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 &ldquo;bar&rdquo;</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 &quot;alt&quot;) (isset .Params &quot;caption&quot;) }} Caption {{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="variables:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/layout/variables">variables</a> page.</p>
|
||||
|
||||
<p>A variable is accessed by referencing the variable name.</p>
|
||||
|
||||
<pre><code>&lt;title&gt;{{ .Title }}&lt;/title&gt;
|
||||
</code></pre>
|
||||
|
||||
<p>Variables can also be defined and referenced.</p>
|
||||
|
||||
<pre><code>{{ $address := &quot;123 Main St.&quot;}}
|
||||
{{ $address }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="functions:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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:4d30d99f79bd431d57546bbed04b7347">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 &quot;chrome/header.html&quot; . }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="logic:4d30d99f79bd431d57546bbed04b7347">Logic</h2>
|
||||
|
||||
<p>Go templates provide the most basic iteration and conditional logic.</p>
|
||||
|
||||
<h3 id="iteration:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">Conditionals</h3>
|
||||
|
||||
<p>If, else, with, or, &amp; 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 &quot;title&quot; }}&lt;h4&gt;{{ index .Params &quot;title&quot; }}&lt;/h4&gt;{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 2: If -&gt; Else</strong></p>
|
||||
|
||||
<pre><code>{{ if isset .Params &quot;alt&quot; }}
|
||||
{{ index .Params &quot;alt&quot; }}
|
||||
{{else}}
|
||||
{{ index .Params &quot;caption&quot; }}
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 3: And &amp; Or</strong></p>
|
||||
|
||||
<pre><code>{{ if and (or (isset .Params &quot;title&quot;) (isset .Params &quot;caption&quot;)) (isset .Params &quot;attr&quot;)}}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 4: With</strong></p>
|
||||
|
||||
<p>An alternative way of writing &ldquo;if&rdquo; and then referencing the same value
|
||||
is to use &ldquo;with&rdquo; 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 }}&lt;h4&gt;{{ . }}&lt;/h4&gt;{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 5: If -&gt; Else If</strong></p>
|
||||
|
||||
<pre><code>{{ if isset .Params &quot;alt&quot; }}
|
||||
{{ index .Params &quot;alt&quot; }}
|
||||
{{ else if isset .Params &quot;caption&quot; }}
|
||||
{{ index .Params &quot;caption&quot; }}
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="pipes:4d30d99f79bd431d57546bbed04b7347">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&rsquo;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 &quot;disqus_url&quot; | html }}
|
||||
</code></pre>
|
||||
|
||||
<p>Access the page parameter called &ldquo;disqus_url&rdquo; and escape the HTML.</p>
|
||||
|
||||
<p><strong>Example 3 :</strong></p>
|
||||
|
||||
<pre><code>{{ if or (or (isset .Params &quot;title&quot;) (isset .Params &quot;caption&quot;)) (isset .Params &quot;attr&quot;)}}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p>Could be rewritten as</p>
|
||||
|
||||
<pre><code>{{ isset .Params &quot;caption&quot; | or isset .Params &quot;title&quot; | or isset .Params &quot;attr&quot; | if }}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="context-aka-the-dot:4d30d99f79bd431d57546bbed04b7347">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 }}
|
||||
&lt;li&gt; &lt;a href=&quot;{{ $baseurl }}/tags/{{ . | urlize }}&quot;&gt;{{ . }}&lt;/a&gt; - {{ $title }} &lt;/li&gt;
|
||||
{{ 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:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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&rsquo;t make a lot of sense. We&rsquo;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: &quot;Permalinks&quot;
|
||||
date: &quot;2013-11-18&quot;
|
||||
aliases:
|
||||
- &quot;/doc/permalinks/&quot;
|
||||
groups: [&quot;extras&quot;]
|
||||
groups_weight: 30
|
||||
notoc: true
|
||||
---
|
||||
</code></pre>
|
||||
|
||||
<p>Here is the corresponding code inside of the template:</p>
|
||||
|
||||
<pre><code> {{ if not .Params.notoc }}
|
||||
&lt;div id=&quot;toc&quot; class=&quot;well col-md-4 col-sm-6&quot;&gt;
|
||||
{{ .TableOfContents }}
|
||||
&lt;/div&gt;
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="using-site-config-parameters:4d30d99f79bd431d57546bbed04b7347">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: &quot;Copyright &amp;#xA9; 2013 John Doe. All Rights Reserved.&quot;
|
||||
TwitterUser: &quot;spf13&quot;
|
||||
SidebarRecentLimit: 5
|
||||
</code></pre>
|
||||
|
||||
<p>Within a footer layout, you might then declare a <code>&lt;footer&gt;</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}}&lt;footer&gt;
|
||||
&lt;div class=&quot;text-center&quot;&gt;{{.Site.Params.CopyrightHTML | safeHtml}}&lt;/div&gt;
|
||||
&lt;/footer&gt;{{end}}
|
||||
</code></pre>
|
||||
|
||||
<p>An alternative way of writing the &ldquo;if&rdquo; and then referencing the same value
|
||||
is to use &ldquo;with&rdquo; 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}}&lt;span class=&quot;twitter&quot;&gt;
|
||||
&lt;a href=&quot;https://twitter.com/{{.}}&quot; rel=&quot;author&quot;&gt;
|
||||
&lt;img src=&quot;/images/twitter.png&quot; width=&quot;48&quot; height=&quot;48&quot; title=&quot;Twitter: {{.}}&quot;
|
||||
alt=&quot;Twitter&quot;&gt;&lt;/a&gt;
|
||||
&lt;/span&gt;{{end}}
|
||||
</code></pre>
|
||||
|
||||
<p>Finally, if you want to pull &ldquo;magic constants&rdquo; out of your layouts, you can do
|
||||
so, such as in this example:</p>
|
||||
|
||||
<pre><code>&lt;nav class=&quot;recent&quot;&gt;
|
||||
&lt;h1&gt;Recent Posts&lt;/h1&gt;
|
||||
&lt;ul&gt;{{range first .Site.Params.SidebarRecentLimit .Site.Recent}}
|
||||
&lt;li&gt;&lt;a href=&quot;{{.RelPermalink}}&quot;&gt;{{.Title}}&lt;/a&gt;&lt;/li&gt;
|
||||
{{end}}&lt;/ul&gt;
|
||||
&lt;/nav&gt;
|
||||
</code></pre>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
<title>Getting Started with Hugo</title>
|
||||
<link>http://localhost:1313/post/hugoisforlovers/</link>
|
||||
<pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/post/hugoisforlovers/</guid>
|
||||
<description>
|
||||
|
||||
<h2 id="step-1-install-hugo:c57cc0038c788519b441e0331c8bebc7">Step 1. Install Hugo</h2>
|
||||
|
||||
<p>Goto <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="http://localhost:1313/overview/installing/">installing hugo</a></p>
|
||||
|
||||
<h2 id="step-2-build-the-docs:c57cc0038c788519b441e0331c8bebc7">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
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; in 27 ms
|
||||
&gt; Web Server is available at http://localhost:1313
|
||||
&gt; Press ctrl+c to stop
|
||||
</code></pre>
|
||||
|
||||
<p>Once you&rsquo;ve gotten here, follow along the rest of this page on your local build.</p>
|
||||
|
||||
<h2 id="step-3-change-the-docs-site:c57cc0038c788519b441e0331c8bebc7">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
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; in 27 ms
|
||||
&gt; Web Server is available at http://localhost:1313
|
||||
&gt; Watching for changes in /Users/spf13/Code/hugo/docs/content
|
||||
&gt; 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>&gt; Change detected, rebuilding site
|
||||
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; 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&rsquo;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:c57cc0038c788519b441e0331c8bebc7">Step 4. Have fun</h2>
|
||||
|
||||
<p>The best way to learn something is to play with it.</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
</channel>
|
||||
</rss>
|
||||
141
exampleSite/public/categories/golang/index.html
Normal file
141
exampleSite/public/categories/golang/index.html
Normal file
@@ -0,0 +1,141 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
Golang · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/categories/golang/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="page-heading">
|
||||
|
||||
Golang
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Apr 2, 2014</div>
|
||||
<a href="http://localhost:1313/post/goisforlovers/"><div>(Hu)go Template Primer</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Apr 2, 2014</div>
|
||||
<a href="http://localhost:1313/post/hugoisforlovers/"><div>Getting Started with Hugo</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
|
||||
446
exampleSite/public/categories/golang/index.xml
Normal file
446
exampleSite/public/categories/golang/index.xml
Normal file
@@ -0,0 +1,446 @@
|
||||
<?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>http://localhost:1313/categories/golang/</link>
|
||||
<description>Recent content in Golang on Hugo Themes</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-US</language>
|
||||
<lastBuildDate>Wed, 02 Apr 2014 00:00:00 +0000</lastBuildDate>
|
||||
<atom:link href="http://localhost:1313/categories/golang/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
<item>
|
||||
<title>(Hu)go Template Primer</title>
|
||||
<link>http://localhost:1313/post/goisforlovers/</link>
|
||||
<pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/post/goisforlovers/</guid>
|
||||
<description>
|
||||
|
||||
<p>Hugo uses the excellent <a href="http://golang.org/&gt;">go</a> <a href="http://golang.org/pkg/html/template/&gt;">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="http://golang.org/pkg/html/template/&gt;">go docs</a>
|
||||
provide more details.</p>
|
||||
|
||||
<h2 id="introduction-to-go-templates:4d30d99f79bd431d57546bbed04b7347">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="http://golang.org/pkg/html/template/&gt;">go docs</a>.</p>
|
||||
|
||||
<h2 id="basic-syntax:4d30d99f79bd431d57546bbed04b7347">Basic Syntax</h2>
|
||||
|
||||
<p>Go lang 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 &ldquo;foo&rdquo;:</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 &ldquo;bar&rdquo;</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 &quot;alt&quot;) (isset .Params &quot;caption&quot;) }} Caption {{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="variables:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/layout/variables">variables</a> page.</p>
|
||||
|
||||
<p>A variable is accessed by referencing the variable name.</p>
|
||||
|
||||
<pre><code>&lt;title&gt;{{ .Title }}&lt;/title&gt;
|
||||
</code></pre>
|
||||
|
||||
<p>Variables can also be defined and referenced.</p>
|
||||
|
||||
<pre><code>{{ $address := &quot;123 Main St.&quot;}}
|
||||
{{ $address }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="functions:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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:4d30d99f79bd431d57546bbed04b7347">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 &quot;chrome/header.html&quot; . }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="logic:4d30d99f79bd431d57546bbed04b7347">Logic</h2>
|
||||
|
||||
<p>Go templates provide the most basic iteration and conditional logic.</p>
|
||||
|
||||
<h3 id="iteration:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">Conditionals</h3>
|
||||
|
||||
<p>If, else, with, or, &amp; 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 &quot;title&quot; }}&lt;h4&gt;{{ index .Params &quot;title&quot; }}&lt;/h4&gt;{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 2: If -&gt; Else</strong></p>
|
||||
|
||||
<pre><code>{{ if isset .Params &quot;alt&quot; }}
|
||||
{{ index .Params &quot;alt&quot; }}
|
||||
{{else}}
|
||||
{{ index .Params &quot;caption&quot; }}
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 3: And &amp; Or</strong></p>
|
||||
|
||||
<pre><code>{{ if and (or (isset .Params &quot;title&quot;) (isset .Params &quot;caption&quot;)) (isset .Params &quot;attr&quot;)}}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 4: With</strong></p>
|
||||
|
||||
<p>An alternative way of writing &ldquo;if&rdquo; and then referencing the same value
|
||||
is to use &ldquo;with&rdquo; 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 }}&lt;h4&gt;{{ . }}&lt;/h4&gt;{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 5: If -&gt; Else If</strong></p>
|
||||
|
||||
<pre><code>{{ if isset .Params &quot;alt&quot; }}
|
||||
{{ index .Params &quot;alt&quot; }}
|
||||
{{ else if isset .Params &quot;caption&quot; }}
|
||||
{{ index .Params &quot;caption&quot; }}
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="pipes:4d30d99f79bd431d57546bbed04b7347">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&rsquo;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 &quot;disqus_url&quot; | html }}
|
||||
</code></pre>
|
||||
|
||||
<p>Access the page parameter called &ldquo;disqus_url&rdquo; and escape the HTML.</p>
|
||||
|
||||
<p><strong>Example 3 :</strong></p>
|
||||
|
||||
<pre><code>{{ if or (or (isset .Params &quot;title&quot;) (isset .Params &quot;caption&quot;)) (isset .Params &quot;attr&quot;)}}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p>Could be rewritten as</p>
|
||||
|
||||
<pre><code>{{ isset .Params &quot;caption&quot; | or isset .Params &quot;title&quot; | or isset .Params &quot;attr&quot; | if }}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="context-aka-the-dot:4d30d99f79bd431d57546bbed04b7347">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 }}
|
||||
&lt;li&gt; &lt;a href=&quot;{{ $baseurl }}/tags/{{ . | urlize }}&quot;&gt;{{ . }}&lt;/a&gt; - {{ $title }} &lt;/li&gt;
|
||||
{{ 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:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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&rsquo;t make a lot of sense. We&rsquo;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: &quot;Permalinks&quot;
|
||||
date: &quot;2013-11-18&quot;
|
||||
aliases:
|
||||
- &quot;/doc/permalinks/&quot;
|
||||
groups: [&quot;extras&quot;]
|
||||
groups_weight: 30
|
||||
notoc: true
|
||||
---
|
||||
</code></pre>
|
||||
|
||||
<p>Here is the corresponding code inside of the template:</p>
|
||||
|
||||
<pre><code> {{ if not .Params.notoc }}
|
||||
&lt;div id=&quot;toc&quot; class=&quot;well col-md-4 col-sm-6&quot;&gt;
|
||||
{{ .TableOfContents }}
|
||||
&lt;/div&gt;
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="using-site-config-parameters:4d30d99f79bd431d57546bbed04b7347">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: &quot;Copyright &amp;#xA9; 2013 John Doe. All Rights Reserved.&quot;
|
||||
TwitterUser: &quot;spf13&quot;
|
||||
SidebarRecentLimit: 5
|
||||
</code></pre>
|
||||
|
||||
<p>Within a footer layout, you might then declare a <code>&lt;footer&gt;</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}}&lt;footer&gt;
|
||||
&lt;div class=&quot;text-center&quot;&gt;{{.Site.Params.CopyrightHTML | safeHtml}}&lt;/div&gt;
|
||||
&lt;/footer&gt;{{end}}
|
||||
</code></pre>
|
||||
|
||||
<p>An alternative way of writing the &ldquo;if&rdquo; and then referencing the same value
|
||||
is to use &ldquo;with&rdquo; 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}}&lt;span class=&quot;twitter&quot;&gt;
|
||||
&lt;a href=&quot;https://twitter.com/{{.}}&quot; rel=&quot;author&quot;&gt;
|
||||
&lt;img src=&quot;/images/twitter.png&quot; width=&quot;48&quot; height=&quot;48&quot; title=&quot;Twitter: {{.}}&quot;
|
||||
alt=&quot;Twitter&quot;&gt;&lt;/a&gt;
|
||||
&lt;/span&gt;{{end}}
|
||||
</code></pre>
|
||||
|
||||
<p>Finally, if you want to pull &ldquo;magic constants&rdquo; out of your layouts, you can do
|
||||
so, such as in this example:</p>
|
||||
|
||||
<pre><code>&lt;nav class=&quot;recent&quot;&gt;
|
||||
&lt;h1&gt;Recent Posts&lt;/h1&gt;
|
||||
&lt;ul&gt;{{range first .Site.Params.SidebarRecentLimit .Site.Recent}}
|
||||
&lt;li&gt;&lt;a href=&quot;{{.RelPermalink}}&quot;&gt;{{.Title}}&lt;/a&gt;&lt;/li&gt;
|
||||
{{end}}&lt;/ul&gt;
|
||||
&lt;/nav&gt;
|
||||
</code></pre>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
<title>Getting Started with Hugo</title>
|
||||
<link>http://localhost:1313/post/hugoisforlovers/</link>
|
||||
<pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/post/hugoisforlovers/</guid>
|
||||
<description>
|
||||
|
||||
<h2 id="step-1-install-hugo:c57cc0038c788519b441e0331c8bebc7">Step 1. Install Hugo</h2>
|
||||
|
||||
<p>Goto <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="http://localhost:1313/overview/installing/">installing hugo</a></p>
|
||||
|
||||
<h2 id="step-2-build-the-docs:c57cc0038c788519b441e0331c8bebc7">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
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; in 27 ms
|
||||
&gt; Web Server is available at http://localhost:1313
|
||||
&gt; Press ctrl+c to stop
|
||||
</code></pre>
|
||||
|
||||
<p>Once you&rsquo;ve gotten here, follow along the rest of this page on your local build.</p>
|
||||
|
||||
<h2 id="step-3-change-the-docs-site:c57cc0038c788519b441e0331c8bebc7">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
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; in 27 ms
|
||||
&gt; Web Server is available at http://localhost:1313
|
||||
&gt; Watching for changes in /Users/spf13/Code/hugo/docs/content
|
||||
&gt; 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>&gt; Change detected, rebuilding site
|
||||
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; 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&rsquo;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:c57cc0038c788519b441e0331c8bebc7">Step 4. Have fun</h2>
|
||||
|
||||
<p>The best way to learn something is to play with it.</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
</channel>
|
||||
</rss>
|
||||
138
exampleSite/public/code/index.html
Normal file
138
exampleSite/public/code/index.html
Normal file
@@ -0,0 +1,138 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
code · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/code/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="page-heading">
|
||||
|
||||
code
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="markdown">
|
||||
<p>TODO: Page not complete yet.</p>
|
||||
|
||||
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
137
exampleSite/public/colophon/index.html
Normal file
137
exampleSite/public/colophon/index.html
Normal file
@@ -0,0 +1,137 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
colophon · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/colophon/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="page-heading">
|
||||
|
||||
about this site
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="markdown">
|
||||
<p>This website is the place where I write about JavaScript, git, and tech. It is also a personal homepage.</p>
|
||||
|
||||
<p>The site is built with <a target="_blank" href="//gohugo.io">Hugo</a>—a static site generator made with Go and is hosted on GitHub Pages. The website <a target="_blank" href="//github.com/nishanths/nishanths.me">source code</a> is available on GitHub. It uses the <a target="_blank" href="//github.com/nishanths/cocoa-hugo-theme">cocoa</a> theme. The posts are written in Markdown.</p>
|
||||
|
||||
<p>The primary font face is Proxima Nova and the monospace font face is Ubuntu Mono. The social icons are from the Ionicons font set. CSS classes for code syntax highlighting are inserted during compile-time by Hugo using Pygments.</p>
|
||||
|
||||
<p>If you find errors, <a href="https://github.com/nishanths/nishanths.me/issues">please let me know</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
599
exampleSite/public/css/main.css
Normal file
599
exampleSite/public/css/main.css
Normal file
@@ -0,0 +1,599 @@
|
||||
@import url(https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,700);
|
||||
@import url(http://fonts.googleapis.com/css?family=Ubuntu+Mono:400,400italic,700,700italic);
|
||||
@import url(http://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css);
|
||||
@import url(http://fonts.googleapis.com/css?family=Raleway:200);
|
||||
.dark {
|
||||
color: #333333 !important;
|
||||
}
|
||||
.light {
|
||||
color: #b7b7b7 !important;
|
||||
}
|
||||
.accent {
|
||||
color: #21bb5b !important;
|
||||
}
|
||||
*,
|
||||
*:before,
|
||||
*:after {
|
||||
box-sizing: border-box;
|
||||
}
|
||||
a,
|
||||
a:visited,
|
||||
a:focus,
|
||||
a:active {
|
||||
text-decoration: none;
|
||||
}
|
||||
html {
|
||||
height: 100%;
|
||||
font-size: 16px;
|
||||
}
|
||||
body {
|
||||
display: -webkit-flex;
|
||||
display: -moz-flex;
|
||||
display: -ms-flexbox;
|
||||
display: -ms-flex;
|
||||
display: flex;
|
||||
-webkit-flex-direction: column;
|
||||
-moz-flex-direction: column;
|
||||
-ms-flex-direction: column;
|
||||
flex-direction: column;
|
||||
-webkit-align-items: center;
|
||||
-moz-align-items: center;
|
||||
-ms-align-items: center;
|
||||
align-items: center;
|
||||
-webkit-justify-content: flex-start;
|
||||
-moz-justify-content: flex-start;
|
||||
-ms-justify-content: flex-start;
|
||||
justify-content: flex-start;
|
||||
width: 100%;
|
||||
min-height: 100%;
|
||||
font-weight: 400;
|
||||
font-family: 'ProximaNova', 'Source Sans Pro', 'Helvetica Neue', 'Arial' sans-serif;
|
||||
color: #333333;
|
||||
line-height: 1.6;
|
||||
text-rendering: optimizeLegibility !important;
|
||||
-webkit-font-smoothing: subpixel-antialiased;
|
||||
font-smoothing: subpixel-antialiased;
|
||||
}
|
||||
@media (min-width: 550px) {
|
||||
body {
|
||||
-webkit-justify-content: center;
|
||||
-moz-justify-content: center;
|
||||
-ms-justify-content: center;
|
||||
justify-content: center;
|
||||
}
|
||||
}
|
||||
.icon {
|
||||
text-rendering: geometricPrecision !important;
|
||||
}
|
||||
.section {
|
||||
display: -webkit-flex;
|
||||
display: -moz-flex;
|
||||
display: -ms-flexbox;
|
||||
display: -ms-flex;
|
||||
display: flex;
|
||||
-webkit-justify-content: center;
|
||||
-moz-justify-content: center;
|
||||
-ms-justify-content: center;
|
||||
justify-content: center;
|
||||
-webkit-align-items: center;
|
||||
-moz-align-items: center;
|
||||
-ms-align-items: center;
|
||||
align-items: center;
|
||||
width: 100%;
|
||||
}
|
||||
.container {
|
||||
display: -webkit-flex;
|
||||
display: -moz-flex;
|
||||
display: -ms-flexbox;
|
||||
display: -ms-flex;
|
||||
display: flex;
|
||||
width: 100%;
|
||||
}
|
||||
@media (min-width: 550px) {
|
||||
.section {
|
||||
padding: 0 20px;
|
||||
margin-left: 100px;
|
||||
margin-right: 100px;
|
||||
max-width: 900px;
|
||||
}
|
||||
}
|
||||
.section.header {
|
||||
-webkit-order: 0;
|
||||
-moz-order: 0;
|
||||
-ms-order: 0;
|
||||
order: 0;
|
||||
}
|
||||
.section.icons {
|
||||
-webkit-order: 1;
|
||||
-moz-order: 1;
|
||||
-ms-order: 1;
|
||||
order: 1;
|
||||
}
|
||||
.section.main {
|
||||
-webkit-order: 2;
|
||||
-moz-order: 2;
|
||||
-ms-order: 2;
|
||||
order: 2;
|
||||
}
|
||||
@media (min-width: 550px) {
|
||||
.section.header {
|
||||
-webkit-order: 0;
|
||||
-moz-order: 0;
|
||||
-ms-order: 0;
|
||||
order: 0;
|
||||
}
|
||||
.section.icons {
|
||||
-webkit-order: 2;
|
||||
-moz-order: 2;
|
||||
-ms-order: 2;
|
||||
order: 2;
|
||||
}
|
||||
.section.main {
|
||||
-webkit-order: 1;
|
||||
-moz-order: 1;
|
||||
-ms-order: 1;
|
||||
order: 1;
|
||||
}
|
||||
}
|
||||
.section.header {
|
||||
background-color: #21bb5b;
|
||||
}
|
||||
.section.header .container {
|
||||
-webkit-align-items: center;
|
||||
-moz-align-items: center;
|
||||
-ms-align-items: center;
|
||||
align-items: center;
|
||||
-webkit-justify-content: center;
|
||||
-moz-justify-content: center;
|
||||
-ms-justify-content: center;
|
||||
justify-content: center;
|
||||
}
|
||||
.section.header .content {
|
||||
display: -webkit-flex;
|
||||
display: -moz-flex;
|
||||
display: -ms-flexbox;
|
||||
display: -ms-flex;
|
||||
display: flex;
|
||||
-webkit-flex-direction: column;
|
||||
-moz-flex-direction: column;
|
||||
-ms-flex-direction: column;
|
||||
flex-direction: column;
|
||||
-webkit-align-items: center;
|
||||
-moz-align-items: center;
|
||||
-ms-align-items: center;
|
||||
align-items: center;
|
||||
}
|
||||
.section.header .name {
|
||||
font-size: 18px;
|
||||
font-family: 'ProximaNova', 'Source Sans Pro', 'Helvetica Neue', 'Arial' sans-serif;
|
||||
letter-spacing: -0.005rem;
|
||||
text-transform: uppercase;
|
||||
font-weight: 700;
|
||||
-moz-osx-font-smoothing: grayscale;
|
||||
-webkit-font-smoothing: antialiased;
|
||||
font-smoothing: antialiased;
|
||||
color: #333333;
|
||||
color: #fefefe;
|
||||
}
|
||||
.section.header nav {
|
||||
font-size: 14px;
|
||||
margin-bottom: 16px;
|
||||
}
|
||||
.section.header nav ul {
|
||||
list-style: none;
|
||||
text-align: center;
|
||||
display: -webkit-inline-flex;
|
||||
display: -moz-inline-flex;
|
||||
display: -ms-inline-flexbox;
|
||||
display: -ms-inline-flex;
|
||||
display: inline-flex;
|
||||
}
|
||||
.section.header nav ul a {
|
||||
margin-right: 12px;
|
||||
}
|
||||
.section.header nav ul a:last-child {
|
||||
margin-right: 0;
|
||||
}
|
||||
.section.header nav ul li {
|
||||
color: #fefefe;
|
||||
-webkit-transition: color 0.1s cubic-bezier(0.47, 0, 0.75, 0.72);
|
||||
-moz-transition: color 0.1s cubic-bezier(0.47, 0, 0.75, 0.72);
|
||||
-ms-transition: color 0.1s cubic-bezier(0.47, 0, 0.75, 0.72);
|
||||
-o-transition: color 0.1s cubic-bezier(0.47, 0, 0.75, 0.72);
|
||||
}
|
||||
.section.header nav ul li:hover {
|
||||
color: #fefefe;
|
||||
}
|
||||
@media (min-width: 550px) {
|
||||
.section.header {
|
||||
background-color: transparent;
|
||||
}
|
||||
.section.header .container {
|
||||
-webkit-justify-content: flex-start;
|
||||
-moz-justify-content: flex-start;
|
||||
-ms-justify-content: flex-start;
|
||||
justify-content: flex-start;
|
||||
}
|
||||
.section.header .content {
|
||||
-webkit-align-items: flex-start;
|
||||
-moz-align-items: flex-start;
|
||||
-ms-align-items: flex-start;
|
||||
align-items: flex-start;
|
||||
}
|
||||
.section.header .name {
|
||||
color: #333333;
|
||||
}
|
||||
.section.header nav {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
.section.header nav ul {
|
||||
text-align: left;
|
||||
}
|
||||
.section.header nav ul li {
|
||||
color: #b7b7b7;
|
||||
}
|
||||
.section.header nav ul li:hover {
|
||||
color: #333333;
|
||||
}
|
||||
}
|
||||
.section.icons {
|
||||
background-color: #21bb5b;
|
||||
}
|
||||
.section.icons .container {
|
||||
-webkit-align-items: center;
|
||||
-moz-align-items: center;
|
||||
-ms-align-items: center;
|
||||
align-items: center;
|
||||
-webkit-justify-content: center;
|
||||
-moz-justify-content: center;
|
||||
-ms-justify-content: center;
|
||||
justify-content: center;
|
||||
}
|
||||
.section.icons .content a {
|
||||
margin-right: 4px;
|
||||
color: #fefefe;
|
||||
-webkit-transition: color 0.1s cubic-bezier(0.47, 0, 0.75, 0.72);
|
||||
-moz-transition: color 0.1s cubic-bezier(0.47, 0, 0.75, 0.72);
|
||||
-ms-transition: color 0.1s cubic-bezier(0.47, 0, 0.75, 0.72);
|
||||
-o-transition: color 0.1s cubic-bezier(0.47, 0, 0.75, 0.72);
|
||||
}
|
||||
.section.icons .content a:last-child {
|
||||
margin-right: 0;
|
||||
}
|
||||
.section.icons .content a:hover {
|
||||
color: #fefefe;
|
||||
}
|
||||
.section.icons .content a .icon {
|
||||
font-size: 16px;
|
||||
}
|
||||
.section.icons .content a .icon.larger {
|
||||
font-size: 18px;
|
||||
}
|
||||
@media (min-width: 550px) {
|
||||
.section.icons {
|
||||
background-color: transparent;
|
||||
}
|
||||
.section.icons .container {
|
||||
-webkit-justify-content: flex-start;
|
||||
-moz-justify-content: flex-start;
|
||||
-ms-justify-content: flex-start;
|
||||
justify-content: flex-start;
|
||||
}
|
||||
.section.icons .content a {
|
||||
color: #b7b7b7;
|
||||
}
|
||||
.section.icons .content a:hover {
|
||||
color: #333333;
|
||||
}
|
||||
}
|
||||
.section.main .container {
|
||||
-webkit-align-items: center;
|
||||
-moz-align-items: center;
|
||||
-ms-align-items: center;
|
||||
align-items: center;
|
||||
-webkit-justify-content: flex-start;
|
||||
-moz-justify-content: flex-start;
|
||||
-ms-justify-content: flex-start;
|
||||
justify-content: flex-start;
|
||||
}
|
||||
.section.main .content {
|
||||
color: #333333;
|
||||
font-size: 16px;
|
||||
}
|
||||
.section.main .content .page-heading {
|
||||
font-size: 18px;
|
||||
font-family: 'ProximaNova', 'Source Sans Pro', 'Helvetica Neue', 'Arial' sans-serif;
|
||||
letter-spacing: -0.005rem;
|
||||
text-transform: uppercase;
|
||||
font-weight: 700;
|
||||
-moz-osx-font-smoothing: grayscale;
|
||||
-webkit-font-smoothing: antialiased;
|
||||
font-smoothing: antialiased;
|
||||
color: #333333;
|
||||
margin-bottom: 16px;
|
||||
}
|
||||
.section.main .content .front-matter .page-heading {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
.section.main .content .front-matter .meta {
|
||||
font-size: 14px;
|
||||
color: #b7b7b7;
|
||||
display: -webkit-flex;
|
||||
display: -moz-flex;
|
||||
display: -ms-flexbox;
|
||||
display: -ms-flex;
|
||||
display: flex;
|
||||
margin-bottom: 32px;
|
||||
}
|
||||
.section.main .content .front-matter .date,
|
||||
.section.main .content .front-matter .word-count,
|
||||
.section.main .content .front-matter .reading-time .middot {
|
||||
display: none;
|
||||
}
|
||||
.section.main .content .front-matter .middot {
|
||||
font-size: 6px;
|
||||
margin: 0 6px;
|
||||
display: inline;
|
||||
vertical-align: middle;
|
||||
}
|
||||
.section.main .content .front-matter .middot:before {
|
||||
content: "•";
|
||||
}
|
||||
@media (min-width: 550px) {
|
||||
.section.main .content .front-matter .date,
|
||||
.section.main .content .front-matter .word-count,
|
||||
.section.main .content .front-matter .reading-time .middot {
|
||||
display: initial;
|
||||
}
|
||||
}
|
||||
.section.main .container.f04 {
|
||||
-webkit-justify-content: center;
|
||||
-moz-justify-content: center;
|
||||
-ms-justify-content: center;
|
||||
justify-content: center;
|
||||
}
|
||||
.section.main .container.f04 .content {
|
||||
display: -webkit-flex;
|
||||
display: -moz-flex;
|
||||
display: -ms-flexbox;
|
||||
display: -ms-flex;
|
||||
display: flex;
|
||||
-webkit-flex-direction: column;
|
||||
-moz-flex-direction: column;
|
||||
-ms-flex-direction: column;
|
||||
flex-direction: column;
|
||||
-webkit-align-items: center;
|
||||
-moz-align-items: center;
|
||||
-ms-align-items: center;
|
||||
align-items: center;
|
||||
}
|
||||
.section.main .container.f04 .content .num {
|
||||
margin: 30px 0px 30px 0;
|
||||
font-weight: 200;
|
||||
font-family: 'Raleway', 'Helvetica Neue', 'Arial', sans-serif;
|
||||
font-size: 50px;
|
||||
}
|
||||
.section.main .container.f04 .content .detail {
|
||||
margin-bottom: 40px;
|
||||
}
|
||||
@media (min-width: 550px) {
|
||||
.section.main .container.f04 {
|
||||
-webkit-justify-content: flex-start;
|
||||
-moz-justify-content: flex-start;
|
||||
-ms-justify-content: flex-start;
|
||||
justify-content: flex-start;
|
||||
}
|
||||
.section.main .container.f04 .content {
|
||||
-webkit-align-items: flex-start;
|
||||
-moz-align-items: flex-start;
|
||||
-ms-align-items: flex-start;
|
||||
align-items: flex-start;
|
||||
}
|
||||
.section.main .container.f04 .content .num {
|
||||
margin: 0 0 10px 0;
|
||||
font-size: 32px;
|
||||
}
|
||||
.section.main .container.f04 .content .detail {
|
||||
margin-bottom: 30px;
|
||||
}
|
||||
}
|
||||
.section.main .container .content .post-item {
|
||||
display: -webkit-flex;
|
||||
display: -moz-flex;
|
||||
display: -ms-flexbox;
|
||||
display: -ms-flex;
|
||||
display: flex;
|
||||
-webkit-align-items: center;
|
||||
-moz-align-items: center;
|
||||
-ms-align-items: center;
|
||||
align-items: center;
|
||||
list-style: none;
|
||||
}
|
||||
.section.main .container .content .post-item .meta {
|
||||
font-size: 14px;
|
||||
color: #b7b7b7;
|
||||
min-width: 100px;
|
||||
text-align: right;
|
||||
margin-right: 20px;
|
||||
}
|
||||
.section {
|
||||
padding: 0 20px;
|
||||
}
|
||||
.section.header {
|
||||
padding-top: 32px;
|
||||
padding-bottom: 16px;
|
||||
}
|
||||
.section.icons {
|
||||
padding-top: 0;
|
||||
padding-bottom: 32px;
|
||||
}
|
||||
.section.main {
|
||||
padding-top: 32px;
|
||||
padding-bottom: 32px;
|
||||
}
|
||||
@media (min-width: 550px) {
|
||||
.container {
|
||||
margin: 0 20px;
|
||||
}
|
||||
.section.header {
|
||||
padding-top: 60px;
|
||||
padding-bottom: 60px;
|
||||
}
|
||||
.section.icons {
|
||||
padding-top: 60px;
|
||||
padding-bottom: 60px;
|
||||
}
|
||||
.section.main {
|
||||
padding-top: 0;
|
||||
padding-bottom: 0;
|
||||
}
|
||||
.section.main.post {
|
||||
padding-top: 60px;
|
||||
padding-bottom: 60px;
|
||||
}
|
||||
}
|
||||
a {
|
||||
color: #21bb5b;
|
||||
}
|
||||
.section.main .content .markdown h1,
|
||||
.section.main .content .markdown h2,
|
||||
.section.main .content .markdown h3,
|
||||
.section.main .content .markdown h4,
|
||||
.section.main .content .markdown h5,
|
||||
.section.main .content .markdown h6 {
|
||||
font-size: 18px;
|
||||
font-family: 'ProximaNova', 'Source Sans Pro', 'Helvetica Neue', 'Arial' sans-serif;
|
||||
letter-spacing: -0.005rem;
|
||||
text-transform: uppercase;
|
||||
font-weight: 700;
|
||||
-moz-osx-font-smoothing: grayscale;
|
||||
-webkit-font-smoothing: antialiased;
|
||||
font-smoothing: antialiased;
|
||||
color: #333333;
|
||||
}
|
||||
.section.main .content .markdown h1 {
|
||||
font-size: 1.75rem;
|
||||
margin-bottom: 2rem;
|
||||
}
|
||||
.section.main .content .markdown h2 {
|
||||
font-size: 1.5rem;
|
||||
margin-bottom: 1.5rem;
|
||||
}
|
||||
.section.main .content .markdown h3 {
|
||||
font-size: 1em;
|
||||
margin-bottom: 1rem;
|
||||
}
|
||||
.section.main .content .markdown h4,
|
||||
.section.main .content .markdown h5,
|
||||
.section.main .content .markdown h6 {
|
||||
font-size: 1rem;
|
||||
margin-bottom: 1rem;
|
||||
letter-spacing: none;
|
||||
text-transform: none;
|
||||
}
|
||||
.section.main .content .markdown code,
|
||||
.section.main .content .markdown pre {
|
||||
font-family: 'Ubuntu Mono', 'Menlo', monospace;
|
||||
font-size: 15px;
|
||||
background-color: #f9f9f9;
|
||||
}
|
||||
.section.main .content .markdown code {
|
||||
/* enclosed by single backtick (`) */
|
||||
padding: .15em .5em;
|
||||
color: #a10c31;
|
||||
border-radius: 2px;
|
||||
}
|
||||
.section.main .content .markdown pre {
|
||||
/* Hugo specific: consider using the 'highlight' shortcode */
|
||||
display: block;
|
||||
margin-top: 1rem;
|
||||
margin-bottom: 2rem;
|
||||
padding: 1rem;
|
||||
line-height: 1.5em;
|
||||
white-space: pre;
|
||||
white-space: pre-wrap;
|
||||
word-break: break-all;
|
||||
word-wrap: break-word;
|
||||
}
|
||||
.section.main .content .markdown pre code {
|
||||
/* enclosed by 4 backticks (````) */
|
||||
padding: 0;
|
||||
font-size: 15px;
|
||||
}
|
||||
.section.main .content .markdown p {
|
||||
/* Invoked by line break */
|
||||
font-size: 1rem;
|
||||
margin-top: 0;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
.section.main .content .markdown ul,
|
||||
.section.main .content .markdown ol,
|
||||
.section.main .content .markdown dl {
|
||||
margin-top: 1rem;
|
||||
margin-bottom: 2rem;
|
||||
}
|
||||
.section.main .content .markdown dt {
|
||||
font-weight: bold;
|
||||
}
|
||||
.section.main .content .markdown dd {
|
||||
margin-bottom: .5rem;
|
||||
}
|
||||
.section.main .content .markdown ul {
|
||||
margin-bottom: 1.25rem;
|
||||
}
|
||||
.section.main .content .markdown li {
|
||||
list-style-type: disc;
|
||||
list-style-position: inside;
|
||||
}
|
||||
.section.main .content .markdown hr {
|
||||
position: relative;
|
||||
margin: 1.75rem 0;
|
||||
border: 0;
|
||||
border-top: 1px solid #d1d1d1;
|
||||
border-top: 1px solid #eaeaea;
|
||||
}
|
||||
.section.main .content .markdown abbr {
|
||||
font-size: 0.85rem;
|
||||
font-weight: bold;
|
||||
color: #666666;
|
||||
text-transform: uppercase;
|
||||
}
|
||||
.section.main .content .markdown abbr[title] {
|
||||
cursor: help;
|
||||
border-bottom: 1px dotted #d1d1d1;
|
||||
}
|
||||
.section.main .content .markdown blockquote {
|
||||
padding: .5rem 1rem;
|
||||
margin: .8rem 0;
|
||||
color: #7a7a7a;
|
||||
border-left: .25rem solid #e5e5e5;
|
||||
}
|
||||
.section.main .content .markdown blockquote p:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
@media (min-width: 550px) {
|
||||
.section.main .content .markdown blockquote {
|
||||
padding-right: 5rem;
|
||||
padding-left: 1.25rem;
|
||||
}
|
||||
}
|
||||
.section.main .content .markdown img {
|
||||
display: block;
|
||||
margin: 0 0 1rem;
|
||||
max-width: 100%;
|
||||
}
|
||||
.section.main .content .markdown table {
|
||||
margin-bottom: 1rem;
|
||||
width: 100%;
|
||||
border: 1px solid #e5e5e5;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
.section.main .content .markdown td,
|
||||
.section.main .content .markdown th {
|
||||
padding: .25rem .5rem;
|
||||
border: 1px solid #e5e5e5;
|
||||
}
|
||||
.section.main .content .markdown tbody tr:nth-child(odd) td,
|
||||
.section.main .content .markdown tbody tr:nth-child(odd) th {
|
||||
background-color: #f9f9f9;
|
||||
}
|
||||
61
exampleSite/public/css/pygments.css
Normal file
61
exampleSite/public/css/pygments.css
Normal file
@@ -0,0 +1,61 @@
|
||||
.hll { background-color: #ffffcc }
|
||||
.c { color: #999988; font-style: italic } /* Comment */
|
||||
.err { color: #a61717; background-color: #e3d2d2 } /* Error */
|
||||
.k { color: #000000; font-weight: bold } /* Keyword */
|
||||
.o { color: #000000; font-weight: bold } /* Operator */
|
||||
.cm { color: #999988; font-style: italic } /* Comment.Multiline */
|
||||
.cp { color: #999999; font-weight: bold; font-style: italic } /* Comment.Preproc */
|
||||
.c1 { color: #999988; font-style: italic } /* Comment.Single */
|
||||
.cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
|
||||
.gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
|
||||
.ge { color: #000000; font-style: italic } /* Generic.Emph */
|
||||
.gr { color: #aa0000 } /* Generic.Error */
|
||||
.gh { color: #999999 } /* Generic.Heading */
|
||||
.gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
|
||||
.go { color: #888888 } /* Generic.Output */
|
||||
.gp { color: #555555 } /* Generic.Prompt */
|
||||
.gs { font-weight: bold } /* Generic.Strong */
|
||||
.gu { color: #aaaaaa } /* Generic.Subheading */
|
||||
.gt { color: #aa0000 } /* Generic.Traceback */
|
||||
.kc { color: #000000; font-weight: bold } /* Keyword.Constant */
|
||||
.kd { color: #000000; font-weight: bold } /* Keyword.Declaration */
|
||||
.kn { color: #000000; font-weight: bold } /* Keyword.Namespace */
|
||||
.kp { color: #000000; font-weight: bold } /* Keyword.Pseudo */
|
||||
.kr { color: #000000; font-weight: bold } /* Keyword.Reserved */
|
||||
.kt { color: #445588; font-weight: bold } /* Keyword.Type */
|
||||
.m { color: #009999 } /* Literal.Number */
|
||||
.s { color: #d01040 } /* Literal.String */
|
||||
.na { color: #008080 } /* Name.Attribute */
|
||||
.nb { color: #0086B3 } /* Name.Builtin */
|
||||
.nc { color: #445588; font-weight: bold } /* Name.Class */
|
||||
.no { color: #008080 } /* Name.Constant */
|
||||
.nd { color: #3c5d5d; font-weight: bold } /* Name.Decorator */
|
||||
.ni { color: #800080 } /* Name.Entity */
|
||||
.ne { color: #990000; font-weight: bold } /* Name.Exception */
|
||||
.nf { color: #990000; font-weight: bold } /* Name.Function */
|
||||
.nl { color: #990000; font-weight: bold } /* Name.Label */
|
||||
.nn { color: #555555 } /* Name.Namespace */
|
||||
.nt { color: #000080 } /* Name.Tag */
|
||||
.nv { color: #008080 } /* Name.Variable */
|
||||
.ow { color: #000000; font-weight: bold } /* Operator.Word */
|
||||
.w { color: #bbbbbb } /* Text.Whitespace */
|
||||
.mf { color: #009999 } /* Literal.Number.Float */
|
||||
.mh { color: #009999 } /* Literal.Number.Hex */
|
||||
.mi { color: #009999 } /* Literal.Number.Integer */
|
||||
.mo { color: #009999 } /* Literal.Number.Oct */
|
||||
.sb { color: #d01040 } /* Literal.String.Backtick */
|
||||
.sc { color: #d01040 } /* Literal.String.Char */
|
||||
.sd { color: #d01040 } /* Literal.String.Doc */
|
||||
.s2 { color: #d01040 } /* Literal.String.Double */
|
||||
.se { color: #d01040 } /* Literal.String.Escape */
|
||||
.sh { color: #d01040 } /* Literal.String.Heredoc */
|
||||
.si { color: #d01040 } /* Literal.String.Interpol */
|
||||
.sx { color: #d01040 } /* Literal.String.Other */
|
||||
.sr { color: #009926 } /* Literal.String.Regex */
|
||||
.s1 { color: #d01040 } /* Literal.String.Single */
|
||||
.ss { color: #990073 } /* Literal.String.Symbol */
|
||||
.bp { color: #999999 } /* Name.Builtin.Pseudo */
|
||||
.vc { color: #008080 } /* Name.Variable.Class */
|
||||
.vg { color: #008080 } /* Name.Variable.Global */
|
||||
.vi { color: #008080 } /* Name.Variable.Instance */
|
||||
.il { color: #009999 } /* Literal.Number.Integer.Long */
|
||||
48
exampleSite/public/css/reset.css
Normal file
48
exampleSite/public/css/reset.css
Normal file
@@ -0,0 +1,48 @@
|
||||
/* http://meyerweb.com/eric/tools/css/reset/
|
||||
v2.0 | 20110126
|
||||
License: none (public domain)
|
||||
*/
|
||||
|
||||
html, body, div, span, applet, object, iframe,
|
||||
h1, h2, h3, h4, h5, h6, p, blockquote, pre,
|
||||
a, abbr, acronym, address, big, cite, code,
|
||||
del, dfn, em, img, ins, kbd, q, s, samp,
|
||||
small, strike, strong, sub, sup, tt, var,
|
||||
b, u, i, center,
|
||||
dl, dt, dd, ol, ul, li,
|
||||
fieldset, form, label, legend,
|
||||
table, caption, tbody, tfoot, thead, tr, th, td,
|
||||
article, aside, canvas, details, embed,
|
||||
figure, figcaption, footer, header, hgroup,
|
||||
menu, nav, output, ruby, section, summary,
|
||||
time, mark, audio, video {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
border: 0;
|
||||
font-size: 100%;
|
||||
font: inherit;
|
||||
vertical-align: baseline;
|
||||
}
|
||||
/* HTML5 display-role reset for older browsers */
|
||||
article, aside, details, figcaption, figure,
|
||||
footer, header, hgroup, menu, nav, section {
|
||||
display: block;
|
||||
}
|
||||
body {
|
||||
line-height: 1;
|
||||
}
|
||||
ol, ul {
|
||||
list-style: none;
|
||||
}
|
||||
blockquote, q {
|
||||
quotes: none;
|
||||
}
|
||||
blockquote:before, blockquote:after,
|
||||
q:before, q:after {
|
||||
content: '';
|
||||
content: none;
|
||||
}
|
||||
table {
|
||||
border-collapse: collapse;
|
||||
border-spacing: 0;
|
||||
}
|
||||
141
exampleSite/public/fixed/index.html
Normal file
141
exampleSite/public/fixed/index.html
Normal file
@@ -0,0 +1,141 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
Fixeds · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/fixed/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="page-heading">
|
||||
|
||||
Fixeds
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Aug 22, 2015</div>
|
||||
<a href="http://localhost:1313/about/"><div>about</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Aug 19, 2015</div>
|
||||
<a href="http://localhost:1313/code/"><div>code</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
|
||||
49
exampleSite/public/fixed/index.xml
Normal file
49
exampleSite/public/fixed/index.xml
Normal file
@@ -0,0 +1,49 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
|
||||
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<channel>
|
||||
<title>Fixeds on Hugo Themes</title>
|
||||
<link>http://localhost:1313/fixed/</link>
|
||||
<description>Recent content in Fixeds on Hugo Themes</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-US</language>
|
||||
<lastBuildDate>Sat, 22 Aug 2015 06:42:21 -0700</lastBuildDate>
|
||||
<atom:link href="http://localhost:1313/fixed/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
<item>
|
||||
<title>about</title>
|
||||
<link>http://localhost:1313/about/</link>
|
||||
<pubDate>Sat, 22 Aug 2015 06:42:21 -0700</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/about/</guid>
|
||||
<description><p>TODO: Page not complete yet.</p>
|
||||
|
||||
<p>Information about you.</p>
|
||||
|
||||
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
<title>code</title>
|
||||
<link>http://localhost:1313/code/</link>
|
||||
<pubDate>Wed, 19 Aug 2015 20:29:37 -0700</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/code/</guid>
|
||||
<description><p>TODO: Page not complete yet.</p>
|
||||
|
||||
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
</channel>
|
||||
</rss>
|
||||
BIN
exampleSite/public/img/favicon.ico
Normal file
BIN
exampleSite/public/img/favicon.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 361 KiB |
135
exampleSite/public/index.html
Normal file
135
exampleSite/public/index.html
Normal file
@@ -0,0 +1,135 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
Hugo Themes · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="page-heading">Posts</div>
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Aug 22, 2015</div>
|
||||
<a href="http://localhost:1313/posts/redirect-webpages-html/"><div>Redirect webpages using HTML</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
|
||||
74
exampleSite/public/index.xml
Normal file
74
exampleSite/public/index.xml
Normal file
@@ -0,0 +1,74 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
|
||||
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<channel>
|
||||
<title>Hugo Themes</title>
|
||||
<link>http://localhost:1313/</link>
|
||||
<description>Recent content on Hugo Themes</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-US</language>
|
||||
<lastBuildDate>Sat, 22 Aug 2015 15:45:30 -0700</lastBuildDate>
|
||||
<atom:link href="http://localhost:1313/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
<item>
|
||||
<title>Redirect webpages using HTML</title>
|
||||
<link>http://localhost:1313/posts/redirect-webpages-html/</link>
|
||||
<pubDate>Sat, 22 Aug 2015 15:45:30 -0700</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/posts/redirect-webpages-html/</guid>
|
||||
<description>
|
||||
|
||||
<p>Webpage redirection is great for automatically redirecting people visiting an old URL to a new URL where the content has moved to. It can be done using JavaScript, but there is also a convenient HTML-only solution.</p>
|
||||
|
||||
<p>To redirect visitors reaching <code>yourwebsite.com/blog</code> to <code>yourwebsite.com/posts</code>, add this to the <code>&lt;head&gt;</code> section of the HTML at <code>yourwebsite.com/blog</code>:</p>
|
||||
|
||||
<p><div class="highlight"><pre><span class="nt">&lt;meta</span> <span class="na">http-equiv=</span><span class="s">&quot;refresh&quot;</span> <span class="na">content=</span><span class="s">&quot;0;url=&#39;/posts&#39;&quot;</span> <span class="nt">/&gt;</span>
|
||||
<span class="nt">&lt;link</span> <span class="na">rel=</span><span class="s">&quot;canonical&quot;</span> <span class="na">href=</span><span class="s">&quot;/posts&quot;</span> <span class="nt">/&gt;</span>
|
||||
</pre></div>
|
||||
</p>
|
||||
|
||||
<h3 id="walkthrough:afdc852818bb97af4efb4d34b2fcce3b">walkthrough</h3>
|
||||
|
||||
<p>Setting <code>http-equiv=&quot;refresh&quot;</code> in the first line performs the actual redirect. The number in the <code>content</code> attribute specified in seconds tells the browser how long to wait before redirecting. In this example, <code>0</code> redirects immediately. Increasing the wait may be useful for briefly displaying a 404 page before automatically switching to the home page. The <code>url</code> specfies the destination for the redirect. In this example, we wanted to switch to <code>/posts</code>.</p>
|
||||
|
||||
<p>The second line is optional; it helps search engines know which the preferred version of the page is. Usually, this is the redirect destination.</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
<title>about</title>
|
||||
<link>http://localhost:1313/about/</link>
|
||||
<pubDate>Sat, 22 Aug 2015 06:42:21 -0700</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/about/</guid>
|
||||
<description><p>TODO: Page not complete yet.</p>
|
||||
|
||||
<p>Information about you.</p>
|
||||
|
||||
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
<title>code</title>
|
||||
<link>http://localhost:1313/code/</link>
|
||||
<pubDate>Wed, 19 Aug 2015 20:29:37 -0700</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/code/</guid>
|
||||
<description><p>TODO: Page not complete yet.</p>
|
||||
|
||||
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
|
||||
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
|
||||
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
|
||||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
|
||||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
</channel>
|
||||
</rss>
|
||||
1214
exampleSite/public/post/creating-a-new-theme/index.html
Normal file
1214
exampleSite/public/post/creating-a-new-theme/index.html
Normal file
File diff suppressed because it is too large
Load Diff
458
exampleSite/public/post/goisforlovers/index.html
Normal file
458
exampleSite/public/post/goisforlovers/index.html
Normal file
@@ -0,0 +1,458 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
(Hu)go Template Primer · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/post/goisforlovers/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<p>Hugo uses the excellent <a href="http://golang.org/>">go</a> <a href="http://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="http://golang.org/pkg/html/template/>">go docs</a>
|
||||
provide more details.</p>
|
||||
|
||||
<h2 id="introduction-to-go-templates:4d30d99f79bd431d57546bbed04b7347">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="http://golang.org/pkg/html/template/>">go docs</a>.</p>
|
||||
|
||||
<h2 id="basic-syntax:4d30d99f79bd431d57546bbed04b7347">Basic Syntax</h2>
|
||||
|
||||
<p>Go lang 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:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">Logic</h2>
|
||||
|
||||
<p>Go templates provide the most basic iteration and conditional logic.</p>
|
||||
|
||||
<h3 id="iteration:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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:4d30d99f79bd431d57546bbed04b7347">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>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
199
exampleSite/public/post/hugoisforlovers/index.html
Normal file
199
exampleSite/public/post/hugoisforlovers/index.html
Normal file
@@ -0,0 +1,199 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
Getting Started with Hugo · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/post/hugoisforlovers/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<h2 id="step-1-install-hugo:c57cc0038c788519b441e0331c8bebc7">Step 1. Install Hugo</h2>
|
||||
|
||||
<p>Goto <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="http://localhost:1313/overview/installing/">installing hugo</a></p>
|
||||
|
||||
<h2 id="step-2-build-the-docs:c57cc0038c788519b441e0331c8bebc7">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:c57cc0038c788519b441e0331c8bebc7">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:c57cc0038c788519b441e0331c8bebc7">Step 4. Have fun</h2>
|
||||
|
||||
<p>The best way to learn something is to play with it.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
153
exampleSite/public/post/index.html
Normal file
153
exampleSite/public/post/index.html
Normal file
@@ -0,0 +1,153 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
Posts · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/post/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="page-heading">
|
||||
|
||||
Posts
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Apr 2, 2014</div>
|
||||
<a href="http://localhost:1313/post/goisforlovers/"><div>(Hu)go Template Primer</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Apr 2, 2014</div>
|
||||
<a href="http://localhost:1313/post/hugoisforlovers/"><div>Getting Started with Hugo</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Sep 28, 2014</div>
|
||||
<a href="http://localhost:1313/post/creating-a-new-theme/"><div>Creating a New Theme</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Mar 10, 2014</div>
|
||||
<a href="http://localhost:1313/post/migrate-from-jekyll/"><div>Migrate to Hugo from Jekyll</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
|
||||
1725
exampleSite/public/post/index.xml
Normal file
1725
exampleSite/public/post/index.xml
Normal file
File diff suppressed because it is too large
Load Diff
289
exampleSite/public/post/migrate-from-jekyll/index.html
Normal file
289
exampleSite/public/post/migrate-from-jekyll/index.html
Normal file
@@ -0,0 +1,289 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
Migrate to Hugo from Jekyll · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/post/migrate-from-jekyll/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<h2 id="move-static-content-to-static:964c172ef5e837f03573891408d8d631">Move static content to <code>static</code></h2>
|
||||
|
||||
<p>Jekyll has a rule that any directory not starting with <code>_</code> will be copied as-is to the <code>_site</code> output. Hugo keeps all static content under <code>static</code>. You should therefore move it all there.
|
||||
With Jekyll, something that looked like</p>
|
||||
|
||||
<pre><code>▾ <root>/
|
||||
▾ images/
|
||||
logo.png
|
||||
</code></pre>
|
||||
|
||||
<p>should become</p>
|
||||
|
||||
<pre><code>▾ <root>/
|
||||
▾ static/
|
||||
▾ images/
|
||||
logo.png
|
||||
</code></pre>
|
||||
|
||||
<p>Additionally, you’ll want any files that should reside at the root (such as <code>CNAME</code>) to be moved to <code>static</code>.</p>
|
||||
|
||||
<h2 id="create-your-hugo-configuration-file:964c172ef5e837f03573891408d8d631">Create your Hugo configuration file</h2>
|
||||
|
||||
<p>Hugo can read your configuration as JSON, YAML or TOML. Hugo supports parameters custom configuration too. Refer to the <a href="http://localhost:1313/overview/configuration/">Hugo configuration documentation</a> for details.</p>
|
||||
|
||||
<h2 id="set-your-configuration-publish-folder-to-site:964c172ef5e837f03573891408d8d631">Set your configuration publish folder to <code>_site</code></h2>
|
||||
|
||||
<p>The default is for Jekyll to publish to <code>_site</code> and for Hugo to publish to <code>public</code>. If, like me, you have <a href="http://blog.blindgaenger.net/generate_github_pages_in_a_submodule.html"><code>_site</code> mapped to a git submodule on the <code>gh-pages</code> branch</a>, you’ll want to do one of two alternatives:</p>
|
||||
|
||||
<ol>
|
||||
<li><p>Change your submodule to point to map <code>gh-pages</code> to public instead of <code>_site</code> (recommended).</p>
|
||||
|
||||
<pre><code>git submodule deinit _site
|
||||
git rm _site
|
||||
git submodule add -b gh-pages git@github.com:your-username/your-repo.git public
|
||||
</code></pre></li>
|
||||
|
||||
<li><p>Or, change the Hugo configuration to use <code>_site</code> instead of <code>public</code>.</p>
|
||||
|
||||
<pre><code>{
|
||||
..
|
||||
"publishdir": "_site",
|
||||
..
|
||||
}
|
||||
</code></pre></li>
|
||||
</ol>
|
||||
|
||||
<h2 id="convert-jekyll-templates-to-hugo-templates:964c172ef5e837f03573891408d8d631">Convert Jekyll templates to Hugo templates</h2>
|
||||
|
||||
<p>That’s the bulk of the work right here. The documentation is your friend. You should refer to <a href="http://jekyllrb.com/docs/templates/">Jekyll’s template documentation</a> if you need to refresh your memory on how you built your blog and <a href="http://localhost:1313/layout/templates/">Hugo’s template</a> to learn Hugo’s way.</p>
|
||||
|
||||
<p>As a single reference data point, converting my templates for <a href="http://heyitsalex.net/">heyitsalex.net</a> took me no more than a few hours.</p>
|
||||
|
||||
<h2 id="convert-jekyll-plugins-to-hugo-shortcodes:964c172ef5e837f03573891408d8d631">Convert Jekyll plugins to Hugo shortcodes</h2>
|
||||
|
||||
<p>Jekyll has <a href="http://jekyllrb.com/docs/plugins/">plugins</a>; Hugo has <a href="http://localhost:1313/doc/shortcodes/">shortcodes</a>. It’s fairly trivial to do a port.</p>
|
||||
|
||||
<h3 id="implementation:964c172ef5e837f03573891408d8d631">Implementation</h3>
|
||||
|
||||
<p>As an example, I was using a custom <a href="https://github.com/alexandre-normand/alexandre-normand/blob/74bb12036a71334fdb7dba84e073382fc06908ec/_plugins/image_tag.rb"><code>image_tag</code></a> plugin to generate figures with caption when running Jekyll. As I read about shortcodes, I found Hugo had a nice built-in shortcode that does exactly the same thing.</p>
|
||||
|
||||
<p>Jekyll’s plugin:</p>
|
||||
|
||||
<pre><code>module Jekyll
|
||||
class ImageTag < Liquid::Tag
|
||||
@url = nil
|
||||
@caption = nil
|
||||
@class = nil
|
||||
@link = nil
|
||||
// Patterns
|
||||
IMAGE_URL_WITH_CLASS_AND_CAPTION =
|
||||
IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK = /(\w+)(\s+)((https?:\/\/|\/)(\S+))(\s+)"(.*?)"(\s+)->((https?:\/\/|\/)(\S+))(\s*)/i
|
||||
IMAGE_URL_WITH_CAPTION = /((https?:\/\/|\/)(\S+))(\s+)"(.*?)"/i
|
||||
IMAGE_URL_WITH_CLASS = /(\w+)(\s+)((https?:\/\/|\/)(\S+))/i
|
||||
IMAGE_URL = /((https?:\/\/|\/)(\S+))/i
|
||||
def initialize(tag_name, markup, tokens)
|
||||
super
|
||||
if markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK
|
||||
@class = $1
|
||||
@url = $3
|
||||
@caption = $7
|
||||
@link = $9
|
||||
elsif markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION
|
||||
@class = $1
|
||||
@url = $3
|
||||
@caption = $7
|
||||
elsif markup =~ IMAGE_URL_WITH_CAPTION
|
||||
@url = $1
|
||||
@caption = $5
|
||||
elsif markup =~ IMAGE_URL_WITH_CLASS
|
||||
@class = $1
|
||||
@url = $3
|
||||
elsif markup =~ IMAGE_URL
|
||||
@url = $1
|
||||
end
|
||||
end
|
||||
def render(context)
|
||||
if @class
|
||||
source = "<figure class='#{@class}'>"
|
||||
else
|
||||
source = "<figure>"
|
||||
end
|
||||
if @link
|
||||
source += "<a href=\"#{@link}\">"
|
||||
end
|
||||
source += "<img src=\"#{@url}\">"
|
||||
if @link
|
||||
source += "</a>"
|
||||
end
|
||||
source += "<figcaption>#{@caption}</figcaption>" if @caption
|
||||
source += "</figure>"
|
||||
source
|
||||
end
|
||||
end
|
||||
end
|
||||
Liquid::Template.register_tag('image', Jekyll::ImageTag)
|
||||
</code></pre>
|
||||
|
||||
<p>is written as this Hugo shortcode:</p>
|
||||
|
||||
<pre><code><!-- image -->
|
||||
<figure {{ with .Get "class" }}class="{{.}}"{{ end }}>
|
||||
{{ with .Get "link"}}<a href="{{.}}">{{ end }}
|
||||
<img src="{{ .Get "src" }}" {{ if or (.Get "alt") (.Get "caption") }}alt="{{ with .Get "alt"}}{{.}}{{else}}{{ .Get "caption" }}{{ end }}"{{ end }} />
|
||||
{{ if .Get "link"}}</a>{{ end }}
|
||||
{{ if or (or (.Get "title") (.Get "caption")) (.Get "attr")}}
|
||||
<figcaption>{{ if isset .Params "title" }}
|
||||
{{ .Get "title" }}{{ end }}
|
||||
{{ if or (.Get "caption") (.Get "attr")}}<p>
|
||||
{{ .Get "caption" }}
|
||||
{{ with .Get "attrlink"}}<a href="{{.}}"> {{ end }}
|
||||
{{ .Get "attr" }}
|
||||
{{ if .Get "attrlink"}}</a> {{ end }}
|
||||
</p> {{ end }}
|
||||
</figcaption>
|
||||
{{ end }}
|
||||
</figure>
|
||||
<!-- image -->
|
||||
</code></pre>
|
||||
|
||||
<h3 id="usage:964c172ef5e837f03573891408d8d631">Usage</h3>
|
||||
|
||||
<p>I simply changed:</p>
|
||||
|
||||
<pre><code>{% image full http://farm5.staticflickr.com/4136/4829260124_57712e570a_o_d.jpg "One of my favorite touristy-type photos. I secretly waited for the good light while we were "having fun" and took this. Only regret: a stupid pole in the top-left corner of the frame I had to clumsily get rid of at post-processing." ->http://www.flickr.com/photos/alexnormand/4829260124/in/set-72157624547713078/ %}
|
||||
</code></pre>
|
||||
|
||||
<p>to this (this example uses a slightly extended version named <code>fig</code>, different than the built-in <code>figure</code>):</p>
|
||||
|
||||
<pre><code>{{% fig class="full" src="http://farm5.staticflickr.com/4136/4829260124_57712e570a_o_d.jpg" title="One of my favorite touristy-type photos. I secretly waited for the good light while we were having fun and took this. Only regret: a stupid pole in the top-left corner of the frame I had to clumsily get rid of at post-processing." link="http://www.flickr.com/photos/alexnormand/4829260124/in/set-72157624547713078/" %}}
|
||||
</code></pre>
|
||||
|
||||
<p>As a bonus, the shortcode named parameters are, arguably, more readable.</p>
|
||||
|
||||
<h2 id="finishing-touches:964c172ef5e837f03573891408d8d631">Finishing touches</h2>
|
||||
|
||||
<h3 id="fix-content:964c172ef5e837f03573891408d8d631">Fix content</h3>
|
||||
|
||||
<p>Depending on the amount of customization that was done with each post with Jekyll, this step will require more or less effort. There are no hard and fast rules here except that <code>hugo server --watch</code> is your friend. Test your changes and fix errors as needed.</p>
|
||||
|
||||
<h3 id="clean-up:964c172ef5e837f03573891408d8d631">Clean up</h3>
|
||||
|
||||
<p>You’ll want to remove the Jekyll configuration at this point. If you have anything else that isn’t used, delete it.</p>
|
||||
|
||||
<h2 id="a-practical-example-in-a-diff:964c172ef5e837f03573891408d8d631">A practical example in a diff</h2>
|
||||
|
||||
<p><a href="http://heyitsalex.net/">Hey, it’s Alex</a> was migrated in less than a <em>father-with-kids day</em> from Jekyll to Hugo. You can see all the changes (and screw-ups) by looking at this <a href="https://github.com/alexandre-normand/alexandre-normand/compare/869d69435bd2665c3fbf5b5c78d4c22759d7613a...b7f6605b1265e83b4b81495423294208cc74d610">diff</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
135
exampleSite/public/posts/index.html
Normal file
135
exampleSite/public/posts/index.html
Normal file
@@ -0,0 +1,135 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
Posts · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/posts/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="page-heading">
|
||||
|
||||
Posts
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Aug 22, 2015</div>
|
||||
<a href="http://localhost:1313/posts/redirect-webpages-html/"><div>Redirect webpages using HTML</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
|
||||
38
exampleSite/public/posts/index.xml
Normal file
38
exampleSite/public/posts/index.xml
Normal file
@@ -0,0 +1,38 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
|
||||
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<channel>
|
||||
<title>Posts on Hugo Themes</title>
|
||||
<link>http://localhost:1313/posts/</link>
|
||||
<description>Recent content in Posts on Hugo Themes</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-US</language>
|
||||
<lastBuildDate>Sat, 22 Aug 2015 15:45:30 -0700</lastBuildDate>
|
||||
<atom:link href="http://localhost:1313/posts/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
<item>
|
||||
<title>Redirect webpages using HTML</title>
|
||||
<link>http://localhost:1313/posts/redirect-webpages-html/</link>
|
||||
<pubDate>Sat, 22 Aug 2015 15:45:30 -0700</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/posts/redirect-webpages-html/</guid>
|
||||
<description>
|
||||
|
||||
<p>Webpage redirection is great for automatically redirecting people visiting an old URL to a new URL where the content has moved to. It can be done using JavaScript, but there is also a convenient HTML-only solution.</p>
|
||||
|
||||
<p>To redirect visitors reaching <code>yourwebsite.com/blog</code> to <code>yourwebsite.com/posts</code>, add this to the <code>&lt;head&gt;</code> section of the HTML at <code>yourwebsite.com/blog</code>:</p>
|
||||
|
||||
<p><div class="highlight"><pre><span class="nt">&lt;meta</span> <span class="na">http-equiv=</span><span class="s">&quot;refresh&quot;</span> <span class="na">content=</span><span class="s">&quot;0;url=&#39;/posts&#39;&quot;</span> <span class="nt">/&gt;</span>
|
||||
<span class="nt">&lt;link</span> <span class="na">rel=</span><span class="s">&quot;canonical&quot;</span> <span class="na">href=</span><span class="s">&quot;/posts&quot;</span> <span class="nt">/&gt;</span>
|
||||
</pre></div>
|
||||
</p>
|
||||
|
||||
<h3 id="walkthrough:afdc852818bb97af4efb4d34b2fcce3b">walkthrough</h3>
|
||||
|
||||
<p>Setting <code>http-equiv=&quot;refresh&quot;</code> in the first line performs the actual redirect. The number in the <code>content</code> attribute specified in seconds tells the browser how long to wait before redirecting. In this example, <code>0</code> redirects immediately. Increasing the wait may be useful for briefly displaying a 404 page before automatically switching to the home page. The <code>url</code> specfies the destination for the redirect. In this example, we wanted to switch to <code>/posts</code>.</p>
|
||||
|
||||
<p>The second line is optional; it helps search engines know which the preferred version of the page is. Usually, this is the redirect destination.</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
</channel>
|
||||
</rss>
|
||||
102
exampleSite/public/posts/redirect-webpages-html/index.html
Normal file
102
exampleSite/public/posts/redirect-webpages-html/index.html
Normal file
@@ -0,0 +1,102 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
Redirect webpages using HTML · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/posts/redirect-webpages-html/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section main post">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="front-matter">
|
||||
<a href="http://localhost:1313/posts/redirect-webpages-html/"><div class="page-heading">
|
||||
|
||||
Redirect webpages using HTML
|
||||
|
||||
</div>
|
||||
|
||||
</a>
|
||||
<div class="meta">
|
||||
<div class="date">Aug 22, 2015</div>
|
||||
<div class="word-count"><div class="middot"></div>200 words</div>
|
||||
<div class="reading-time"><div class="middot"></div>1 minute read</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="markdown">
|
||||
|
||||
|
||||
<p>Webpage redirection is great for automatically redirecting people visiting an old URL to a new URL where the content has moved to. It can be done using JavaScript, but there is also a convenient HTML-only solution.</p>
|
||||
|
||||
<p>To redirect visitors reaching <code>yourwebsite.com/blog</code> to <code>yourwebsite.com/posts</code>, add this to the <code><head></code> section of the HTML at <code>yourwebsite.com/blog</code>:</p>
|
||||
|
||||
<p><div class="highlight"><pre><span class="nt"><meta</span> <span class="na">http-equiv=</span><span class="s">"refresh"</span> <span class="na">content=</span><span class="s">"0;url='/posts'"</span> <span class="nt">/></span>
|
||||
<span class="nt"><link</span> <span class="na">rel=</span><span class="s">"canonical"</span> <span class="na">href=</span><span class="s">"/posts"</span> <span class="nt">/></span>
|
||||
</pre></div>
|
||||
</p>
|
||||
|
||||
<h3 id="walkthrough:afdc852818bb97af4efb4d34b2fcce3b">walkthrough</h3>
|
||||
|
||||
<p>Setting <code>http-equiv="refresh"</code> in the first line performs the actual redirect. The number in the <code>content</code> attribute specified in seconds tells the browser how long to wait before redirecting. In this example, <code>0</code> redirects immediately. Increasing the wait may be useful for briefly displaying a 404 page before automatically switching to the home page. The <code>url</code> specfies the destination for the redirect. In this example, we wanted to switch to <code>/posts</code>.</p>
|
||||
|
||||
<p>The second line is optional; it helps search engines know which the preferred version of the page is. Usually, this is the redirect destination.</p>
|
||||
|
||||
<br>
|
||||
<p><a href="http://localhost:1313/">Back home</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
8
exampleSite/public/projects/index.html
Normal file
8
exampleSite/public/projects/index.html
Normal file
@@ -0,0 +1,8 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<link rel="canonical" href="http://localhost:1313/code"/>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
|
||||
<meta http-equiv="refresh" content="0;url=/code"/>
|
||||
</head>
|
||||
</html>
|
||||
25
exampleSite/public/sitemap.xml
Normal file
25
exampleSite/public/sitemap.xml
Normal file
@@ -0,0 +1,25 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
|
||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
||||
|
||||
<url>
|
||||
<loc>http://localhost:1313/</loc>
|
||||
<lastmod>2015-08-22T15:45:30-07:00</lastmod>
|
||||
<priority>0</priority>
|
||||
</url>
|
||||
|
||||
<url>
|
||||
<loc>http://localhost:1313/posts/redirect-webpages-html/</loc>
|
||||
<lastmod>2015-08-22T15:45:30-07:00</lastmod>
|
||||
</url>
|
||||
|
||||
<url>
|
||||
<loc>http://localhost:1313/about/</loc>
|
||||
<lastmod>2015-08-22T06:42:21-07:00</lastmod>
|
||||
</url>
|
||||
|
||||
<url>
|
||||
<loc>http://localhost:1313/code/</loc>
|
||||
<lastmod>2015-08-19T20:29:37-07:00</lastmod>
|
||||
</url>
|
||||
|
||||
</urlset>
|
||||
141
exampleSite/public/tags/development/index.html
Normal file
141
exampleSite/public/tags/development/index.html
Normal file
@@ -0,0 +1,141 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
Development · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/tags/development/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="page-heading">
|
||||
|
||||
Development
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Apr 2, 2014</div>
|
||||
<a href="http://localhost:1313/post/goisforlovers/"><div>(Hu)go Template Primer</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Apr 2, 2014</div>
|
||||
<a href="http://localhost:1313/post/hugoisforlovers/"><div>Getting Started with Hugo</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
|
||||
446
exampleSite/public/tags/development/index.xml
Normal file
446
exampleSite/public/tags/development/index.xml
Normal file
@@ -0,0 +1,446 @@
|
||||
<?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>http://localhost:1313/tags/development/</link>
|
||||
<description>Recent content in Development on Hugo Themes</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-US</language>
|
||||
<lastBuildDate>Wed, 02 Apr 2014 00:00:00 +0000</lastBuildDate>
|
||||
<atom:link href="http://localhost:1313/tags/development/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
<item>
|
||||
<title>(Hu)go Template Primer</title>
|
||||
<link>http://localhost:1313/post/goisforlovers/</link>
|
||||
<pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/post/goisforlovers/</guid>
|
||||
<description>
|
||||
|
||||
<p>Hugo uses the excellent <a href="http://golang.org/&gt;">go</a> <a href="http://golang.org/pkg/html/template/&gt;">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="http://golang.org/pkg/html/template/&gt;">go docs</a>
|
||||
provide more details.</p>
|
||||
|
||||
<h2 id="introduction-to-go-templates:4d30d99f79bd431d57546bbed04b7347">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="http://golang.org/pkg/html/template/&gt;">go docs</a>.</p>
|
||||
|
||||
<h2 id="basic-syntax:4d30d99f79bd431d57546bbed04b7347">Basic Syntax</h2>
|
||||
|
||||
<p>Go lang 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 &ldquo;foo&rdquo;:</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 &ldquo;bar&rdquo;</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 &quot;alt&quot;) (isset .Params &quot;caption&quot;) }} Caption {{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="variables:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/layout/variables">variables</a> page.</p>
|
||||
|
||||
<p>A variable is accessed by referencing the variable name.</p>
|
||||
|
||||
<pre><code>&lt;title&gt;{{ .Title }}&lt;/title&gt;
|
||||
</code></pre>
|
||||
|
||||
<p>Variables can also be defined and referenced.</p>
|
||||
|
||||
<pre><code>{{ $address := &quot;123 Main St.&quot;}}
|
||||
{{ $address }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="functions:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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:4d30d99f79bd431d57546bbed04b7347">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 &quot;chrome/header.html&quot; . }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="logic:4d30d99f79bd431d57546bbed04b7347">Logic</h2>
|
||||
|
||||
<p>Go templates provide the most basic iteration and conditional logic.</p>
|
||||
|
||||
<h3 id="iteration:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">Conditionals</h3>
|
||||
|
||||
<p>If, else, with, or, &amp; 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 &quot;title&quot; }}&lt;h4&gt;{{ index .Params &quot;title&quot; }}&lt;/h4&gt;{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 2: If -&gt; Else</strong></p>
|
||||
|
||||
<pre><code>{{ if isset .Params &quot;alt&quot; }}
|
||||
{{ index .Params &quot;alt&quot; }}
|
||||
{{else}}
|
||||
{{ index .Params &quot;caption&quot; }}
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 3: And &amp; Or</strong></p>
|
||||
|
||||
<pre><code>{{ if and (or (isset .Params &quot;title&quot;) (isset .Params &quot;caption&quot;)) (isset .Params &quot;attr&quot;)}}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 4: With</strong></p>
|
||||
|
||||
<p>An alternative way of writing &ldquo;if&rdquo; and then referencing the same value
|
||||
is to use &ldquo;with&rdquo; 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 }}&lt;h4&gt;{{ . }}&lt;/h4&gt;{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 5: If -&gt; Else If</strong></p>
|
||||
|
||||
<pre><code>{{ if isset .Params &quot;alt&quot; }}
|
||||
{{ index .Params &quot;alt&quot; }}
|
||||
{{ else if isset .Params &quot;caption&quot; }}
|
||||
{{ index .Params &quot;caption&quot; }}
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="pipes:4d30d99f79bd431d57546bbed04b7347">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&rsquo;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 &quot;disqus_url&quot; | html }}
|
||||
</code></pre>
|
||||
|
||||
<p>Access the page parameter called &ldquo;disqus_url&rdquo; and escape the HTML.</p>
|
||||
|
||||
<p><strong>Example 3 :</strong></p>
|
||||
|
||||
<pre><code>{{ if or (or (isset .Params &quot;title&quot;) (isset .Params &quot;caption&quot;)) (isset .Params &quot;attr&quot;)}}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p>Could be rewritten as</p>
|
||||
|
||||
<pre><code>{{ isset .Params &quot;caption&quot; | or isset .Params &quot;title&quot; | or isset .Params &quot;attr&quot; | if }}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="context-aka-the-dot:4d30d99f79bd431d57546bbed04b7347">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 }}
|
||||
&lt;li&gt; &lt;a href=&quot;{{ $baseurl }}/tags/{{ . | urlize }}&quot;&gt;{{ . }}&lt;/a&gt; - {{ $title }} &lt;/li&gt;
|
||||
{{ 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:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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&rsquo;t make a lot of sense. We&rsquo;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: &quot;Permalinks&quot;
|
||||
date: &quot;2013-11-18&quot;
|
||||
aliases:
|
||||
- &quot;/doc/permalinks/&quot;
|
||||
groups: [&quot;extras&quot;]
|
||||
groups_weight: 30
|
||||
notoc: true
|
||||
---
|
||||
</code></pre>
|
||||
|
||||
<p>Here is the corresponding code inside of the template:</p>
|
||||
|
||||
<pre><code> {{ if not .Params.notoc }}
|
||||
&lt;div id=&quot;toc&quot; class=&quot;well col-md-4 col-sm-6&quot;&gt;
|
||||
{{ .TableOfContents }}
|
||||
&lt;/div&gt;
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="using-site-config-parameters:4d30d99f79bd431d57546bbed04b7347">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: &quot;Copyright &amp;#xA9; 2013 John Doe. All Rights Reserved.&quot;
|
||||
TwitterUser: &quot;spf13&quot;
|
||||
SidebarRecentLimit: 5
|
||||
</code></pre>
|
||||
|
||||
<p>Within a footer layout, you might then declare a <code>&lt;footer&gt;</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}}&lt;footer&gt;
|
||||
&lt;div class=&quot;text-center&quot;&gt;{{.Site.Params.CopyrightHTML | safeHtml}}&lt;/div&gt;
|
||||
&lt;/footer&gt;{{end}}
|
||||
</code></pre>
|
||||
|
||||
<p>An alternative way of writing the &ldquo;if&rdquo; and then referencing the same value
|
||||
is to use &ldquo;with&rdquo; 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}}&lt;span class=&quot;twitter&quot;&gt;
|
||||
&lt;a href=&quot;https://twitter.com/{{.}}&quot; rel=&quot;author&quot;&gt;
|
||||
&lt;img src=&quot;/images/twitter.png&quot; width=&quot;48&quot; height=&quot;48&quot; title=&quot;Twitter: {{.}}&quot;
|
||||
alt=&quot;Twitter&quot;&gt;&lt;/a&gt;
|
||||
&lt;/span&gt;{{end}}
|
||||
</code></pre>
|
||||
|
||||
<p>Finally, if you want to pull &ldquo;magic constants&rdquo; out of your layouts, you can do
|
||||
so, such as in this example:</p>
|
||||
|
||||
<pre><code>&lt;nav class=&quot;recent&quot;&gt;
|
||||
&lt;h1&gt;Recent Posts&lt;/h1&gt;
|
||||
&lt;ul&gt;{{range first .Site.Params.SidebarRecentLimit .Site.Recent}}
|
||||
&lt;li&gt;&lt;a href=&quot;{{.RelPermalink}}&quot;&gt;{{.Title}}&lt;/a&gt;&lt;/li&gt;
|
||||
{{end}}&lt;/ul&gt;
|
||||
&lt;/nav&gt;
|
||||
</code></pre>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
<title>Getting Started with Hugo</title>
|
||||
<link>http://localhost:1313/post/hugoisforlovers/</link>
|
||||
<pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/post/hugoisforlovers/</guid>
|
||||
<description>
|
||||
|
||||
<h2 id="step-1-install-hugo:c57cc0038c788519b441e0331c8bebc7">Step 1. Install Hugo</h2>
|
||||
|
||||
<p>Goto <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="http://localhost:1313/overview/installing/">installing hugo</a></p>
|
||||
|
||||
<h2 id="step-2-build-the-docs:c57cc0038c788519b441e0331c8bebc7">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
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; in 27 ms
|
||||
&gt; Web Server is available at http://localhost:1313
|
||||
&gt; Press ctrl+c to stop
|
||||
</code></pre>
|
||||
|
||||
<p>Once you&rsquo;ve gotten here, follow along the rest of this page on your local build.</p>
|
||||
|
||||
<h2 id="step-3-change-the-docs-site:c57cc0038c788519b441e0331c8bebc7">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
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; in 27 ms
|
||||
&gt; Web Server is available at http://localhost:1313
|
||||
&gt; Watching for changes in /Users/spf13/Code/hugo/docs/content
|
||||
&gt; 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>&gt; Change detected, rebuilding site
|
||||
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; 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&rsquo;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:c57cc0038c788519b441e0331c8bebc7">Step 4. Have fun</h2>
|
||||
|
||||
<p>The best way to learn something is to play with it.</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
</channel>
|
||||
</rss>
|
||||
141
exampleSite/public/tags/go/index.html
Normal file
141
exampleSite/public/tags/go/index.html
Normal file
@@ -0,0 +1,141 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
Go · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/tags/go/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="page-heading">
|
||||
|
||||
Go
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Apr 2, 2014</div>
|
||||
<a href="http://localhost:1313/post/goisforlovers/"><div>(Hu)go Template Primer</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Apr 2, 2014</div>
|
||||
<a href="http://localhost:1313/post/hugoisforlovers/"><div>Getting Started with Hugo</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
|
||||
446
exampleSite/public/tags/go/index.xml
Normal file
446
exampleSite/public/tags/go/index.xml
Normal file
@@ -0,0 +1,446 @@
|
||||
<?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>http://localhost:1313/tags/go/</link>
|
||||
<description>Recent content in Go on Hugo Themes</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-US</language>
|
||||
<lastBuildDate>Wed, 02 Apr 2014 00:00:00 +0000</lastBuildDate>
|
||||
<atom:link href="http://localhost:1313/tags/go/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
<item>
|
||||
<title>(Hu)go Template Primer</title>
|
||||
<link>http://localhost:1313/post/goisforlovers/</link>
|
||||
<pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/post/goisforlovers/</guid>
|
||||
<description>
|
||||
|
||||
<p>Hugo uses the excellent <a href="http://golang.org/&gt;">go</a> <a href="http://golang.org/pkg/html/template/&gt;">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="http://golang.org/pkg/html/template/&gt;">go docs</a>
|
||||
provide more details.</p>
|
||||
|
||||
<h2 id="introduction-to-go-templates:4d30d99f79bd431d57546bbed04b7347">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="http://golang.org/pkg/html/template/&gt;">go docs</a>.</p>
|
||||
|
||||
<h2 id="basic-syntax:4d30d99f79bd431d57546bbed04b7347">Basic Syntax</h2>
|
||||
|
||||
<p>Go lang 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 &ldquo;foo&rdquo;:</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 &ldquo;bar&rdquo;</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 &quot;alt&quot;) (isset .Params &quot;caption&quot;) }} Caption {{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="variables:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/layout/variables">variables</a> page.</p>
|
||||
|
||||
<p>A variable is accessed by referencing the variable name.</p>
|
||||
|
||||
<pre><code>&lt;title&gt;{{ .Title }}&lt;/title&gt;
|
||||
</code></pre>
|
||||
|
||||
<p>Variables can also be defined and referenced.</p>
|
||||
|
||||
<pre><code>{{ $address := &quot;123 Main St.&quot;}}
|
||||
{{ $address }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="functions:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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:4d30d99f79bd431d57546bbed04b7347">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 &quot;chrome/header.html&quot; . }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="logic:4d30d99f79bd431d57546bbed04b7347">Logic</h2>
|
||||
|
||||
<p>Go templates provide the most basic iteration and conditional logic.</p>
|
||||
|
||||
<h3 id="iteration:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">Conditionals</h3>
|
||||
|
||||
<p>If, else, with, or, &amp; 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 &quot;title&quot; }}&lt;h4&gt;{{ index .Params &quot;title&quot; }}&lt;/h4&gt;{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 2: If -&gt; Else</strong></p>
|
||||
|
||||
<pre><code>{{ if isset .Params &quot;alt&quot; }}
|
||||
{{ index .Params &quot;alt&quot; }}
|
||||
{{else}}
|
||||
{{ index .Params &quot;caption&quot; }}
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 3: And &amp; Or</strong></p>
|
||||
|
||||
<pre><code>{{ if and (or (isset .Params &quot;title&quot;) (isset .Params &quot;caption&quot;)) (isset .Params &quot;attr&quot;)}}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 4: With</strong></p>
|
||||
|
||||
<p>An alternative way of writing &ldquo;if&rdquo; and then referencing the same value
|
||||
is to use &ldquo;with&rdquo; 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 }}&lt;h4&gt;{{ . }}&lt;/h4&gt;{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 5: If -&gt; Else If</strong></p>
|
||||
|
||||
<pre><code>{{ if isset .Params &quot;alt&quot; }}
|
||||
{{ index .Params &quot;alt&quot; }}
|
||||
{{ else if isset .Params &quot;caption&quot; }}
|
||||
{{ index .Params &quot;caption&quot; }}
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="pipes:4d30d99f79bd431d57546bbed04b7347">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&rsquo;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 &quot;disqus_url&quot; | html }}
|
||||
</code></pre>
|
||||
|
||||
<p>Access the page parameter called &ldquo;disqus_url&rdquo; and escape the HTML.</p>
|
||||
|
||||
<p><strong>Example 3 :</strong></p>
|
||||
|
||||
<pre><code>{{ if or (or (isset .Params &quot;title&quot;) (isset .Params &quot;caption&quot;)) (isset .Params &quot;attr&quot;)}}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p>Could be rewritten as</p>
|
||||
|
||||
<pre><code>{{ isset .Params &quot;caption&quot; | or isset .Params &quot;title&quot; | or isset .Params &quot;attr&quot; | if }}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="context-aka-the-dot:4d30d99f79bd431d57546bbed04b7347">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 }}
|
||||
&lt;li&gt; &lt;a href=&quot;{{ $baseurl }}/tags/{{ . | urlize }}&quot;&gt;{{ . }}&lt;/a&gt; - {{ $title }} &lt;/li&gt;
|
||||
{{ 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:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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&rsquo;t make a lot of sense. We&rsquo;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: &quot;Permalinks&quot;
|
||||
date: &quot;2013-11-18&quot;
|
||||
aliases:
|
||||
- &quot;/doc/permalinks/&quot;
|
||||
groups: [&quot;extras&quot;]
|
||||
groups_weight: 30
|
||||
notoc: true
|
||||
---
|
||||
</code></pre>
|
||||
|
||||
<p>Here is the corresponding code inside of the template:</p>
|
||||
|
||||
<pre><code> {{ if not .Params.notoc }}
|
||||
&lt;div id=&quot;toc&quot; class=&quot;well col-md-4 col-sm-6&quot;&gt;
|
||||
{{ .TableOfContents }}
|
||||
&lt;/div&gt;
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="using-site-config-parameters:4d30d99f79bd431d57546bbed04b7347">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: &quot;Copyright &amp;#xA9; 2013 John Doe. All Rights Reserved.&quot;
|
||||
TwitterUser: &quot;spf13&quot;
|
||||
SidebarRecentLimit: 5
|
||||
</code></pre>
|
||||
|
||||
<p>Within a footer layout, you might then declare a <code>&lt;footer&gt;</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}}&lt;footer&gt;
|
||||
&lt;div class=&quot;text-center&quot;&gt;{{.Site.Params.CopyrightHTML | safeHtml}}&lt;/div&gt;
|
||||
&lt;/footer&gt;{{end}}
|
||||
</code></pre>
|
||||
|
||||
<p>An alternative way of writing the &ldquo;if&rdquo; and then referencing the same value
|
||||
is to use &ldquo;with&rdquo; 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}}&lt;span class=&quot;twitter&quot;&gt;
|
||||
&lt;a href=&quot;https://twitter.com/{{.}}&quot; rel=&quot;author&quot;&gt;
|
||||
&lt;img src=&quot;/images/twitter.png&quot; width=&quot;48&quot; height=&quot;48&quot; title=&quot;Twitter: {{.}}&quot;
|
||||
alt=&quot;Twitter&quot;&gt;&lt;/a&gt;
|
||||
&lt;/span&gt;{{end}}
|
||||
</code></pre>
|
||||
|
||||
<p>Finally, if you want to pull &ldquo;magic constants&rdquo; out of your layouts, you can do
|
||||
so, such as in this example:</p>
|
||||
|
||||
<pre><code>&lt;nav class=&quot;recent&quot;&gt;
|
||||
&lt;h1&gt;Recent Posts&lt;/h1&gt;
|
||||
&lt;ul&gt;{{range first .Site.Params.SidebarRecentLimit .Site.Recent}}
|
||||
&lt;li&gt;&lt;a href=&quot;{{.RelPermalink}}&quot;&gt;{{.Title}}&lt;/a&gt;&lt;/li&gt;
|
||||
{{end}}&lt;/ul&gt;
|
||||
&lt;/nav&gt;
|
||||
</code></pre>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
<title>Getting Started with Hugo</title>
|
||||
<link>http://localhost:1313/post/hugoisforlovers/</link>
|
||||
<pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/post/hugoisforlovers/</guid>
|
||||
<description>
|
||||
|
||||
<h2 id="step-1-install-hugo:c57cc0038c788519b441e0331c8bebc7">Step 1. Install Hugo</h2>
|
||||
|
||||
<p>Goto <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="http://localhost:1313/overview/installing/">installing hugo</a></p>
|
||||
|
||||
<h2 id="step-2-build-the-docs:c57cc0038c788519b441e0331c8bebc7">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
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; in 27 ms
|
||||
&gt; Web Server is available at http://localhost:1313
|
||||
&gt; Press ctrl+c to stop
|
||||
</code></pre>
|
||||
|
||||
<p>Once you&rsquo;ve gotten here, follow along the rest of this page on your local build.</p>
|
||||
|
||||
<h2 id="step-3-change-the-docs-site:c57cc0038c788519b441e0331c8bebc7">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
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; in 27 ms
|
||||
&gt; Web Server is available at http://localhost:1313
|
||||
&gt; Watching for changes in /Users/spf13/Code/hugo/docs/content
|
||||
&gt; 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>&gt; Change detected, rebuilding site
|
||||
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; 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&rsquo;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:c57cc0038c788519b441e0331c8bebc7">Step 4. Have fun</h2>
|
||||
|
||||
<p>The best way to learn something is to play with it.</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
</channel>
|
||||
</rss>
|
||||
141
exampleSite/public/tags/golang/index.html
Normal file
141
exampleSite/public/tags/golang/index.html
Normal file
@@ -0,0 +1,141 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
Golang · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/tags/golang/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="page-heading">
|
||||
|
||||
Golang
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Apr 2, 2014</div>
|
||||
<a href="http://localhost:1313/post/goisforlovers/"><div>(Hu)go Template Primer</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Apr 2, 2014</div>
|
||||
<a href="http://localhost:1313/post/hugoisforlovers/"><div>Getting Started with Hugo</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
|
||||
446
exampleSite/public/tags/golang/index.xml
Normal file
446
exampleSite/public/tags/golang/index.xml
Normal file
@@ -0,0 +1,446 @@
|
||||
<?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>http://localhost:1313/tags/golang/</link>
|
||||
<description>Recent content in Golang on Hugo Themes</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-US</language>
|
||||
<lastBuildDate>Wed, 02 Apr 2014 00:00:00 +0000</lastBuildDate>
|
||||
<atom:link href="http://localhost:1313/tags/golang/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
<item>
|
||||
<title>(Hu)go Template Primer</title>
|
||||
<link>http://localhost:1313/post/goisforlovers/</link>
|
||||
<pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/post/goisforlovers/</guid>
|
||||
<description>
|
||||
|
||||
<p>Hugo uses the excellent <a href="http://golang.org/&gt;">go</a> <a href="http://golang.org/pkg/html/template/&gt;">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="http://golang.org/pkg/html/template/&gt;">go docs</a>
|
||||
provide more details.</p>
|
||||
|
||||
<h2 id="introduction-to-go-templates:4d30d99f79bd431d57546bbed04b7347">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="http://golang.org/pkg/html/template/&gt;">go docs</a>.</p>
|
||||
|
||||
<h2 id="basic-syntax:4d30d99f79bd431d57546bbed04b7347">Basic Syntax</h2>
|
||||
|
||||
<p>Go lang 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 &ldquo;foo&rdquo;:</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 &ldquo;bar&rdquo;</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 &quot;alt&quot;) (isset .Params &quot;caption&quot;) }} Caption {{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="variables:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/layout/variables">variables</a> page.</p>
|
||||
|
||||
<p>A variable is accessed by referencing the variable name.</p>
|
||||
|
||||
<pre><code>&lt;title&gt;{{ .Title }}&lt;/title&gt;
|
||||
</code></pre>
|
||||
|
||||
<p>Variables can also be defined and referenced.</p>
|
||||
|
||||
<pre><code>{{ $address := &quot;123 Main St.&quot;}}
|
||||
{{ $address }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="functions:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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:4d30d99f79bd431d57546bbed04b7347">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 &quot;chrome/header.html&quot; . }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="logic:4d30d99f79bd431d57546bbed04b7347">Logic</h2>
|
||||
|
||||
<p>Go templates provide the most basic iteration and conditional logic.</p>
|
||||
|
||||
<h3 id="iteration:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">Conditionals</h3>
|
||||
|
||||
<p>If, else, with, or, &amp; 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 &quot;title&quot; }}&lt;h4&gt;{{ index .Params &quot;title&quot; }}&lt;/h4&gt;{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 2: If -&gt; Else</strong></p>
|
||||
|
||||
<pre><code>{{ if isset .Params &quot;alt&quot; }}
|
||||
{{ index .Params &quot;alt&quot; }}
|
||||
{{else}}
|
||||
{{ index .Params &quot;caption&quot; }}
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 3: And &amp; Or</strong></p>
|
||||
|
||||
<pre><code>{{ if and (or (isset .Params &quot;title&quot;) (isset .Params &quot;caption&quot;)) (isset .Params &quot;attr&quot;)}}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 4: With</strong></p>
|
||||
|
||||
<p>An alternative way of writing &ldquo;if&rdquo; and then referencing the same value
|
||||
is to use &ldquo;with&rdquo; 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 }}&lt;h4&gt;{{ . }}&lt;/h4&gt;{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 5: If -&gt; Else If</strong></p>
|
||||
|
||||
<pre><code>{{ if isset .Params &quot;alt&quot; }}
|
||||
{{ index .Params &quot;alt&quot; }}
|
||||
{{ else if isset .Params &quot;caption&quot; }}
|
||||
{{ index .Params &quot;caption&quot; }}
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="pipes:4d30d99f79bd431d57546bbed04b7347">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&rsquo;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 &quot;disqus_url&quot; | html }}
|
||||
</code></pre>
|
||||
|
||||
<p>Access the page parameter called &ldquo;disqus_url&rdquo; and escape the HTML.</p>
|
||||
|
||||
<p><strong>Example 3 :</strong></p>
|
||||
|
||||
<pre><code>{{ if or (or (isset .Params &quot;title&quot;) (isset .Params &quot;caption&quot;)) (isset .Params &quot;attr&quot;)}}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p>Could be rewritten as</p>
|
||||
|
||||
<pre><code>{{ isset .Params &quot;caption&quot; | or isset .Params &quot;title&quot; | or isset .Params &quot;attr&quot; | if }}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="context-aka-the-dot:4d30d99f79bd431d57546bbed04b7347">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 }}
|
||||
&lt;li&gt; &lt;a href=&quot;{{ $baseurl }}/tags/{{ . | urlize }}&quot;&gt;{{ . }}&lt;/a&gt; - {{ $title }} &lt;/li&gt;
|
||||
{{ 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:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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&rsquo;t make a lot of sense. We&rsquo;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: &quot;Permalinks&quot;
|
||||
date: &quot;2013-11-18&quot;
|
||||
aliases:
|
||||
- &quot;/doc/permalinks/&quot;
|
||||
groups: [&quot;extras&quot;]
|
||||
groups_weight: 30
|
||||
notoc: true
|
||||
---
|
||||
</code></pre>
|
||||
|
||||
<p>Here is the corresponding code inside of the template:</p>
|
||||
|
||||
<pre><code> {{ if not .Params.notoc }}
|
||||
&lt;div id=&quot;toc&quot; class=&quot;well col-md-4 col-sm-6&quot;&gt;
|
||||
{{ .TableOfContents }}
|
||||
&lt;/div&gt;
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="using-site-config-parameters:4d30d99f79bd431d57546bbed04b7347">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: &quot;Copyright &amp;#xA9; 2013 John Doe. All Rights Reserved.&quot;
|
||||
TwitterUser: &quot;spf13&quot;
|
||||
SidebarRecentLimit: 5
|
||||
</code></pre>
|
||||
|
||||
<p>Within a footer layout, you might then declare a <code>&lt;footer&gt;</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}}&lt;footer&gt;
|
||||
&lt;div class=&quot;text-center&quot;&gt;{{.Site.Params.CopyrightHTML | safeHtml}}&lt;/div&gt;
|
||||
&lt;/footer&gt;{{end}}
|
||||
</code></pre>
|
||||
|
||||
<p>An alternative way of writing the &ldquo;if&rdquo; and then referencing the same value
|
||||
is to use &ldquo;with&rdquo; 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}}&lt;span class=&quot;twitter&quot;&gt;
|
||||
&lt;a href=&quot;https://twitter.com/{{.}}&quot; rel=&quot;author&quot;&gt;
|
||||
&lt;img src=&quot;/images/twitter.png&quot; width=&quot;48&quot; height=&quot;48&quot; title=&quot;Twitter: {{.}}&quot;
|
||||
alt=&quot;Twitter&quot;&gt;&lt;/a&gt;
|
||||
&lt;/span&gt;{{end}}
|
||||
</code></pre>
|
||||
|
||||
<p>Finally, if you want to pull &ldquo;magic constants&rdquo; out of your layouts, you can do
|
||||
so, such as in this example:</p>
|
||||
|
||||
<pre><code>&lt;nav class=&quot;recent&quot;&gt;
|
||||
&lt;h1&gt;Recent Posts&lt;/h1&gt;
|
||||
&lt;ul&gt;{{range first .Site.Params.SidebarRecentLimit .Site.Recent}}
|
||||
&lt;li&gt;&lt;a href=&quot;{{.RelPermalink}}&quot;&gt;{{.Title}}&lt;/a&gt;&lt;/li&gt;
|
||||
{{end}}&lt;/ul&gt;
|
||||
&lt;/nav&gt;
|
||||
</code></pre>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
<title>Getting Started with Hugo</title>
|
||||
<link>http://localhost:1313/post/hugoisforlovers/</link>
|
||||
<pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/post/hugoisforlovers/</guid>
|
||||
<description>
|
||||
|
||||
<h2 id="step-1-install-hugo:c57cc0038c788519b441e0331c8bebc7">Step 1. Install Hugo</h2>
|
||||
|
||||
<p>Goto <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="http://localhost:1313/overview/installing/">installing hugo</a></p>
|
||||
|
||||
<h2 id="step-2-build-the-docs:c57cc0038c788519b441e0331c8bebc7">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
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; in 27 ms
|
||||
&gt; Web Server is available at http://localhost:1313
|
||||
&gt; Press ctrl+c to stop
|
||||
</code></pre>
|
||||
|
||||
<p>Once you&rsquo;ve gotten here, follow along the rest of this page on your local build.</p>
|
||||
|
||||
<h2 id="step-3-change-the-docs-site:c57cc0038c788519b441e0331c8bebc7">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
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; in 27 ms
|
||||
&gt; Web Server is available at http://localhost:1313
|
||||
&gt; Watching for changes in /Users/spf13/Code/hugo/docs/content
|
||||
&gt; 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>&gt; Change detected, rebuilding site
|
||||
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; 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&rsquo;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:c57cc0038c788519b441e0331c8bebc7">Step 4. Have fun</h2>
|
||||
|
||||
<p>The best way to learn something is to play with it.</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
</channel>
|
||||
</rss>
|
||||
135
exampleSite/public/tags/hugo/index.html
Normal file
135
exampleSite/public/tags/hugo/index.html
Normal file
@@ -0,0 +1,135 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
Hugo · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/tags/hugo/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="page-heading">
|
||||
|
||||
Hugo
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Apr 2, 2014</div>
|
||||
<a href="http://localhost:1313/post/hugoisforlovers/"><div>Getting Started with Hugo</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
|
||||
100
exampleSite/public/tags/hugo/index.xml
Normal file
100
exampleSite/public/tags/hugo/index.xml
Normal file
@@ -0,0 +1,100 @@
|
||||
<?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>http://localhost:1313/tags/hugo/</link>
|
||||
<description>Recent content in Hugo on Hugo Themes</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-US</language>
|
||||
<lastBuildDate>Wed, 02 Apr 2014 00:00:00 +0000</lastBuildDate>
|
||||
<atom:link href="http://localhost:1313/tags/hugo/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
<item>
|
||||
<title>Getting Started with Hugo</title>
|
||||
<link>http://localhost:1313/post/hugoisforlovers/</link>
|
||||
<pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/post/hugoisforlovers/</guid>
|
||||
<description>
|
||||
|
||||
<h2 id="step-1-install-hugo:c57cc0038c788519b441e0331c8bebc7">Step 1. Install Hugo</h2>
|
||||
|
||||
<p>Goto <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="http://localhost:1313/overview/installing/">installing hugo</a></p>
|
||||
|
||||
<h2 id="step-2-build-the-docs:c57cc0038c788519b441e0331c8bebc7">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
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; in 27 ms
|
||||
&gt; Web Server is available at http://localhost:1313
|
||||
&gt; Press ctrl+c to stop
|
||||
</code></pre>
|
||||
|
||||
<p>Once you&rsquo;ve gotten here, follow along the rest of this page on your local build.</p>
|
||||
|
||||
<h2 id="step-3-change-the-docs-site:c57cc0038c788519b441e0331c8bebc7">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
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; in 27 ms
|
||||
&gt; Web Server is available at http://localhost:1313
|
||||
&gt; Watching for changes in /Users/spf13/Code/hugo/docs/content
|
||||
&gt; 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>&gt; Change detected, rebuilding site
|
||||
|
||||
&gt; 29 pages created
|
||||
&gt; 0 tags index created
|
||||
&gt; 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&rsquo;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:c57cc0038c788519b441e0331c8bebc7">Step 4. Have fun</h2>
|
||||
|
||||
<p>The best way to learn something is to play with it.</p>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
</channel>
|
||||
</rss>
|
||||
135
exampleSite/public/tags/templates/index.html
Normal file
135
exampleSite/public/tags/templates/index.html
Normal file
@@ -0,0 +1,135 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
Templates · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/tags/templates/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="page-heading">
|
||||
|
||||
Templates
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Apr 2, 2014</div>
|
||||
<a href="http://localhost:1313/post/goisforlovers/"><div>(Hu)go Template Primer</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
|
||||
359
exampleSite/public/tags/templates/index.xml
Normal file
359
exampleSite/public/tags/templates/index.xml
Normal file
@@ -0,0 +1,359 @@
|
||||
<?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>http://localhost:1313/tags/templates/</link>
|
||||
<description>Recent content in Templates on Hugo Themes</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-US</language>
|
||||
<lastBuildDate>Wed, 02 Apr 2014 00:00:00 +0000</lastBuildDate>
|
||||
<atom:link href="http://localhost:1313/tags/templates/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
<item>
|
||||
<title>(Hu)go Template Primer</title>
|
||||
<link>http://localhost:1313/post/goisforlovers/</link>
|
||||
<pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/post/goisforlovers/</guid>
|
||||
<description>
|
||||
|
||||
<p>Hugo uses the excellent <a href="http://golang.org/&gt;">go</a> <a href="http://golang.org/pkg/html/template/&gt;">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="http://golang.org/pkg/html/template/&gt;">go docs</a>
|
||||
provide more details.</p>
|
||||
|
||||
<h2 id="introduction-to-go-templates:4d30d99f79bd431d57546bbed04b7347">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="http://golang.org/pkg/html/template/&gt;">go docs</a>.</p>
|
||||
|
||||
<h2 id="basic-syntax:4d30d99f79bd431d57546bbed04b7347">Basic Syntax</h2>
|
||||
|
||||
<p>Go lang 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 &ldquo;foo&rdquo;:</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 &ldquo;bar&rdquo;</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 &quot;alt&quot;) (isset .Params &quot;caption&quot;) }} Caption {{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="variables:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/layout/variables">variables</a> page.</p>
|
||||
|
||||
<p>A variable is accessed by referencing the variable name.</p>
|
||||
|
||||
<pre><code>&lt;title&gt;{{ .Title }}&lt;/title&gt;
|
||||
</code></pre>
|
||||
|
||||
<p>Variables can also be defined and referenced.</p>
|
||||
|
||||
<pre><code>{{ $address := &quot;123 Main St.&quot;}}
|
||||
{{ $address }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="functions:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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:4d30d99f79bd431d57546bbed04b7347">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 &quot;chrome/header.html&quot; . }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="logic:4d30d99f79bd431d57546bbed04b7347">Logic</h2>
|
||||
|
||||
<p>Go templates provide the most basic iteration and conditional logic.</p>
|
||||
|
||||
<h3 id="iteration:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">Conditionals</h3>
|
||||
|
||||
<p>If, else, with, or, &amp; 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 &quot;title&quot; }}&lt;h4&gt;{{ index .Params &quot;title&quot; }}&lt;/h4&gt;{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 2: If -&gt; Else</strong></p>
|
||||
|
||||
<pre><code>{{ if isset .Params &quot;alt&quot; }}
|
||||
{{ index .Params &quot;alt&quot; }}
|
||||
{{else}}
|
||||
{{ index .Params &quot;caption&quot; }}
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 3: And &amp; Or</strong></p>
|
||||
|
||||
<pre><code>{{ if and (or (isset .Params &quot;title&quot;) (isset .Params &quot;caption&quot;)) (isset .Params &quot;attr&quot;)}}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 4: With</strong></p>
|
||||
|
||||
<p>An alternative way of writing &ldquo;if&rdquo; and then referencing the same value
|
||||
is to use &ldquo;with&rdquo; 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 }}&lt;h4&gt;{{ . }}&lt;/h4&gt;{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 5: If -&gt; Else If</strong></p>
|
||||
|
||||
<pre><code>{{ if isset .Params &quot;alt&quot; }}
|
||||
{{ index .Params &quot;alt&quot; }}
|
||||
{{ else if isset .Params &quot;caption&quot; }}
|
||||
{{ index .Params &quot;caption&quot; }}
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="pipes:4d30d99f79bd431d57546bbed04b7347">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&rsquo;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 &quot;disqus_url&quot; | html }}
|
||||
</code></pre>
|
||||
|
||||
<p>Access the page parameter called &ldquo;disqus_url&rdquo; and escape the HTML.</p>
|
||||
|
||||
<p><strong>Example 3 :</strong></p>
|
||||
|
||||
<pre><code>{{ if or (or (isset .Params &quot;title&quot;) (isset .Params &quot;caption&quot;)) (isset .Params &quot;attr&quot;)}}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p>Could be rewritten as</p>
|
||||
|
||||
<pre><code>{{ isset .Params &quot;caption&quot; | or isset .Params &quot;title&quot; | or isset .Params &quot;attr&quot; | if }}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="context-aka-the-dot:4d30d99f79bd431d57546bbed04b7347">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 }}
|
||||
&lt;li&gt; &lt;a href=&quot;{{ $baseurl }}/tags/{{ . | urlize }}&quot;&gt;{{ . }}&lt;/a&gt; - {{ $title }} &lt;/li&gt;
|
||||
{{ 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:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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&rsquo;t make a lot of sense. We&rsquo;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: &quot;Permalinks&quot;
|
||||
date: &quot;2013-11-18&quot;
|
||||
aliases:
|
||||
- &quot;/doc/permalinks/&quot;
|
||||
groups: [&quot;extras&quot;]
|
||||
groups_weight: 30
|
||||
notoc: true
|
||||
---
|
||||
</code></pre>
|
||||
|
||||
<p>Here is the corresponding code inside of the template:</p>
|
||||
|
||||
<pre><code> {{ if not .Params.notoc }}
|
||||
&lt;div id=&quot;toc&quot; class=&quot;well col-md-4 col-sm-6&quot;&gt;
|
||||
{{ .TableOfContents }}
|
||||
&lt;/div&gt;
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="using-site-config-parameters:4d30d99f79bd431d57546bbed04b7347">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: &quot;Copyright &amp;#xA9; 2013 John Doe. All Rights Reserved.&quot;
|
||||
TwitterUser: &quot;spf13&quot;
|
||||
SidebarRecentLimit: 5
|
||||
</code></pre>
|
||||
|
||||
<p>Within a footer layout, you might then declare a <code>&lt;footer&gt;</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}}&lt;footer&gt;
|
||||
&lt;div class=&quot;text-center&quot;&gt;{{.Site.Params.CopyrightHTML | safeHtml}}&lt;/div&gt;
|
||||
&lt;/footer&gt;{{end}}
|
||||
</code></pre>
|
||||
|
||||
<p>An alternative way of writing the &ldquo;if&rdquo; and then referencing the same value
|
||||
is to use &ldquo;with&rdquo; 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}}&lt;span class=&quot;twitter&quot;&gt;
|
||||
&lt;a href=&quot;https://twitter.com/{{.}}&quot; rel=&quot;author&quot;&gt;
|
||||
&lt;img src=&quot;/images/twitter.png&quot; width=&quot;48&quot; height=&quot;48&quot; title=&quot;Twitter: {{.}}&quot;
|
||||
alt=&quot;Twitter&quot;&gt;&lt;/a&gt;
|
||||
&lt;/span&gt;{{end}}
|
||||
</code></pre>
|
||||
|
||||
<p>Finally, if you want to pull &ldquo;magic constants&rdquo; out of your layouts, you can do
|
||||
so, such as in this example:</p>
|
||||
|
||||
<pre><code>&lt;nav class=&quot;recent&quot;&gt;
|
||||
&lt;h1&gt;Recent Posts&lt;/h1&gt;
|
||||
&lt;ul&gt;{{range first .Site.Params.SidebarRecentLimit .Site.Recent}}
|
||||
&lt;li&gt;&lt;a href=&quot;{{.RelPermalink}}&quot;&gt;{{.Title}}&lt;/a&gt;&lt;/li&gt;
|
||||
{{end}}&lt;/ul&gt;
|
||||
&lt;/nav&gt;
|
||||
</code></pre>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
</channel>
|
||||
</rss>
|
||||
135
exampleSite/public/tags/themes/index.html
Normal file
135
exampleSite/public/tags/themes/index.html
Normal file
@@ -0,0 +1,135 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||
<meta name="HandheldFriendly" content="True">
|
||||
<meta name="MobileOptimized" content="320">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
|
||||
|
||||
|
||||
<base href="http://localhost:1313/">
|
||||
<title>
|
||||
|
||||
|
||||
Themes · Hugo Themes
|
||||
|
||||
</title>
|
||||
<link rel="canonical" href="http://localhost:1313/tags/themes/">
|
||||
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/reset.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/pygments.css">
|
||||
<link rel="stylesheet" href="http://localhost:1313/css/main.css">
|
||||
|
||||
|
||||
|
||||
<link rel="shortcut icon"
|
||||
|
||||
href="http://localhost:1313/img/myicon.ico"
|
||||
|
||||
>
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
|
||||
|
||||
<body lang="en">
|
||||
|
||||
<div class="section header">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<nav>
|
||||
<ul>
|
||||
<a href="http://localhost:1313/posts"><li>posts</li></a>
|
||||
<a href="http://localhost:1313/about"><li>about</li></a>
|
||||
<a href="http://localhost:1313/code"><li>code</li></a>
|
||||
</ul>
|
||||
</nav>
|
||||
<a href="http://localhost:1313/"><div class="name">map[]</div></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section icons">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
|
||||
|
||||
<a href="//github.com/username" target="_blank">
|
||||
<i class="icon ion-social-github"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//twitter.com/username" target="_blank">
|
||||
<i class="icon ion-social-twitter"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//linkedin.com/in/username" target="_blank">
|
||||
<i class="icon ion-social-linkedin"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href="//facebook.com/username" target="_blank">
|
||||
<i class="icon ion-social-facebook larger"></i>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a href="mailto:username@hogwarts.edu">
|
||||
<i class="icon ion-ios-email larger"></i>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="section main">
|
||||
<div class="container">
|
||||
<div class="content">
|
||||
<div class="page-heading">
|
||||
|
||||
Themes
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<li class="post-item">
|
||||
<div class="meta">Apr 2, 2014</div>
|
||||
<a href="http://localhost:1313/post/goisforlovers/"><div>(Hu)go Template Primer</div></a>
|
||||
</li>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
||||
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
try {
|
||||
var pageTracker = _gat._getTracker("\x3cGoogle-Analytics-ID\x3e");
|
||||
pageTracker._trackPageview();
|
||||
} catch(err) {}
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
<script>document.write('<script src="http://'
|
||||
+ (location.host || 'localhost').split(':')[0]
|
||||
+ ':1313/livereload.js?mindelay=10"></'
|
||||
+ 'script>')</script></body>
|
||||
</html>
|
||||
|
||||
|
||||
359
exampleSite/public/tags/themes/index.xml
Normal file
359
exampleSite/public/tags/themes/index.xml
Normal file
@@ -0,0 +1,359 @@
|
||||
<?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>http://localhost:1313/tags/themes/</link>
|
||||
<description>Recent content in Themes on Hugo Themes</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-US</language>
|
||||
<lastBuildDate>Wed, 02 Apr 2014 00:00:00 +0000</lastBuildDate>
|
||||
<atom:link href="http://localhost:1313/tags/themes/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
<item>
|
||||
<title>(Hu)go Template Primer</title>
|
||||
<link>http://localhost:1313/post/goisforlovers/</link>
|
||||
<pubDate>Wed, 02 Apr 2014 00:00:00 +0000</pubDate>
|
||||
|
||||
<guid>http://localhost:1313/post/goisforlovers/</guid>
|
||||
<description>
|
||||
|
||||
<p>Hugo uses the excellent <a href="http://golang.org/&gt;">go</a> <a href="http://golang.org/pkg/html/template/&gt;">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="http://golang.org/pkg/html/template/&gt;">go docs</a>
|
||||
provide more details.</p>
|
||||
|
||||
<h2 id="introduction-to-go-templates:4d30d99f79bd431d57546bbed04b7347">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="http://golang.org/pkg/html/template/&gt;">go docs</a>.</p>
|
||||
|
||||
<h2 id="basic-syntax:4d30d99f79bd431d57546bbed04b7347">Basic Syntax</h2>
|
||||
|
||||
<p>Go lang 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 &ldquo;foo&rdquo;:</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 &ldquo;bar&rdquo;</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 &quot;alt&quot;) (isset .Params &quot;caption&quot;) }} Caption {{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="variables:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/layout/variables">variables</a> page.</p>
|
||||
|
||||
<p>A variable is accessed by referencing the variable name.</p>
|
||||
|
||||
<pre><code>&lt;title&gt;{{ .Title }}&lt;/title&gt;
|
||||
</code></pre>
|
||||
|
||||
<p>Variables can also be defined and referenced.</p>
|
||||
|
||||
<pre><code>{{ $address := &quot;123 Main St.&quot;}}
|
||||
{{ $address }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="functions:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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:4d30d99f79bd431d57546bbed04b7347">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 &quot;chrome/header.html&quot; . }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="logic:4d30d99f79bd431d57546bbed04b7347">Logic</h2>
|
||||
|
||||
<p>Go templates provide the most basic iteration and conditional logic.</p>
|
||||
|
||||
<h3 id="iteration:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">Conditionals</h3>
|
||||
|
||||
<p>If, else, with, or, &amp; 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 &quot;title&quot; }}&lt;h4&gt;{{ index .Params &quot;title&quot; }}&lt;/h4&gt;{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 2: If -&gt; Else</strong></p>
|
||||
|
||||
<pre><code>{{ if isset .Params &quot;alt&quot; }}
|
||||
{{ index .Params &quot;alt&quot; }}
|
||||
{{else}}
|
||||
{{ index .Params &quot;caption&quot; }}
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 3: And &amp; Or</strong></p>
|
||||
|
||||
<pre><code>{{ if and (or (isset .Params &quot;title&quot;) (isset .Params &quot;caption&quot;)) (isset .Params &quot;attr&quot;)}}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 4: With</strong></p>
|
||||
|
||||
<p>An alternative way of writing &ldquo;if&rdquo; and then referencing the same value
|
||||
is to use &ldquo;with&rdquo; 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 }}&lt;h4&gt;{{ . }}&lt;/h4&gt;{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p><strong>Example 5: If -&gt; Else If</strong></p>
|
||||
|
||||
<pre><code>{{ if isset .Params &quot;alt&quot; }}
|
||||
{{ index .Params &quot;alt&quot; }}
|
||||
{{ else if isset .Params &quot;caption&quot; }}
|
||||
{{ index .Params &quot;caption&quot; }}
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="pipes:4d30d99f79bd431d57546bbed04b7347">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&rsquo;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 &quot;disqus_url&quot; | html }}
|
||||
</code></pre>
|
||||
|
||||
<p>Access the page parameter called &ldquo;disqus_url&rdquo; and escape the HTML.</p>
|
||||
|
||||
<p><strong>Example 3 :</strong></p>
|
||||
|
||||
<pre><code>{{ if or (or (isset .Params &quot;title&quot;) (isset .Params &quot;caption&quot;)) (isset .Params &quot;attr&quot;)}}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<p>Could be rewritten as</p>
|
||||
|
||||
<pre><code>{{ isset .Params &quot;caption&quot; | or isset .Params &quot;title&quot; | or isset .Params &quot;attr&quot; | if }}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="context-aka-the-dot:4d30d99f79bd431d57546bbed04b7347">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 }}
|
||||
&lt;li&gt; &lt;a href=&quot;{{ $baseurl }}/tags/{{ . | urlize }}&quot;&gt;{{ . }}&lt;/a&gt; - {{ $title }} &lt;/li&gt;
|
||||
{{ 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:4d30d99f79bd431d57546bbed04b7347">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:4d30d99f79bd431d57546bbed04b7347">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="http://localhost:1313/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&rsquo;t make a lot of sense. We&rsquo;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: &quot;Permalinks&quot;
|
||||
date: &quot;2013-11-18&quot;
|
||||
aliases:
|
||||
- &quot;/doc/permalinks/&quot;
|
||||
groups: [&quot;extras&quot;]
|
||||
groups_weight: 30
|
||||
notoc: true
|
||||
---
|
||||
</code></pre>
|
||||
|
||||
<p>Here is the corresponding code inside of the template:</p>
|
||||
|
||||
<pre><code> {{ if not .Params.notoc }}
|
||||
&lt;div id=&quot;toc&quot; class=&quot;well col-md-4 col-sm-6&quot;&gt;
|
||||
{{ .TableOfContents }}
|
||||
&lt;/div&gt;
|
||||
{{ end }}
|
||||
</code></pre>
|
||||
|
||||
<h2 id="using-site-config-parameters:4d30d99f79bd431d57546bbed04b7347">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: &quot;Copyright &amp;#xA9; 2013 John Doe. All Rights Reserved.&quot;
|
||||
TwitterUser: &quot;spf13&quot;
|
||||
SidebarRecentLimit: 5
|
||||
</code></pre>
|
||||
|
||||
<p>Within a footer layout, you might then declare a <code>&lt;footer&gt;</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}}&lt;footer&gt;
|
||||
&lt;div class=&quot;text-center&quot;&gt;{{.Site.Params.CopyrightHTML | safeHtml}}&lt;/div&gt;
|
||||
&lt;/footer&gt;{{end}}
|
||||
</code></pre>
|
||||
|
||||
<p>An alternative way of writing the &ldquo;if&rdquo; and then referencing the same value
|
||||
is to use &ldquo;with&rdquo; 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}}&lt;span class=&quot;twitter&quot;&gt;
|
||||
&lt;a href=&quot;https://twitter.com/{{.}}&quot; rel=&quot;author&quot;&gt;
|
||||
&lt;img src=&quot;/images/twitter.png&quot; width=&quot;48&quot; height=&quot;48&quot; title=&quot;Twitter: {{.}}&quot;
|
||||
alt=&quot;Twitter&quot;&gt;&lt;/a&gt;
|
||||
&lt;/span&gt;{{end}}
|
||||
</code></pre>
|
||||
|
||||
<p>Finally, if you want to pull &ldquo;magic constants&rdquo; out of your layouts, you can do
|
||||
so, such as in this example:</p>
|
||||
|
||||
<pre><code>&lt;nav class=&quot;recent&quot;&gt;
|
||||
&lt;h1&gt;Recent Posts&lt;/h1&gt;
|
||||
&lt;ul&gt;{{range first .Site.Params.SidebarRecentLimit .Site.Recent}}
|
||||
&lt;li&gt;&lt;a href=&quot;{{.RelPermalink}}&quot;&gt;{{.Title}}&lt;/a&gt;&lt;/li&gt;
|
||||
{{end}}&lt;/ul&gt;
|
||||
&lt;/nav&gt;
|
||||
</code></pre>
|
||||
</description>
|
||||
</item>
|
||||
|
||||
</channel>
|
||||
</rss>
|
||||
8
exampleSite/public/writing/index.html
Normal file
8
exampleSite/public/writing/index.html
Normal file
@@ -0,0 +1,8 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<link rel="canonical" href="http://localhost:1313/posts"/>
|
||||
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
|
||||
<meta http-equiv="refresh" content="0;url=/posts"/>
|
||||
</head>
|
||||
</html>
|
||||
0
exampleSite/static/.gitignore
vendored
Executable file
0
exampleSite/static/.gitignore
vendored
Executable file
Reference in New Issue
Block a user