├── archetypes
    ├── default.md
    └── post.md
├── .github
    └── FUNDING.yml
├── images
    ├── tn.png
    └── screenshot.png
├── static
    ├── img
    │   └── bg-blog.jpg
    └── css
    │   └── blog.css
├── layouts
    ├── 404.html
    ├── _default
    │   ├── baseof.html
    │   ├── single.html
    │   └── rss.xml
    ├── partials
    │   ├── widget-archives.html
    │   ├── widget-tags.html
    │   ├── widget-recent.html
    │   ├── widget-related.html
    │   ├── footer.html
    │   └── header.html
    ├── tags
    │   └── list.html
    ├── taxonomy
    │   ├── tag.html
    │   └── archive.html
    ├── archives
    │   └── list.html
    ├── post
    │   └── list.html
    └── index.html
├── exampleSite
    ├── config.toml
    └── content
    │   ├── about.md
    │   └── post
    │       ├── hugoisforlovers.md
    │       ├── migrate-from-jekyll.md
    │       ├── goisforlovers.md
    │       └── creating-a-new-theme.md
├── theme.toml
├── LICENSE
└── README.md


/archetypes/default.md:
--------------------------------------------------------------------------------
1 | +++
2 | +++
3 | 


--------------------------------------------------------------------------------
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | github: ['Tazeg']
2 | custom: ['https://keybase.io/jeffprod']
3 | 


--------------------------------------------------------------------------------
/images/tn.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tazeg/hugo-blog-jeffprod/HEAD/images/tn.png


--------------------------------------------------------------------------------
/images/screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tazeg/hugo-blog-jeffprod/HEAD/images/screenshot.png


--------------------------------------------------------------------------------
/static/img/bg-blog.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Tazeg/hugo-blog-jeffprod/HEAD/static/img/bg-blog.jpg


--------------------------------------------------------------------------------
/layouts/404.html:
--------------------------------------------------------------------------------
 1 | {{ define "main" }}
 2 | 
 3 | <div class="box">
 4 |     <div class="content">
 5 |         Page not found...
 6 |     </div>
 7 | </div>
 8 | 
 9 | {{ end }}
10 | 


--------------------------------------------------------------------------------
/archetypes/post.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: "{{ replace .Name "-" " " | title }}"
3 | date: {{ .Date }}
4 | archives: "{{ dateFormat "2006" now }}"
5 | tags: []
6 | author: John SMITH
7 | ---
8 | 


--------------------------------------------------------------------------------
/layouts/_default/baseof.html:
--------------------------------------------------------------------------------
1 | {{ partial "header.html" . }}
2 | 
3 | <div class="container">
4 |     <div class="section">
5 |     {{ block "main" . }}{{ end }}
6 |     </div>
7 | </div>
8 | 
9 | {{ partial "footer.html" . }}


--------------------------------------------------------------------------------
/exampleSite/config.toml:
--------------------------------------------------------------------------------
 1 | baseurl = "https://example.com"
 2 | title = "Hugo Theme"
 3 | author = "@JeffProd"
 4 | copyright = "Copyright © 2008–2018, @JeffProd"
 5 | canonifyurls = true
 6 | paginate = 3
 7 | 
 8 | theme = "hugo-blog-jeffprod"
 9 | 
10 | [taxonomies]
11 |     tag = "tags"
12 |     archive = "archives"
13 | 


--------------------------------------------------------------------------------
/static/css/blog.css:
--------------------------------------------------------------------------------
 1 | html,body {
 2 |     font-family: 'Open Sans', sans-serif;
 3 |     background: #F0F2F4;
 4 |     }
 5 | .hero-body {
 6 |     background-position: center;
 7 |     background-size: cover;
 8 |     background-repeat: no-repeat;
 9 |     }
10 | .mysocial { color: hsl(0, 0%, 100%);}
11 | .mysocial:hover { color: hsl(0, 0%, 71%) }
12 | 


--------------------------------------------------------------------------------
/layouts/partials/widget-archives.html:
--------------------------------------------------------------------------------
1 | <div class="card">
2 |     <div class="card-content">
3 |         <h1 class="title is-5">Archives</h1>
4 |         {{ range (where .Site.RegularPages "Section" "post").GroupByDate "2006" }}
5 |             <a href="{{ "archives" | absURL }}/{{ .Key }}">{{ .Key }}</a> ({{ len .Pages }})<br>
6 |         {{ end }}
7 |     </div>
8 | </div>
9 | 


--------------------------------------------------------------------------------
/layouts/partials/widget-tags.html:
--------------------------------------------------------------------------------
 1 | <div class="card">
 2 |     <div class="card-content">
 3 |         <h1 class="title is-5">Tags</h1>
 4 |         <div class="tags">
 5 |         {{ range $name, $taxonomy := .Site.Taxonomies.tags }}
 6 |             <span class="tag"><a href="{{ "tags" | absURL }}/{{ $name | urlize }}">{{ $name }}</a></span>
 7 |         {{ end }}
 8 |         </div>          
 9 |     </div>
10 | </div>


--------------------------------------------------------------------------------
/layouts/partials/widget-recent.html:
--------------------------------------------------------------------------------
 1 | <div class="card">
 2 |     <div class="card-content">
 3 |         <h1 class="title is-5">Recent posts</h1>
 4 |         {{ range first 5 (where .Site.RegularPages "Section" "post").ByPublishDate.Reverse }}
 5 |             <h1><a href="{{ .Permalink | absURL }}">{{ .Title }}</a></h1>
 6 |             <time class="has-text-grey-light is-size-7">{{ .Date.Day }} {{ .Date.Month }} {{ .Date.Year }}</time>
 7 |         {{ end }}
 8 |     </div>
 9 | </div>
10 |     


--------------------------------------------------------------------------------
/exampleSite/content/about.md:
--------------------------------------------------------------------------------
 1 | +++
 2 | title = "About Hugo"
 3 | date = "2014-04-09"
 4 | menu = "main"
 5 | +++
 6 | 
 7 | Hugo is the **world’s fastest framework for building websites**. It is written in Go.
 8 | 
 9 | It makes use of a variety of open source projects including:
10 | 
11 | * https://github.com/russross/blackfriday
12 | * https://github.com/alecthomas/chroma
13 | * https://github.com/muesli/smartcrop
14 | * https://github.com/spf13/cobra
15 | * https://github.com/spf13/viper
16 | 
17 | Learn more and contribute on [GitHub](https://github.com/gohugoio).
18 | 
19 | 


--------------------------------------------------------------------------------
/layouts/_default/single.html:
--------------------------------------------------------------------------------
 1 | {{ define "main" }}
 2 | 
 3 | <div class="columns">
 4 |     <div class="column is-9">
 5 |         <div class="tile is-child box">
 6 |             <div class="content">
 7 |                 {{ .Content }}
 8 |             </div>
 9 |         </div>
10 |     </div>
11 |     <div class="column is-3">
12 |         {{ partial "widget-tags.html" . }}<br>
13 |         {{ partial "widget-recent.html" . }}<br>
14 |         {{ partial "widget-related.html" . }}<br>
15 |         {{ partial "widget-archives.html" . }}
16 |     </div>
17 | </div>
18 | 
19 | {{ end }}
20 | 


--------------------------------------------------------------------------------
/theme.toml:
--------------------------------------------------------------------------------
 1 | # theme.toml template for a Hugo theme
 2 | # See https://github.com/gohugoio/hugoThemes#themetoml for an example
 3 | 
 4 | name = "Jeffprod"
 5 | license = "MIT"
 6 | licenselink = "https://github.com/Tazeg/hugo-blog-jeffprod/blob/master/LICENSE"
 7 | description = "A new theme blog for HUGO built with Bulma CSS. Including archives and tags widgets."
 8 | homepage = "https://github.com/Tazeg/hugo-blog-jeffprod"
 9 | tags = ["simple","blog","theme","pagination","archives","tags","bulma","personal"]
10 | features = ["pagination","archives","tags"]
11 | min_version = "0.41"
12 | 
13 | [author]
14 |   name = "@JeffProd"
15 |   homepage = "https://jeffprod.com"
16 | 


--------------------------------------------------------------------------------
/layouts/partials/widget-related.html:
--------------------------------------------------------------------------------
 1 |         {{ range first 1 (where (where .Site.Pages ".Params.tags" "intersect" .Params.tags) "Permalink" "!=" .Permalink) }}
 2 |   {{ $.Scratch.Set "has_related" true }}
 3 | {{ end }}
 4 | 
 5 | {{ if $.Scratch.Get "has_related" }}
 6 | <div class="card">
 7 |     <div class="card-content">
 8 |         <h1 class="title is-5">Related posts</h1>
 9 |       {{ $num_to_show := .Site.Params.related_content_limit | default 7 }}
10 |       {{ range first $num_to_show (where (where .Site.Pages ".Params.tags" "intersect" .Params.tags) "Permalink" "!=" .Permalink) }}
11 |             <h1><a href="{{ .Permalink | absURL }}">{{ .Title }}</a></h1>
12 |             <time class="has-text-grey-light is-size-7">{{ .Date.Day }} {{ .Date.Month }} {{ .Date.Year }}</time>
13 |       {{ end }}
14 |     </div>
15 | </div>
16 | {{ end }}
17 |     
18 | 


--------------------------------------------------------------------------------
/layouts/partials/footer.html:
--------------------------------------------------------------------------------
 1 | <footer class="footer has-background-grey-darker has-text-white">
 2 |     <div class="content has-text-centered">
 3 |         <p>
 4 |             <span class="icon is-large"><a href="https://twitter.com/" class="mysocial" rel="me"><i class="fab fa-twitter fa-3x"></i></a></span>&nbsp;&nbsp;
 5 |             <span class="icon is-large"><a href="https://www.youtube.com/" class="mysocial" rel="me"><i class="fab fa-youtube fa-3x"></i></a></span>&nbsp;&nbsp;
 6 |             <span class="icon is-large"><a href="https://github.com/" class="mysocial" rel="me"><i class="fab fa-github fa-3x"></i></a></span>&nbsp;&nbsp;
 7 |             <br><br>
 8 |             Copyright &copy; {{ .Site.Title }} {{ now.Format "2006"}} - Theme by <a href="https://jeffprod.com" class="mysocial">JeffProd.com</a>
 9 |             - <a class="mysocial" href="{{ "about" | absURL }}">About</a>
10 |         </p>
11 |     </div>
12 | </footer>
13 | 
14 | <script defer src="https://use.fontawesome.com/releases/v5.1.0/js/all.js"></script>
15 | </body>
16 | </html>
17 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2018 @JeffProd
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of
 6 | this software and associated documentation files (the "Software"), to deal in
 7 | the Software without restriction, including without limitation the rights to
 8 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 9 | the Software, and to permit persons to whom the Software is furnished to do so,
10 | subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # HUGO blog theme by @JeffProd
 2 | 
 3 | A free blog theme for [HUGO](https://gohugo.io/), with tags, archives, last posts... Using [Bulma CSS framework](https://bulma.io/).
 4 | 
 5 | ![HUGO blog theme by JeffProd.com](images/screenshot.png)
 6 | 
 7 | # Install
 8 | 
 9 | Install HUGO (<https://gohugo.io/>) then :
10 | 
11 | ```
12 | hugo new site myblog
13 | cd myblog
14 | git clone https://github.com/Tazeg/hugo-blog-jeffprod.git themes/jeffprod
15 | ```
16 | In the file `config.toml` add the lines :
17 | ```
18 | theme = "jeffprod"
19 | 
20 | [permalinks]
21 |     post = "/:year/:filename"
22 | 
23 | [taxonomies]
24 |     tag = "tags"
25 |     archive = "archives"
26 | ```
27 | 
28 | ### Write blog posts
29 | 
30 | ```
31 | hugo new post/my-first-post.md
32 | ```
33 | And edit this new file `content/post/my-first-post.md`. You can use [HUGO shortcodes](https://gohugo.io/content-management/shortcodes/) and [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).
34 | 
35 | ### Render
36 | 
37 | ```
38 | hugo server
39 | ```
40 | Then go to <http://localhost:1313>
41 | 
42 | ### Create the web site
43 | 
44 | ```
45 | hugo
46 | ```
47 | 
48 | All files to publish are in `public/` directory.
49 | 
50 | # Donate
51 | 
52 | <https://en.jeffprod.com/donate/>
53 | 
54 | # Credits
55 | 
56 | Background image by https://pixabay.com
57 | 


--------------------------------------------------------------------------------
/layouts/tags/list.html:
--------------------------------------------------------------------------------
 1 | {{ define "main" }}
 2 | 
 3 | {{ $tag := lower .Title }}
 4 | 
 5 | <div class="columns">
 6 |     <div class="column is-9">
 7 |         <div class="tile is-child box">
 8 |             <div class="content">
 9 | {{ range $key, $value := .Site.Taxonomies.tags }}{{ if eq $key $tag }}{{ range $value.Pages }}
10 |                 <article class="media">
11 |                     <div class="media-content">
12 |                         <div class="content">
13 |                             <p class="title is-4"><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></p>
14 |                             <p class="subtitle is-size-6 has-text-grey-light">
15 |                                 Published at {{ .Date.Format "January 2, 2006" }} &middot;
16 |                                 <i class="far fa-clock"></i>&nbsp;{{.ReadingTime}} min read
17 |                             </p>
18 |                             <p>{{ .Summary }}...</p>
19 |                         </div>
20 |                     </div>
21 |                 </article>
22 |                 <br>
23 | {{ end }}{{ end }}{{ end }}
24 |             </div>
25 |         </div>
26 |     </div>
27 |     <div class="column is-3">
28 |         {{ partial "widget-tags.html" . }}<br>
29 |         {{ partial "widget-recent.html" . }}<br>
30 |         {{ partial "widget-archives.html" . }}
31 |     </div>
32 | </div>
33 | 
34 | {{ end }}
35 | 


--------------------------------------------------------------------------------
/layouts/taxonomy/tag.html:
--------------------------------------------------------------------------------
 1 | {{ define "main" }}
 2 | 
 3 | {{ $tag := lower .Title }}
 4 | 
 5 | <div class="columns">
 6 |     <div class="column is-9">
 7 |         <div class="tile is-child box">
 8 |             <div class="content">
 9 | {{ range $key, $value := .Site.Taxonomies.tags }}{{ if eq $key $tag }}{{ range $value.Pages }}
10 |                 <article class="media">
11 |                     <div class="media-content">
12 |                         <div class="content">
13 |                             <p class="title is-4"><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></p>
14 |                             <p class="subtitle is-size-6 has-text-grey-light">
15 |                                 Published at {{ .Date.Format "January 2, 2006" }} &middot;
16 |                                 <i class="far fa-clock"></i>&nbsp;{{.ReadingTime}} min read
17 |                             </p>
18 |                             <p>{{ .Summary }}...</p>
19 |                         </div>
20 |                     </div>
21 |                 </article>
22 |                 <br>
23 | {{ end }}{{ end }}{{ end }}
24 |             </div>
25 |         </div>
26 |     </div>
27 |     <div class="column is-3">
28 |         {{ partial "widget-tags.html" . }}<br>
29 |         {{ partial "widget-recent.html" . }}<br>
30 |         {{ partial "widget-archives.html" . }}
31 |     </div>
32 | </div>
33 | 
34 | {{ end }}
35 | 


--------------------------------------------------------------------------------
/layouts/archives/list.html:
--------------------------------------------------------------------------------
 1 | {{ define "main" }}
 2 | {{ $archive := lower .Title }}
 3 | 
 4 | <div class="columns">
 5 |     <div class="column is-9">
 6 |         <div class="tile is-child box">
 7 |             <div class="content">
 8 | {{ range $key, $value := .Site.Taxonomies.archives }}{{ if eq $key $archive }}{{ range $value.Pages }}
 9 |                 <article class="media">
10 |                     <div class="media-content">
11 |                         <div class="content">
12 |                             <p class="title is-4"><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></p>
13 |                             <p class="subtitle is-size-6 has-text-grey-light">
14 |                                 Published at {{ .Date.Format "January 2, 2006" }} &middot;
15 |                                 <i class="far fa-clock"></i>&nbsp;{{.ReadingTime}} min read
16 |                             </p>
17 |                             <p>{{ .Summary }}...</p>
18 |                         </div>
19 |                     </div>
20 |                 </article>
21 |                 <br>
22 | {{ end }}{{ end }}{{ end }}
23 |             </div>
24 |         </div>
25 |     </div>
26 |     <div class="column is-3">
27 |         {{ partial "widget-tags.html" . }}<br>
28 |         {{ partial "widget-recent.html" . }}<br>
29 |         {{ partial "widget-archives.html" . }}
30 |     </div>
31 | </div>
32 | 
33 | 
34 | {{ end }}


--------------------------------------------------------------------------------
/layouts/taxonomy/archive.html:
--------------------------------------------------------------------------------
 1 | {{ define "main" }}
 2 | {{ $archive := lower .Title }}
 3 | 
 4 | <div class="columns">
 5 |     <div class="column is-9">
 6 |         <div class="tile is-child box">
 7 |             <div class="content">
 8 | {{ range $key, $value := .Site.Taxonomies.archives }}{{ if eq $key $archive }}{{ range $value.Pages }}
 9 |                 <article class="media">
10 |                     <div class="media-content">
11 |                         <div class="content">
12 |                             <p class="title is-4"><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></p>
13 |                             <p class="subtitle is-size-6 has-text-grey-light">
14 |                                 Published at {{ .Date.Format "January 2, 2006" }} &middot;
15 |                                 <i class="far fa-clock"></i>&nbsp;{{.ReadingTime}} min read
16 |                             </p>
17 |                             <p>{{ .Summary }}...</p>
18 |                         </div>
19 |                     </div>
20 |                 </article>
21 |                 <br>
22 | {{ end }}{{ end }}{{ end }}
23 |             </div>
24 |         </div>
25 |     </div>
26 |     <div class="column is-3">
27 |         {{ partial "widget-tags.html" . }}<br>
28 |         {{ partial "widget-recent.html" . }}<br>
29 |         {{ partial "widget-archives.html" . }}
30 |     </div>
31 | </div>
32 | 
33 | 
34 | {{ end }}


--------------------------------------------------------------------------------
/layouts/post/list.html:
--------------------------------------------------------------------------------
 1 | {{ define "main" }}
 2 | {{ $archive := lower .Title }}
 3 | 
 4 | <div class="columns">
 5 |     <div class="column is-9">
 6 |         <div class="tile is-child box">
 7 |             <div class="content">
 8 | {{ range $key, $value := .Site.Taxonomies.archives }}{{ if eq $key $archive }}{{ range $value.Pages }}
 9 |                 <article class="media">
10 |                     <div class="media-content">
11 |                         <div class="content">
12 |                             <p class="title is-4"><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></p>
13 |                             <p class="subtitle is-size-6 has-text-grey-light">
14 |                                 Published at {{ .Date.Format "January 2, 2006" }} &middot;
15 |                                 <i class="far fa-clock"></i>&nbsp;{{.ReadingTime}} min read
16 |                             </p>
17 |                             <p>{{ .Summary }}...</p>
18 |                         </div>
19 |                     </div>
20 |                 </article>
21 |                 <br>
22 | {{ end }}{{ end }}{{ end }}
23 |             </div>
24 |         </div>
25 |     </div>
26 |     <div class="column is-3">
27 |         {{ partial "widget-tags.html" . }}<br>
28 |         {{ partial "widget-recent.html" . }}<br>
29 |         {{ partial "widget-related.html" . }}<br>
30 |         {{ partial "widget-archives.html" . }}
31 |     </div>
32 | </div>
33 | 
34 | 
35 | {{ end }}


--------------------------------------------------------------------------------
/layouts/_default/rss.xml:
--------------------------------------------------------------------------------
 1 | <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
 2 |   <channel>
 3 |     <title>{{ if eq  .Title  .Site.Title }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{.}} on {{ end }}{{ .Site.Title }}{{ end }}</title>
 4 |     <link>{{ .Permalink }}</link>
 5 |     <description>Recent content {{ if ne  .Title  .Site.Title }}{{ with .Title }}in {{.}} {{ end }}{{ end }}on {{ .Site.Title }}</description>
 6 |     <generator>Hugo -- gohugo.io</generator>{{ with .Site.LanguageCode }}
 7 |     <language>{{.}}</language>{{end}}{{ with .Site.Author.email }}
 8 |     <managingEditor>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</managingEditor>{{end}}{{ with .Site.Author.email }}
 9 |     <webMaster>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</webMaster>{{end}}{{ with .Site.Copyright }}
10 |     <copyright>{{.}}</copyright>{{end}}{{ if not .Date.IsZero }}
11 |     <lastBuildDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</lastBuildDate>{{ end }}
12 |     {{ with .OutputFormats.Get "RSS" }}
13 |         {{ printf "<atom:link href=%q rel=\"self\" type=%q />" .Permalink .MediaType | safeHTML }}
14 |     {{ end }}
15 |     {{ range .Pages }}
16 |     <item>
17 |       <title>{{ .Title }}</title>
18 |       <link>{{ .Permalink }}</link>
19 |       <pubDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</pubDate>
20 |       {{ with .Site.Author.email }}<author>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</author>{{end}}
21 |       <guid>{{ .Permalink }}</guid>
22 |       <description>{{ .Summary | html }}</description>
23 |     </item>
24 |     {{ end }}
25 |   </channel>
26 | </rss>
27 | 


--------------------------------------------------------------------------------
/layouts/partials/header.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="{{ $.Site.LanguageCode | default "en" }}">
 3 | <head>
 4 |     <meta charset="utf-8">
 5 |     <meta http-equiv="X-UA-Compatible" content="IE=edge">
 6 |     <title>{{ .Site.Title }} {{ with .Title }} | {{ . }}{{ end }}</title>
 7 |     <meta name="viewport" content="width=device-width, initial-scale=1">
 8 | 
 9 |     <link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet">
10 |     <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
11 |     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/bulma/0.7.1/css/bulma.min.css" />
12 |     <link rel="stylesheet" href="{{ "css/blog.css" | absURL }}" />
13 |     {{ with .OutputFormats.Get "rss" -}}
14 |       {{ printf `<link rel="%s" type="%s" href="%s" title="%s" />` .Rel .MediaType.Type .Permalink $.Site.Title | safeHTML }}
15 |     {{ end -}}
16 | </head>
17 | <body>
18 | 
19 |     <!-- nav -->
20 |     <nav class="navbar is-fixed-top" role="navigation" aria-label="main navigation">
21 |         <div class="navbar-brand">
22 |             <a class="navbar-item" href="{{ .Site.BaseURL | absURL }}">Home</a>
23 |         </div>
24 |     </nav>
25 |     <!-- /nav -->
26 | 
27 |     <!-- hero -->
28 |     <section class="hero is-info is-medium">
29 |         <div class="hero-body" style="background-image: url({{ "img/bg-blog.jpg" | absURL }});">
30 |             <div class="container has-text-centered">
31 |                 <br>
32 |                 <h1 class="title is-size-1">
33 |                     {{ if eq .Type "tags" }}
34 |                         #{{ .Title }}
35 |                     {{ else if eq .Type "archives" }}
36 |                         Archive {{ .Title }}
37 |                     {{ else }}
38 |                         {{ .Title }}
39 |                     {{ end }}
40 |                 </h1>
41 |                 {{ if eq .Type "article" }}
42 |                     {{ .Date.Format "January 2, 2006" }} &middot;&nbsp;{{ .ReadingTime }} min read
43 |                 {{ end }}
44 |             </div>
45 |         </div>
46 |     </section>
47 | 


--------------------------------------------------------------------------------
/layouts/index.html:
--------------------------------------------------------------------------------
 1 | {{ define "main" }}
 2 | {{ $paginator := .Paginate (where .Site.RegularPages "Section" "post").ByPublishDate.Reverse }}
 3 | 
 4 | <div class="columns">
 5 |     <div class="column is-9">
 6 |         <div class="tile is-child box">
 7 |             <div class="content">
 8 |                 <h3>Welcome to my blog !</h3>
 9 |                 <hr>
10 |                 {{ range $paginator.Pages }}
11 |                     <article class="media">
12 |                         <div class="media-content">
13 |                             <div class="content">
14 |                                 <p class="title is-4"><a href="{{ .Permalink }}">{{ .LinkTitle }}</a></p>
15 |                                 <p class="subtitle is-size-6 has-text-grey-light">
16 |                                     Published at {{ .Date.Format "January 2, 2006" }} &middot;
17 |                                     <i class="far fa-clock"></i>&nbsp;{{.ReadingTime}} min read
18 |                                 </p>
19 |                                 <p>{{ .Summary }}...</p>
20 |                             </div>
21 |                         </div>
22 |                     </article>
23 |                 {{ end }}
24 |             </div>
25 |         </div>
26 |     </div>
27 |     <div class="column is-3">
28 |         {{ partial "widget-tags.html" . }}<br>
29 |         {{ partial "widget-recent.html" . }}<br>
30 |         {{ partial "widget-archives.html" . }}
31 |     </div>
32 | </div>
33 | <div class="columns">
34 |     <div class="column is-9">
35 |         <nav class="pagination is-centered is-rounded" role="navigation" aria-label="pagination">
36 |             {{ if $paginator.HasPrev }}<a class="pagination-previous" href="{{ $paginator.Prev.URL }}">Previous</a>{{ end }}
37 |             {{ if $paginator.HasNext }}<a class="pagination-next" href="{{ $paginator.Next.URL }}">Next</a>{{ end }}
38 |             <ul class="pagination-list">
39 |                 {{ range $paginator.Pagers }}
40 |                 <li class="pagination__item">
41 |                     <a class="pagination-link{{ if eq . $paginator }} is-current{{ end }}" aria-label="Goto page {{ .PageNumber }}" href="{{ .URL }}">{{ .PageNumber }}</a>
42 |                 </li>
43 |                 {{ end }}
44 |             </ul>
45 |         </nav>
46 |     </div>
47 | </div>
48 | 
49 | {{ end }}
50 | 


--------------------------------------------------------------------------------
/exampleSite/content/post/hugoisforlovers.md:
--------------------------------------------------------------------------------
 1 | +++
 2 | title = "Getting Started with Hugo"
 3 | description = ""
 4 | tags = [
 5 |     "go",
 6 |     "golang",
 7 |     "hugo",
 8 |     "development",
 9 | ]
10 | date = "2014-04-02"
11 | archives = "2014"
12 | categories = [
13 |     "Development",
14 |     "golang",
15 | ]
16 | menu = "main"
17 | +++
18 | 
19 | ## Step 1. Install Hugo
20 | 
21 | Go to [Hugo releases](https://github.com/spf13/hugo/releases) and download the
22 | appropriate version for your OS and architecture.
23 | 
24 | Save it somewhere specific as we will be using it in the next step.
25 | 
26 | More complete instructions are available at [Install Hugo](https://gohugo.io/getting-started/installing/)
27 | 
28 | ## Step 2. Build the Docs
29 | 
30 | Hugo has its own example site which happens to also be the documentation site
31 | you are reading right now.
32 | 
33 | Follow the following steps:
34 | 
35 |  1. Clone the [Hugo repository](http://github.com/spf13/hugo)
36 |  2. Go into the repo
37 |  3. Run hugo in server mode and build the docs
38 |  4. Open your browser to http://localhost:1313
39 | 
40 | Corresponding pseudo commands:
41 | 
42 |     git clone https://github.com/spf13/hugo
43 |     cd hugo
44 |     /path/to/where/you/installed/hugo server --source=./docs
45 |     > 29 pages created
46 |     > 0 tags index created
47 |     > in 27 ms
48 |     > Web Server is available at http://localhost:1313
49 |     > Press ctrl+c to stop
50 | 
51 | Once you've gotten here, follow along the rest of this page on your local build.
52 | 
53 | ## Step 3. Change the docs site
54 | 
55 | Stop the Hugo process by hitting Ctrl+C.
56 | 
57 | Now we are going to run hugo again, but this time with hugo in watch mode.
58 | 
59 |     /path/to/hugo/from/step/1/hugo server --source=./docs --watch
60 |     > 29 pages created
61 |     > 0 tags index created
62 |     > in 27 ms
63 |     > Web Server is available at http://localhost:1313
64 |     > Watching for changes in /Users/spf13/Code/hugo/docs/content
65 |     > Press ctrl+c to stop
66 | 
67 | 
68 | Open your [favorite editor](http://vim.spf13.com) and change one of the source
69 | content pages. How about changing this very file to *fix the typo*. How about changing this very file to *fix the typo*.
70 | 
71 | Content files are found in `docs/content/`. Unless otherwise specified, files
72 | are located at the same relative location as the url, in our case
73 | `docs/content/overview/quickstart.md`.
74 | 
75 | Change and save this file.. Notice what happened in your terminal.
76 | 
77 |     > Change detected, rebuilding site
78 | 
79 |     > 29 pages created
80 |     > 0 tags index created
81 |     > in 26 ms
82 | 
83 | Refresh the browser and observe that the typo is now fixed.
84 | 
85 | Notice how quick that was. Try to refresh the site before it's finished building. I double dare you.
86 | Having nearly instant feedback enables you to have your creativity flow without waiting for long builds.
87 | 
88 | ## Step 4. Have fun
89 | 
90 | The best way to learn something is to play with it.
91 | 


--------------------------------------------------------------------------------
/exampleSite/content/post/migrate-from-jekyll.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | date: 2014-03-10
  3 | archives: "2014"
  4 | linktitle: Migrating from Jekyll
  5 | menu:
  6 |   main:
  7 |     parent: tutorials
  8 | prev: /tutorials/mathjax
  9 | title: Migrate to Hugo from Jekyll
 10 | weight: 10
 11 | ---
 12 | 
 13 | ## Move static content to `static`
 14 | Jekyll has a rule that any directory not starting with `_` will be copied as-is to the `_site` output. Hugo keeps all static content under `static`. You should therefore move it all there.
 15 | With Jekyll, something that looked like
 16 | 
 17 |     ▾ <root>/
 18 |         ▾ images/
 19 |             logo.png
 20 | 
 21 | should become
 22 | 
 23 |     ▾ <root>/
 24 |         ▾ static/
 25 |             ▾ images/
 26 |                 logo.png
 27 | 
 28 | Additionally, you'll want any files that should reside at the root (such as `CNAME`) to be moved to `static`.
 29 | 
 30 | ## Create your Hugo configuration file
 31 | Hugo can read your configuration as JSON, YAML or TOML. Hugo supports parameters custom configuration too. Refer to the [Hugo configuration documentation](/overview/configuration/) for details.
 32 | 
 33 | ## Set your configuration publish folder to `_site`
 34 | The default is for Jekyll to publish to `_site` and for Hugo to publish to `public`. If, like me, you have [`_site` mapped to a git submodule on the `gh-pages` branch](http://blog.blindgaenger.net/generate_github_pages_in_a_submodule.html), you'll want to do one of two alternatives:
 35 | 
 36 | 1. Change your submodule to point to map `gh-pages` to public instead of `_site` (recommended).
 37 | 
 38 |         git submodule deinit _site
 39 |         git rm _site
 40 |         git submodule add -b gh-pages git@github.com:your-username/your-repo.git public
 41 | 
 42 | 2. Or, change the Hugo configuration to use `_site` instead of `public`.
 43 | 
 44 |         {
 45 |             ..
 46 |             "publishdir": "_site",
 47 |             ..
 48 |         }
 49 | 
 50 | ## Convert Jekyll templates to Hugo templates
 51 | That's the bulk of the work right here. The documentation is your friend. You should refer to [Jekyll's template documentation](http://jekyllrb.com/docs/templates/) if you need to refresh your memory on how you built your blog and [Hugo's template](/layout/templates/) to learn Hugo's way.
 52 | 
 53 | As a single reference data point, converting my templates for [heyitsalex.net](http://heyitsalex.net/) took me no more than a few hours.
 54 | 
 55 | ## Convert Jekyll plugins to Hugo shortcodes
 56 | Jekyll has [plugins](http://jekyllrb.com/docs/plugins/); Hugo has [shortcodes](/doc/shortcodes/). It's fairly trivial to do a port.
 57 | 
 58 | ### Implementation
 59 | As an example, I was using a custom [`image_tag`](https://github.com/alexandre-normand/alexandre-normand/blob/74bb12036a71334fdb7dba84e073382fc06908ec/_plugins/image_tag.rb) 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.
 60 | 
 61 | Jekyll's plugin:
 62 | 
 63 |     module Jekyll
 64 |       class ImageTag < Liquid::Tag
 65 |         @url = nil
 66 |         @caption = nil
 67 |         @class = nil
 68 |         @link = nil
 69 |         // Patterns
 70 |         IMAGE_URL_WITH_CLASS_AND_CAPTION =
 71 |         IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK = /(\w+)(\s+)((https?:\/\/|\/)(\S+))(\s+)"(.*?)"(\s+)->((https?:\/\/|\/)(\S+))(\s*)/i
 72 |         IMAGE_URL_WITH_CAPTION = /((https?:\/\/|\/)(\S+))(\s+)"(.*?)"/i
 73 |         IMAGE_URL_WITH_CLASS = /(\w+)(\s+)((https?:\/\/|\/)(\S+))/i
 74 |         IMAGE_URL = /((https?:\/\/|\/)(\S+))/i
 75 |         def initialize(tag_name, markup, tokens)
 76 |           super
 77 |           if markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK
 78 |             @class   = $1
 79 |             @url     = $3
 80 |             @caption = $7
 81 |             @link = $9
 82 |           elsif markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION
 83 |             @class   = $1
 84 |             @url     = $3
 85 |             @caption = $7
 86 |           elsif markup =~ IMAGE_URL_WITH_CAPTION
 87 |             @url     = $1
 88 |             @caption = $5
 89 |           elsif markup =~ IMAGE_URL_WITH_CLASS
 90 |             @class = $1
 91 |             @url   = $3
 92 |           elsif markup =~ IMAGE_URL
 93 |             @url = $1
 94 |           end
 95 |         end
 96 |         def render(context)
 97 |           if @class
 98 |             source = "<figure class='#{@class}'>"
 99 |           else
100 |             source = "<figure>"
101 |           end
102 |           if @link
103 |             source += "<a href=\"#{@link}\">"
104 |           end
105 |           source += "<img src=\"#{@url}\">"
106 |           if @link
107 |             source += "</a>"
108 |           end
109 |           source += "<figcaption>#{@caption}</figcaption>" if @caption
110 |           source += "</figure>"
111 |           source
112 |         end
113 |       end
114 |     end
115 |     Liquid::Template.register_tag('image', Jekyll::ImageTag)
116 | 
117 | is written as this Hugo shortcode:
118 | 
119 |     <!-- image -->
120 |     <figure {{ with .Get "class" }}class="{{.}}"{{ end }}>
121 |         {{ with .Get "link"}}<a href="{{.}}">{{ end }}
122 |             <img src="{{ .Get "src" }}" {{ if or (.Get "alt") (.Get "caption") }}alt="{{ with .Get "alt"}}{{.}}{{else}}{{ .Get "caption" }}{{ end }}"{{ end }} />
123 |         {{ if .Get "link"}}</a>{{ end }}
124 |         {{ if or (or (.Get "title") (.Get "caption")) (.Get "attr")}}
125 |         <figcaption>{{ if isset .Params "title" }}
126 |             {{ .Get "title" }}{{ end }}
127 |             {{ if or (.Get "caption") (.Get "attr")}}<p>
128 |             {{ .Get "caption" }}
129 |             {{ with .Get "attrlink"}}<a href="{{.}}"> {{ end }}
130 |                 {{ .Get "attr" }}
131 |             {{ if .Get "attrlink"}}</a> {{ end }}
132 |             </p> {{ end }}
133 |         </figcaption>
134 |         {{ end }}
135 |     </figure>
136 |     <!-- image -->
137 | 
138 | ### Usage
139 | I simply changed:
140 | 
141 |     {% 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/ %}
142 | 
143 | to this (this example uses a slightly extended version named `fig`, different than the built-in `figure`):
144 | 
145 |     {{%/* 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/" */%}}
146 | 
147 | As a bonus, the shortcode named parameters are, arguably, more readable.
148 | 
149 | ## Finishing touches
150 | ### Fix content
151 | 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 `hugo server --watch` is your friend. Test your changes and fix errors as needed.
152 | 
153 | ### Clean up
154 | You'll want to remove the Jekyll configuration at this point. If you have anything else that isn't used, delete it.
155 | 
156 | ## A practical example in a diff
157 | [Hey, it's Alex](http://heyitsalex.net/) was migrated in less than a _father-with-kids day_ from Jekyll to Hugo. You can see all the changes (and screw-ups) by looking at this [diff](https://github.com/alexandre-normand/alexandre-normand/compare/869d69435bd2665c3fbf5b5c78d4c22759d7613a...b7f6605b1265e83b4b81495423294208cc74d610).
158 | 


--------------------------------------------------------------------------------
/exampleSite/content/post/goisforlovers.md:
--------------------------------------------------------------------------------
  1 | +++
  2 | title = "(Hu)go Template Primer"
  3 | description = ""
  4 | tags = [
  5 |     "go",
  6 |     "golang",
  7 |     "templates",
  8 |     "themes",
  9 |     "development",
 10 | ]
 11 | date = "2014-04-02"
 12 | archives = "2014"
 13 | categories = [
 14 |     "Development",
 15 |     "golang",
 16 | ]
 17 | menu = "main"
 18 | +++
 19 | 
 20 | Hugo uses the excellent [Go][] [html/template][gohtmltemplate] library for
 21 | its template engine. It is an extremely lightweight engine that provides a very
 22 | small amount of logic. In our experience that it is just the right amount of
 23 | logic to be able to create a good static website. If you have used other
 24 | template systems from different languages or frameworks you will find a lot of
 25 | similarities in Go templates.
 26 | 
 27 | This document is a brief primer on using Go templates. The [Go docs][gohtmltemplate]
 28 | provide more details.
 29 | 
 30 | ## Introduction to Go Templates
 31 | 
 32 | Go templates provide an extremely simple template language. It adheres to the
 33 | belief that only the most basic of logic belongs in the template or view layer.
 34 | One consequence of this simplicity is that Go templates parse very quickly.
 35 | 
 36 | A unique characteristic of Go templates is they are content aware. Variables and
 37 | content will be sanitized depending on the context of where they are used. More
 38 | details can be found in the [Go docs][gohtmltemplate].
 39 | 
 40 | ## Basic Syntax
 41 | 
 42 | Golang templates are HTML files with the addition of variables and
 43 | functions.
 44 | 
 45 | **Go variables and functions are accessible within {{ }}**
 46 | 
 47 | Accessing a predefined variable "foo":
 48 | 
 49 |     {{ foo }}
 50 | 
 51 | **Parameters are separated using spaces**
 52 | 
 53 | Calling the add function with input of 1, 2:
 54 | 
 55 |     {{ add 1 2 }}
 56 | 
 57 | **Methods and fields are accessed via dot notation**
 58 | 
 59 | Accessing the Page Parameter "bar"
 60 | 
 61 |     {{ .Params.bar }}
 62 | 
 63 | **Parentheses can be used to group items together**
 64 | 
 65 |     {{ if or (isset .Params "alt") (isset .Params "caption") }} Caption {{ end }}
 66 | 
 67 | 
 68 | ## Variables
 69 | 
 70 | Each Go template has a struct (object) made available to it. In hugo each
 71 | template is passed either a page or a node struct depending on which type of
 72 | page you are rendering. More details are available on the
 73 | [variables](/layout/variables) page.
 74 | 
 75 | A variable is accessed by referencing the variable name.
 76 | 
 77 |     <title>{{ .Title }}</title>
 78 | 
 79 | Variables can also be defined and referenced.
 80 | 
 81 |     {{ $address := "123 Main St."}}
 82 |     {{ $address }}
 83 | 
 84 | 
 85 | ## Functions
 86 | 
 87 | Go template ship with a few functions which provide basic functionality. The Go
 88 | template system also provides a mechanism for applications to extend the
 89 | available functions with their own. [Hugo template
 90 | functions](/layout/functions) provide some additional functionality we believe
 91 | are useful for building websites. Functions are called by using their name
 92 | followed by the required parameters separated by spaces. Template
 93 | functions cannot be added without recompiling hugo.
 94 | 
 95 | **Example:**
 96 | 
 97 |     {{ add 1 2 }}
 98 | 
 99 | ## Includes
100 | 
101 | When including another template you will pass to it the data it will be
102 | able to access. To pass along the current context please remember to
103 | include a trailing dot. The templates location will always be starting at
104 | the /layout/ directory within Hugo.
105 | 
106 | **Example:**
107 | 
108 |     {{ template "chrome/header.html" . }}
109 | 
110 | 
111 | ## Logic
112 | 
113 | Go templates provide the most basic iteration and conditional logic.
114 | 
115 | ### Iteration
116 | 
117 | Just like in Go, the Go templates make heavy use of range to iterate over
118 | a map, array or slice. The following are different examples of how to use
119 | range.
120 | 
121 | **Example 1: Using Context**
122 | 
123 |     {{ range array }}
124 |         {{ . }}
125 |     {{ end }}
126 | 
127 | **Example 2: Declaring value variable name**
128 | 
129 |     {{range $element := array}}
130 |         {{ $element }}
131 |     {{ end }}
132 | 
133 | **Example 2: Declaring key and value variable name**
134 | 
135 |     {{range $index, $element := array}}
136 |         {{ $index }}
137 |         {{ $element }}
138 |     {{ end }}
139 | 
140 | ### Conditionals
141 | 
142 | If, else, with, or, & and provide the framework for handling conditional
143 | logic in Go Templates. Like range, each statement is closed with `end`.
144 | 
145 | 
146 | Go Templates treat the following values as false:
147 | 
148 | * false
149 | * 0
150 | * any array, slice, map, or string of length zero
151 | 
152 | **Example 1: If**
153 | 
154 |     {{ if isset .Params "title" }}<h4>{{ index .Params "title" }}</h4>{{ end }}
155 | 
156 | **Example 2: If -> Else**
157 | 
158 |     {{ if isset .Params "alt" }}
159 |         {{ index .Params "alt" }}
160 |     {{else}}
161 |         {{ index .Params "caption" }}
162 |     {{ end }}
163 | 
164 | **Example 3: And & Or**
165 | 
166 |     {{ if and (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}}
167 | 
168 | **Example 4: With**
169 | 
170 | An alternative way of writing "if" and then referencing the same value
171 | is to use "with" instead. With rebinds the context `.` within its scope,
172 | and skips the block if the variable is absent.
173 | 
174 | The first example above could be simplified as:
175 | 
176 |     {{ with .Params.title }}<h4>{{ . }}</h4>{{ end }}
177 | 
178 | **Example 5: If -> Else If**
179 | 
180 |     {{ if isset .Params "alt" }}
181 |         {{ index .Params "alt" }}
182 |     {{ else if isset .Params "caption" }}
183 |         {{ index .Params "caption" }}
184 |     {{ end }}
185 | 
186 | ## Pipes
187 | 
188 | One of the most powerful components of Go templates is the ability to
189 | stack actions one after another. This is done by using pipes. Borrowed
190 | from unix pipes, the concept is simple, each pipeline's output becomes the
191 | input of the following pipe.
192 | 
193 | Because of the very simple syntax of Go templates, the pipe is essential
194 | to being able to chain together function calls. One limitation of the
195 | pipes is that they only can work with a single value and that value
196 | becomes the last parameter of the next pipeline.
197 | 
198 | A few simple examples should help convey how to use the pipe.
199 | 
200 | **Example 1 :**
201 | 
202 |     {{ if eq 1 1 }} Same {{ end }}
203 | 
204 | is the same as
205 | 
206 |     {{ eq 1 1 | if }} Same {{ end }}
207 | 
208 | It does look odd to place the if at the end, but it does provide a good
209 | illustration of how to use the pipes.
210 | 
211 | **Example 2 :**
212 | 
213 |     {{ index .Params "disqus_url" | html }}
214 | 
215 | Access the page parameter called "disqus_url" and escape the HTML.
216 | 
217 | **Example 3 :**
218 | 
219 |     {{ if or (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}}
220 |     Stuff Here
221 |     {{ end }}
222 | 
223 | Could be rewritten as
224 | 
225 |     {{  isset .Params "caption" | or isset .Params "title" | or isset .Params "attr" | if }}
226 |     Stuff Here
227 |     {{ end }}
228 | 
229 | 
230 | ## Context (aka. the dot)
231 | 
232 | The most easily overlooked concept to understand about Go templates is that {{ . }}
233 | always refers to the current context. In the top level of your template this
234 | will be the data set made available to it. Inside of a iteration it will have
235 | the value of the current item. When inside of a loop the context has changed. .
236 | will no longer refer to the data available to the entire page. If you need to
237 | access this from within the loop you will likely want to set it to a variable
238 | instead of depending on the context.
239 | 
240 | **Example:**
241 | 
242 |       {{ $title := .Site.Title }}
243 |       {{ range .Params.tags }}
244 |         <li> <a href="{{ $baseurl }}/tags/{{ . | urlize }}">{{ . }}</a> - {{ $title }} </li>
245 |       {{ end }}
246 | 
247 | Notice how once we have entered the loop the value of {{ . }} has changed. We
248 | have defined a variable outside of the loop so we have access to it from within
249 | the loop.
250 | 
251 | # Hugo Parameters
252 | 
253 | Hugo provides the option of passing values to the template language
254 | through the site configuration (for sitewide values), or through the meta
255 | data of each specific piece of content. You can define any values of any
256 | type (supported by your front matter/config format) and use them however
257 | you want to inside of your templates.
258 | 
259 | 
260 | ## Using Content (page) Parameters
261 | 
262 | In each piece of content you can provide variables to be used by the
263 | templates. This happens in the [front matter](/content/front-matter).
264 | 
265 | An example of this is used in this documentation site. Most of the pages
266 | benefit from having the table of contents provided. Sometimes the TOC just
267 | doesn't make a lot of sense. We've defined a variable in our front matter
268 | of some pages to turn off the TOC from being displayed.
269 | 
270 | Here is the example front matter:
271 | 
272 | ```
273 | ---
274 | title: "Permalinks"
275 | date: "2013-11-18"
276 | aliases:
277 |   - "/doc/permalinks/"
278 | groups: ["extras"]
279 | groups_weight: 30
280 | notoc: true
281 | ---
282 | ```
283 | 
284 | Here is the corresponding code inside of the template:
285 | 
286 |       {{ if not .Params.notoc }}
287 |         <div id="toc" class="well col-md-4 col-sm-6">
288 |         {{ .TableOfContents }}
289 |         </div>
290 |       {{ end }}
291 | 
292 | 
293 | 
294 | ## Using Site (config) Parameters
295 | In your top-level configuration file (eg, `config.yaml`) you can define site
296 | parameters, which are values which will be available to you in chrome.
297 | 
298 | For instance, you might declare:
299 | 
300 | ```yaml
301 | params:
302 |   CopyrightHTML: "Copyright &#xA9; 2013 John Doe. All Rights Reserved."
303 |   TwitterUser: "spf13"
304 |   SidebarRecentLimit: 5
305 | ```
306 | 
307 | Within a footer layout, you might then declare a `<footer>` which is only
308 | provided if the `CopyrightHTML` parameter is provided, and if it is given,
309 | you would declare it to be HTML-safe, so that the HTML entity is not escaped
310 | again.  This would let you easily update just your top-level config file each
311 | January 1st, instead of hunting through your templates.
312 | 
313 | ```
314 | {{if .Site.Params.CopyrightHTML}}<footer>
315 | <div class="text-center">{{.Site.Params.CopyrightHTML | safeHtml}}</div>
316 | </footer>{{end}}
317 | ```
318 | 
319 | An alternative way of writing the "if" and then referencing the same value
320 | is to use "with" instead. With rebinds the context `.` within its scope,
321 | and skips the block if the variable is absent:
322 | 
323 | ```
324 | {{with .Site.Params.TwitterUser}}<span class="twitter">
325 | <a href="https://twitter.com/{{.}}" rel="author">
326 | <img src="/images/twitter.png" width="48" height="48" title="Twitter: {{.}}"
327 |  alt="Twitter"></a>
328 | </span>{{end}}
329 | ```
330 | 
331 | Finally, if you want to pull "magic constants" out of your layouts, you can do
332 | so, such as in this example:
333 | 
334 | ```
335 | <nav class="recent">
336 |   <h1>Recent Posts</h1>
337 |   <ul>{{range first .Site.Params.SidebarRecentLimit .Site.Recent}}
338 |     <li><a href="{{.RelPermalink}}">{{.Title}}</a></li>
339 |   {{end}}</ul>
340 | </nav>
341 | ```
342 | 
343 | 
344 | [go]: https://golang.org/
345 | [gohtmltemplate]: https://golang.org/pkg/html/template/
346 | 


--------------------------------------------------------------------------------
/exampleSite/content/post/creating-a-new-theme.md:
--------------------------------------------------------------------------------
   1 | ---
   2 | author: "Michael Henderson"
   3 | date: 2014-09-28
   4 | archives: "2014"
   5 | linktitle: Creating a New Theme
   6 | menu:
   7 |   main:
   8 |     parent: tutorials
   9 | next: /tutorials/github-pages-blog
  10 | prev: /tutorials/automated-deployments
  11 | title: Creating a New Theme
  12 | weight: 10
  13 | ---
  14 | 
  15 | 
  16 | ## Introduction
  17 | 
  18 | This tutorial will show you how to create a simple theme in Hugo. I assume that you are familiar with HTML, the bash command line, and that you are comfortable using Markdown to format content. I'll explain how Hugo uses templates and how you can organize your templates to create a theme. I won't cover using CSS to style your theme.
  19 | 
  20 | We'll start with creating a new site with a very basic template. Then we'll add in a few pages and posts. With small variations on that, you will be able to create many different types of web sites.
  21 | 
  22 | In this tutorial, commands that you enter will start with the "$" prompt. The output will follow. Lines that start with "#" are comments that I've added to explain a point. When I show updates to a file, the ":wq" on the last line means to save the file.
  23 | 
  24 | Here's an example:
  25 | 
  26 | ```
  27 | ## this is a comment
  28 | $ echo this is a command
  29 | this is a command
  30 | 
  31 | ## edit the file
  32 | $ vi foo.md
  33 | +++
  34 | date = "2014-09-28"
  35 | title = "creating a new theme"
  36 | +++
  37 | 
  38 | bah and humbug
  39 | :wq
  40 | 
  41 | ## show it
  42 | $ cat foo.md
  43 | +++
  44 | date = "2014-09-28"
  45 | title = "creating a new theme"
  46 | +++
  47 | 
  48 | bah and humbug
  49 | $
  50 | ```
  51 | 
  52 | 
  53 | ## Some Definitions
  54 | 
  55 | There are a few concepts that you need to understand before creating a theme.
  56 | 
  57 | ### Skins
  58 | 
  59 | Skins are the files responsible for the look and feel of your site. It’s the CSS that controls colors and fonts, it’s the Javascript that determines actions and reactions. It’s also the rules that Hugo uses to transform your content into the HTML that the site will serve to visitors.
  60 | 
  61 | You have two ways to create a skin. The simplest way is to create it in the ```layouts/``` directory. If you do, then you don’t have to worry about configuring Hugo to recognize it. The first place that Hugo will look for rules and files is in the ```layouts/``` directory so it will always find the skin.
  62 | 
  63 | Your second choice is to create it in a sub-directory of the ```themes/``` directory. If you do, then you must always tell Hugo where to search for the skin. It’s extra work, though, so why bother with it?
  64 | 
  65 | The difference between creating a skin in ```layouts/``` and creating it in ```themes/``` is very subtle. A skin in ```layouts/``` can’t be customized without updating the templates and static files that it is built from. A skin created in ```themes/```, on the other hand, can be and that makes it easier for other people to use it.
  66 | 
  67 | The rest of this tutorial will call a skin created in the ```themes/``` directory a theme.
  68 | 
  69 | Note that you can use this tutorial to create a skin in the ```layouts/``` directory if you wish to. The main difference will be that you won’t need to update the site’s configuration file to use a theme.
  70 | 
  71 | ### The Home Page
  72 | 
  73 | The home page, or landing page, is the first page that many visitors to a site see. It is the index.html file in the root directory of the web site. Since Hugo writes files to the public/ directory, our home page is public/index.html.
  74 | 
  75 | ### Site Configuration File
  76 | 
  77 | When Hugo runs, it looks for a configuration file that contains settings that override default values for the entire site. The file can use TOML, YAML, or JSON. I prefer to use TOML for my configuration files. If you prefer to use JSON or YAML, you’ll need to translate my examples. You’ll also need to change the name of the file since Hugo uses the extension to determine how to process it.
  78 | 
  79 | Hugo translates Markdown files into HTML. By default, Hugo expects to find Markdown files in your ```content/``` directory and template files in your ```themes/``` directory. It will create HTML files in your ```public/``` directory. You can change this by specifying alternate locations in the configuration file.
  80 | 
  81 | ### Content
  82 | 
  83 | Content is stored in text files that contain two sections. The first section is the “front matter,” which is the meta-information on the content. The second section contains Markdown that will be converted to HTML.
  84 | 
  85 | #### Front Matter
  86 | 
  87 | The front matter is information about the content. Like the configuration file, it can be written in TOML, YAML, or JSON. Unlike the configuration file, Hugo doesn’t use the file’s extension to know the format. It looks for markers to signal the type. TOML is surrounded by “`+++`”, YAML by “`---`”, and JSON is enclosed in curly braces. I prefer to use TOML, so you’ll need to translate my examples if you prefer YAML or JSON.
  88 | 
  89 | The information in the front matter is passed into the template before the content is rendered into HTML.
  90 | 
  91 | #### Markdown
  92 | 
  93 | Content is written in Markdown which makes it easier to create the content. Hugo runs the content through a Markdown engine to create the HTML which will be written to the output file.
  94 | 
  95 | ### Template Files
  96 | 
  97 | Hugo uses template files to render content into HTML. Template files are a bridge between the content and presentation. Rules in the template define what content is published, where it's published to, and how it will rendered to the HTML file. The template guides the presentation by specifying the style to use.
  98 | 
  99 | There are three types of templates: single, list, and partial. Each type takes a bit of content as input and transforms it based on the commands in the template.
 100 | 
 101 | Hugo uses its knowledge of the content to find the template file used to render the content. If it can’t find a template that is an exact match for the content, it will shift up a level and search from there. It will continue to do so until it finds a matching template or runs out of templates to try. If it can’t find a template, it will use the default template for the site.
 102 | 
 103 | Please note that you can use the front matter to influence Hugo’s choice of templates.
 104 | 
 105 | #### Single Template
 106 | 
 107 | A single template is used to render a single piece of content. For example, an article or post would be a single piece of content and use a single template.
 108 | 
 109 | #### List Template
 110 | 
 111 | A list template renders a group of related content. That could be a summary of recent postings or all articles in a category. List templates can contain multiple groups.
 112 | 
 113 | The homepage template is a special type of list template. Hugo assumes that the home page of your site will act as the portal for the rest of the content in the site.
 114 | 
 115 | #### Partial Template
 116 | 
 117 | A partial template is a template that can be included in other templates. Partial templates must be called using the “partial” template command. They are very handy for rolling up common behavior. For example, your site may have a banner that all pages use. Instead of copying the text of the banner into every single and list template, you could create a partial with the banner in it. That way if you decide to change the banner, you only have to change the partial template.
 118 | 
 119 | ## Create a New Site
 120 | 
 121 | Let's use Hugo to create a new web site. I'm a Mac user, so I'll create mine in my home directory, in the Sites folder. If you're using Linux, you might have to create the folder first.
 122 | 
 123 | The "new site" command will create a skeleton of a site. It will give you the basic directory structure and a useable configuration file.
 124 | 
 125 | ```
 126 | $ hugo new site ~/Sites/zafta
 127 | $ cd ~/Sites/zafta
 128 | $ ls -l
 129 | total 8
 130 | drwxr-xr-x  7 quoha  staff  238 Sep 29 16:49 .
 131 | drwxr-xr-x  3 quoha  staff  102 Sep 29 16:49 ..
 132 | drwxr-xr-x  2 quoha  staff   68 Sep 29 16:49 archetypes
 133 | -rw-r--r--  1 quoha  staff   82 Sep 29 16:49 config.toml
 134 | drwxr-xr-x  2 quoha  staff   68 Sep 29 16:49 content
 135 | drwxr-xr-x  2 quoha  staff   68 Sep 29 16:49 layouts
 136 | drwxr-xr-x  2 quoha  staff   68 Sep 29 16:49 static
 137 | $
 138 | ```
 139 | 
 140 | Take a look in the content/ directory to confirm that it is empty.
 141 | 
 142 | The other directories (archetypes/, layouts/, and static/) are used when customizing a theme. That's a topic for a different tutorial, so please ignore them for now.
 143 | 
 144 | ### Generate the HTML For the New Site
 145 | 
 146 | Running the `hugo` command with no options will read all the available content and generate the HTML files. It will also copy all static files (that's everything that's not content). Since we have an empty site, it won't do much, but it will do it very quickly.
 147 | 
 148 | ```
 149 | $ hugo --verbose
 150 | INFO: 2014/09/29 Using config file: config.toml
 151 | INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/
 152 | WARN: 2014/09/29 Unable to locate layout: [index.html _default/list.html _default/single.html]
 153 | WARN: 2014/09/29 Unable to locate layout: [404.html]
 154 | 0 draft content 
 155 | 0 future content 
 156 | 0 pages created 
 157 | 0 tags created
 158 | 0 categories created
 159 | in 2 ms
 160 | $ 
 161 | ```
 162 | 
 163 | The "`--verbose`" flag gives extra information that will be helpful when we build the template. Every line of the output that starts with "INFO:" or "WARN:" is present because we used that flag. The lines that start with "WARN:" are warning messages. We'll go over them later.
 164 | 
 165 | We can verify that the command worked by looking at the directory again.
 166 | 
 167 | ```
 168 | $ ls -l
 169 | total 8
 170 | drwxr-xr-x  2 quoha  staff   68 Sep 29 16:49 archetypes
 171 | -rw-r--r--  1 quoha  staff   82 Sep 29 16:49 config.toml
 172 | drwxr-xr-x  2 quoha  staff   68 Sep 29 16:49 content
 173 | drwxr-xr-x  2 quoha  staff   68 Sep 29 16:49 layouts
 174 | drwxr-xr-x  4 quoha  staff  136 Sep 29 17:02 public
 175 | drwxr-xr-x  2 quoha  staff   68 Sep 29 16:49 static
 176 | $
 177 | ```
 178 | 
 179 | See that new public/ directory? Hugo placed all generated content there. When you're ready to publish your web site, that's the place to start. For now, though, let's just confirm that we have what we'd expect from a site with no content.
 180 | 
 181 | ```
 182 | $ ls -l public
 183 | total 16
 184 | -rw-r--r--  1 quoha  staff  416 Sep 29 17:02 index.xml
 185 | -rw-r--r--  1 quoha  staff  262 Sep 29 17:02 sitemap.xml
 186 | $ 
 187 | ```
 188 | 
 189 | Hugo created two XML files, which is standard, but there are no HTML files.
 190 | 
 191 | 
 192 | 
 193 | ### Test the New Site
 194 | 
 195 | Verify that you can run the built-in web server. It will dramatically shorten your development cycle if you do. Start it by running the "server" command. If it is successful, you will see output similar to the following:
 196 | 
 197 | ```
 198 | $ hugo server --verbose
 199 | INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml
 200 | INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/
 201 | WARN: 2014/09/29 Unable to locate layout: [index.html _default/list.html _default/single.html]
 202 | WARN: 2014/09/29 Unable to locate layout: [404.html]
 203 | 0 draft content 
 204 | 0 future content 
 205 | 0 pages created 
 206 | 0 tags created
 207 | 0 categories created
 208 | in 2 ms
 209 | Serving pages from /Users/quoha/Sites/zafta/public
 210 | Web Server is available at http://localhost:1313
 211 | Press Ctrl+C to stop
 212 | ```
 213 | 
 214 | Connect to the listed URL (it's on the line that starts with "Web Server"). If everything is working correctly, you should get a page that shows the following:
 215 | 
 216 | ```
 217 | index.xml
 218 | sitemap.xml
 219 | ```
 220 | 
 221 | That's a listing of your public/ directory. Hugo didn't create a home page because our site has no content. When there's no index.html file in a directory, the server lists the files in the directory, which is what you should see in your browser.
 222 | 
 223 | Let’s go back and look at those warnings again.
 224 | 
 225 | ```
 226 | WARN: 2014/09/29 Unable to locate layout: [index.html _default/list.html _default/single.html]
 227 | WARN: 2014/09/29 Unable to locate layout: [404.html]
 228 | ```
 229 | 
 230 | That second warning is easier to explain. We haven’t created a template to be used to generate “page not found errors.” The 404 message is a topic for a separate tutorial.
 231 | 
 232 | Now for the first warning. It is for the home page. You can tell because the first layout that it looked for was “index.html.” That’s only used by the home page.
 233 | 
 234 | I like that the verbose flag causes Hugo to list the files that it's searching for. For the home page, they are index.html, _default/list.html, and _default/single.html. There are some rules that we'll cover later that explain the names and paths. For now, just remember that Hugo couldn't find a template for the home page and it told you so.
 235 | 
 236 | At this point, you've got a working installation and site that we can build upon. All that’s left is to add some content and a theme to display it.
 237 | 
 238 | ## Create a New Theme
 239 | 
 240 | Hugo doesn't ship with a default theme. There are a few available (I counted a dozen when I first installed Hugo) and Hugo comes with a command to create new themes.
 241 | 
 242 | We're going to create a new theme called "zafta." Since the goal of this tutorial is to show you how to fill out the files to pull in your content, the theme will not contain any CSS. In other words, ugly but functional.
 243 | 
 244 | All themes have opinions on content and layout. For example, Zafta uses "post" over "blog". Strong opinions make for simpler templates but differing opinions make it tougher to use themes. When you build a theme, consider using the terms that other themes do.
 245 | 
 246 | 
 247 | ### Create a Skeleton
 248 | 
 249 | Use the hugo "new" command to create the skeleton of a theme. This creates the directory structure and places empty files for you to fill out.
 250 | 
 251 | ```
 252 | $ hugo new theme zafta
 253 | 
 254 | $ ls -l
 255 | total 8
 256 | drwxr-xr-x  2 quoha  staff   68 Sep 29 16:49 archetypes
 257 | -rw-r--r--  1 quoha  staff   82 Sep 29 16:49 config.toml
 258 | drwxr-xr-x  2 quoha  staff   68 Sep 29 16:49 content
 259 | drwxr-xr-x  2 quoha  staff   68 Sep 29 16:49 layouts
 260 | drwxr-xr-x  4 quoha  staff  136 Sep 29 17:02 public
 261 | drwxr-xr-x  2 quoha  staff   68 Sep 29 16:49 static
 262 | drwxr-xr-x  3 quoha  staff  102 Sep 29 17:31 themes
 263 | 
 264 | $ find themes -type f | xargs ls -l
 265 | -rw-r--r--  1 quoha  staff  1081 Sep 29 17:31 themes/zafta/LICENSE.md
 266 | -rw-r--r--  1 quoha  staff     0 Sep 29 17:31 themes/zafta/archetypes/default.md
 267 | -rw-r--r--  1 quoha  staff     0 Sep 29 17:31 themes/zafta/layouts/_default/list.html
 268 | -rw-r--r--  1 quoha  staff     0 Sep 29 17:31 themes/zafta/layouts/_default/single.html
 269 | -rw-r--r--  1 quoha  staff     0 Sep 29 17:31 themes/zafta/layouts/index.html
 270 | -rw-r--r--  1 quoha  staff     0 Sep 29 17:31 themes/zafta/layouts/partials/footer.html
 271 | -rw-r--r--  1 quoha  staff     0 Sep 29 17:31 themes/zafta/layouts/partials/header.html
 272 | -rw-r--r--  1 quoha  staff    93 Sep 29 17:31 themes/zafta/theme.toml
 273 | $ 
 274 | ```
 275 | 
 276 | The skeleton includes templates (the files ending in .html), license file, a description of your theme (the theme.toml file), and an empty archetype.
 277 | 
 278 | Please take a minute to fill out the theme.toml and LICENSE.md files. They're optional, but if you're going to be distributing your theme, it tells the world who to praise (or blame). It's also nice to declare the license so that people will know how they can use the theme.
 279 | 
 280 | ```
 281 | $ vi themes/zafta/theme.toml
 282 | author = "michael d henderson"
 283 | description = "a minimal working template"
 284 | license = "MIT"
 285 | name = "zafta"
 286 | source_repo = ""
 287 | tags = ["tags", "categories"]
 288 | :wq
 289 | 
 290 | ## also edit themes/zafta/LICENSE.md and change
 291 | ## the bit that says "YOUR_NAME_HERE"
 292 | ```
 293 | 
 294 | Note that the the skeleton's template files are empty. Don't worry, we'll be changing that shortly.
 295 | 
 296 | ```
 297 | $ find themes/zafta -name '*.html' | xargs ls -l
 298 | -rw-r--r--  1 quoha  staff  0 Sep 29 17:31 themes/zafta/layouts/_default/list.html
 299 | -rw-r--r--  1 quoha  staff  0 Sep 29 17:31 themes/zafta/layouts/_default/single.html
 300 | -rw-r--r--  1 quoha  staff  0 Sep 29 17:31 themes/zafta/layouts/index.html
 301 | -rw-r--r--  1 quoha  staff  0 Sep 29 17:31 themes/zafta/layouts/partials/footer.html
 302 | -rw-r--r--  1 quoha  staff  0 Sep 29 17:31 themes/zafta/layouts/partials/header.html
 303 | $
 304 | ```
 305 | 
 306 | 
 307 | 
 308 | ### Update the Configuration File to Use the Theme
 309 | 
 310 | Now that we've got a theme to work with, it's a good idea to add the theme name to the configuration file. This is optional, because you can always add "-t zafta" on all your commands. I like to put it the configuration file because I like shorter command lines. If you don't put it in the configuration file or specify it on the command line, you won't use the template that you're expecting to.
 311 | 
 312 | Edit the file to add the theme, add a title for the site, and specify that all of our content will use the TOML format.
 313 | 
 314 | ```
 315 | $ vi config.toml
 316 | theme = "zafta"
 317 | baseurl = ""
 318 | languageCode = "en-us"
 319 | title = "zafta - totally refreshing"
 320 | MetaDataFormat = "toml"
 321 | :wq
 322 | 
 323 | $
 324 | ```
 325 | 
 326 | ### Generate the Site
 327 | 
 328 | Now that we have an empty theme, let's generate the site again.
 329 | 
 330 | ```
 331 | $ hugo --verbose
 332 | INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml
 333 | INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/themes/zafta/static/ to /Users/quoha/Sites/zafta/public/
 334 | INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/
 335 | WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html]
 336 | 0 draft content 
 337 | 0 future content 
 338 | 0 pages created 
 339 | 0 tags created
 340 | 0 categories created
 341 | in 2 ms
 342 | $
 343 | ```
 344 | 
 345 | Did you notice that the output is different? The warning message for the home page has disappeared and we have an additional information line saying that Hugo is syncing from the theme's directory.
 346 | 
 347 | Let's check the public/ directory to see what Hugo's created.
 348 | 
 349 | ```
 350 | $ ls -l public
 351 | total 16
 352 | drwxr-xr-x  2 quoha  staff   68 Sep 29 17:56 css
 353 | -rw-r--r--  1 quoha  staff    0 Sep 29 17:56 index.html
 354 | -rw-r--r--  1 quoha  staff  407 Sep 29 17:56 index.xml
 355 | drwxr-xr-x  2 quoha  staff   68 Sep 29 17:56 js
 356 | -rw-r--r--  1 quoha  staff  243 Sep 29 17:56 sitemap.xml
 357 | $
 358 | ```
 359 | 
 360 | Notice four things:
 361 | 
 362 | 1. Hugo created a home page. This is the file public/index.html.
 363 | 2. Hugo created a css/ directory.
 364 | 3. Hugo created a js/ directory.
 365 | 4. Hugo claimed that it created 0 pages. It created a file and copied over static files, but didn't create any pages. That's because it considers a "page" to be a file created directly from a content file. It doesn't count things like the index.html files that it creates automatically.
 366 | 
 367 | #### The Home Page
 368 | 
 369 | Hugo supports many different types of templates. The home page is special because it gets its own type of template and its own template file. The file, layouts/index.html, is used to generate the HTML for the home page. The Hugo documentation says that this is the only required template, but that depends. Hugo's warning message shows that it looks for three different templates:
 370 | 
 371 | ```
 372 | WARN: 2014/09/29 Unable to locate layout: [index.html _default/list.html _default/single.html]
 373 | ```
 374 | 
 375 | If it can't find any of these, it completely skips creating the home page. We noticed that when we built the site without having a theme installed.
 376 | 
 377 | When Hugo created our theme, it created an empty home page template. Now, when we build the site, Hugo finds the template and uses it to generate the HTML for the home page. Since the template file is empty, the HTML file is empty, too. If the template had any rules in it, then Hugo would have used them to generate the home page.
 378 | 
 379 | ```
 380 | $ find . -name index.html | xargs ls -l
 381 | -rw-r--r--  1 quoha  staff  0 Sep 29 20:21 ./public/index.html
 382 | -rw-r--r--  1 quoha  staff  0 Sep 29 17:31 ./themes/zafta/layouts/index.html
 383 | $ 
 384 | ```
 385 | 
 386 | #### The Magic of Static
 387 | 
 388 | Hugo does two things when generating the site. It uses templates to transform content into HTML and it copies static files into the site. Unlike content, static files are not transformed. They are copied exactly as they are.
 389 | 
 390 | Hugo assumes that your site will use both CSS and JavaScript, so it creates directories in your theme to hold them. Remember opinions? Well, Hugo's opinion is that you'll store your CSS in a directory named css/ and your JavaScript in a directory named js/. If you don't like that, you can change the directory names in your theme directory or even delete them completely. Hugo's nice enough to offer its opinion, then behave nicely if you disagree.
 391 | 
 392 | ```
 393 | $ find themes/zafta -type d | xargs ls -ld
 394 | drwxr-xr-x  7 quoha  staff  238 Sep 29 17:38 themes/zafta
 395 | drwxr-xr-x  3 quoha  staff  102 Sep 29 17:31 themes/zafta/archetypes
 396 | drwxr-xr-x  5 quoha  staff  170 Sep 29 17:31 themes/zafta/layouts
 397 | drwxr-xr-x  4 quoha  staff  136 Sep 29 17:31 themes/zafta/layouts/_default
 398 | drwxr-xr-x  4 quoha  staff  136 Sep 29 17:31 themes/zafta/layouts/partials
 399 | drwxr-xr-x  4 quoha  staff  136 Sep 29 17:31 themes/zafta/static
 400 | drwxr-xr-x  2 quoha  staff   68 Sep 29 17:31 themes/zafta/static/css
 401 | drwxr-xr-x  2 quoha  staff   68 Sep 29 17:31 themes/zafta/static/js
 402 | $ 
 403 | ```
 404 | 
 405 | ## The Theme Development Cycle
 406 | 
 407 | When you're working on a theme, you will make changes in the theme's directory, rebuild the site, and check your changes in the browser. Hugo makes this very easy:
 408 | 
 409 | 1. Purge the public/ directory.
 410 | 2. Run the built in web server in watch mode.
 411 | 3. Open your site in a browser.
 412 | 4. Update the theme.
 413 | 5. Glance at your browser window to see changes.
 414 | 6. Return to step 4.
 415 | 
 416 | I’ll throw in one more opinion: never work on a theme on a live site. Always work on a copy of your site. Make changes to your theme, test them, then copy them up to your site. For added safety, use a tool like Git to keep a revision history of your content and your theme. Believe me when I say that it is too easy to lose both your mind and your changes.
 417 | 
 418 | Check the main Hugo site for information on using Git with Hugo.
 419 | 
 420 | ### Purge the public/ Directory
 421 | 
 422 | When generating the site, Hugo will create new files and update existing ones in the ```public/``` directory. It will not delete files that are no longer used. For example, files that were created in the wrong directory or with the wrong title will remain. If you leave them, you might get confused by them later. I recommend cleaning out your site prior to generating it.
 423 | 
 424 | Note: If you're building on an SSD, you should ignore this. Churning on a SSD can be costly.
 425 | 
 426 | ### Hugo's Watch Option
 427 | 
 428 | Hugo's "`--watch`" option will monitor the content/ and your theme directories for changes and rebuild the site automatically.
 429 | 
 430 | ### Live Reload
 431 | 
 432 | Hugo's built in web server supports live reload. As pages are saved on the server, the browser is told to refresh the page. Usually, this happens faster than you can say, "Wow, that's totally amazing."
 433 | 
 434 | ### Development Commands
 435 | 
 436 | Use the following commands as the basis for your workflow.
 437 | 
 438 | ```
 439 | ## purge old files. hugo will recreate the public directory.
 440 | ##
 441 | $ rm -rf public
 442 | ##
 443 | ## run hugo in watch mode
 444 | ##
 445 | $ hugo server --watch --verbose
 446 | ```
 447 | 
 448 | Here's sample output showing Hugo detecting a change to the template for the home page. Once generated, the web browser automatically reloaded the page. I've said this before, it's amazing.
 449 | 
 450 | 
 451 | ```
 452 | $ rm -rf public
 453 | $ hugo server --watch --verbose
 454 | INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml
 455 | INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/themes/zafta/static/ to /Users/quoha/Sites/zafta/public/
 456 | INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/
 457 | WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html]
 458 | 0 draft content 
 459 | 0 future content 
 460 | 0 pages created 
 461 | 0 tags created
 462 | 0 categories created
 463 | in 2 ms
 464 | Watching for changes in /Users/quoha/Sites/zafta/content
 465 | Serving pages from /Users/quoha/Sites/zafta/public
 466 | Web Server is available at http://localhost:1313
 467 | Press Ctrl+C to stop
 468 | INFO: 2014/09/29 File System Event: ["/Users/quoha/Sites/zafta/themes/zafta/layouts/index.html": MODIFY|ATTRIB]
 469 | Change detected, rebuilding site
 470 | 
 471 | WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html]
 472 | 0 draft content 
 473 | 0 future content 
 474 | 0 pages created 
 475 | 0 tags created
 476 | 0 categories created
 477 | in 1 ms
 478 | ```
 479 | 
 480 | ## Update the Home Page Template
 481 | 
 482 | The home page is one of a few special pages that Hugo creates automatically. As mentioned earlier, it looks for one of three files in the theme's layout/ directory:
 483 | 
 484 | 1. index.html
 485 | 2. _default/list.html
 486 | 3. _default/single.html
 487 | 
 488 | We could update one of the default templates, but a good design decision is to update the most specific template available. That's not a hard and fast rule (in fact, we'll break it a few times in this tutorial), but it is a good generalization.
 489 | 
 490 | ### Make a Static Home Page
 491 | 
 492 | Right now, that page is empty because we don't have any content and we don't have any logic in the template. Let's change that by adding some text to the template.
 493 | 
 494 | ```
 495 | $ vi themes/zafta/layouts/index.html
 496 | <!DOCTYPE html> 
 497 | <html> 
 498 | <body> 
 499 |   <p>hugo says hello!</p> 
 500 | </body> 
 501 | </html> 
 502 | :wq
 503 | 
 504 | $
 505 | ```
 506 | 
 507 | Build the web site and then verify the results.
 508 | 
 509 | ```
 510 | $ hugo --verbose
 511 | INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml
 512 | INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/themes/zafta/static/ to /Users/quoha/Sites/zafta/public/
 513 | INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/
 514 | WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html]
 515 | 0 draft content 
 516 | 0 future content 
 517 | 0 pages created 
 518 | 0 tags created
 519 | 0 categories created
 520 | in 2 ms
 521 | 
 522 | $ find public -type f -name '*.html' | xargs ls -l
 523 | -rw-r--r--  1 quoha  staff  78 Sep 29 21:26 public/index.html
 524 | 
 525 | $ cat public/index.html 
 526 | <!DOCTYPE html> 
 527 | <html> 
 528 | <body> 
 529 |   <p>hugo says hello!</p> 
 530 | </html>
 531 | ```
 532 | 
 533 | #### Live Reload
 534 | 
 535 | Note: If you're running the server with the `--watch` option, you'll see different content in the file:
 536 | 
 537 | ```
 538 | $ cat public/index.html 
 539 | <!DOCTYPE html> 
 540 | <html> 
 541 | <body> 
 542 |   <p>hugo says hello!</p> 
 543 | <script>document.write('<script src="http://' 
 544 |         + (location.host || 'localhost').split(':')[0] 
 545 |     + ':1313/livereload.js?mindelay=10"></' 
 546 |         + 'script>')</script></body> 
 547 | </html>
 548 | ```
 549 | 
 550 | When you use `--watch`, the Live Reload script is added by Hugo. Look for live reload in the documentation to see what it does and how to disable it.
 551 | 
 552 | ### Build a "Dynamic" Home Page
 553 | 
 554 | "Dynamic home page?" Hugo's a static web site generator, so this seems an odd thing to say. I mean let's have the home page automatically reflect the content in the site every time Hugo builds it. We'll use iteration in the template to do that.
 555 | 
 556 | #### Create New Posts
 557 | 
 558 | Now that we have the home page generating static content, let's add some content to the site. We'll display these posts as a list on the home page and on their own page, too.
 559 | 
 560 | Hugo has a command to generate a skeleton post, just like it does for sites and themes.
 561 | 
 562 | ```
 563 | $ hugo --verbose new post/first.md
 564 | INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml
 565 | INFO: 2014/09/29 attempting to create  post/first.md of post
 566 | INFO: 2014/09/29 curpath: /Users/quoha/Sites/zafta/themes/zafta/archetypes/default.md
 567 | ERROR: 2014/09/29 Unable to Cast <nil> to map[string]interface{}
 568 | 
 569 | $ 
 570 | ```
 571 | 
 572 | That wasn't very nice, was it?
 573 | 
 574 | The "new" command uses an archetype to create the post file. Hugo created an empty default archetype file, but that causes an error when there's a theme. For me, the workaround was to create an archetypes file specifically for the post type.
 575 | 
 576 | ```
 577 | $ vi themes/zafta/archetypes/post.md
 578 | +++
 579 | Description = ""
 580 | Tags = []
 581 | Categories = []
 582 | +++
 583 | :wq
 584 | 
 585 | $ find themes/zafta/archetypes -type f | xargs ls -l
 586 | -rw-r--r--  1 quoha  staff   0 Sep 29 21:53 themes/zafta/archetypes/default.md
 587 | -rw-r--r--  1 quoha  staff  51 Sep 29 21:54 themes/zafta/archetypes/post.md
 588 | 
 589 | $ hugo --verbose new post/first.md
 590 | INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml
 591 | INFO: 2014/09/29 attempting to create  post/first.md of post
 592 | INFO: 2014/09/29 curpath: /Users/quoha/Sites/zafta/themes/zafta/archetypes/post.md
 593 | INFO: 2014/09/29 creating /Users/quoha/Sites/zafta/content/post/first.md
 594 | /Users/quoha/Sites/zafta/content/post/first.md created
 595 | 
 596 | $ hugo --verbose new post/second.md
 597 | INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml
 598 | INFO: 2014/09/29 attempting to create  post/second.md of post
 599 | INFO: 2014/09/29 curpath: /Users/quoha/Sites/zafta/themes/zafta/archetypes/post.md
 600 | INFO: 2014/09/29 creating /Users/quoha/Sites/zafta/content/post/second.md
 601 | /Users/quoha/Sites/zafta/content/post/second.md created
 602 | 
 603 | $ ls -l content/post
 604 | total 16
 605 | -rw-r--r--  1 quoha  staff  104 Sep 29 21:54 first.md
 606 | -rw-r--r--  1 quoha  staff  105 Sep 29 21:57 second.md
 607 | 
 608 | $ cat content/post/first.md 
 609 | +++
 610 | Categories = []
 611 | Description = ""
 612 | Tags = []
 613 | date = "2014-09-29T21:54:53-05:00"
 614 | title = "first"
 615 | 
 616 | +++
 617 | my first post
 618 | 
 619 | $ cat content/post/second.md 
 620 | +++
 621 | Categories = []
 622 | Description = ""
 623 | Tags = []
 624 | date = "2014-09-29T21:57:09-05:00"
 625 | title = "second"
 626 | 
 627 | +++
 628 | my second post
 629 | 
 630 | $ 
 631 | ```
 632 | 
 633 | Build the web site and then verify the results.
 634 | 
 635 | ```
 636 | $ rm -rf public
 637 | $ hugo --verbose
 638 | INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml
 639 | INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/themes/zafta/static/ to /Users/quoha/Sites/zafta/public/
 640 | INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/
 641 | INFO: 2014/09/29 found taxonomies: map[string]string{"category":"categories", "tag":"tags"}
 642 | WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html]
 643 | 0 draft content 
 644 | 0 future content 
 645 | 2 pages created 
 646 | 0 tags created
 647 | 0 categories created
 648 | in 4 ms
 649 | $
 650 | ```
 651 | 
 652 | The output says that it created 2 pages. Those are our new posts:
 653 | 
 654 | ```
 655 | $ find public -type f -name '*.html' | xargs ls -l
 656 | -rw-r--r--  1 quoha  staff  78 Sep 29 22:13 public/index.html
 657 | -rw-r--r--  1 quoha  staff   0 Sep 29 22:13 public/post/first/index.html
 658 | -rw-r--r--  1 quoha  staff   0 Sep 29 22:13 public/post/index.html
 659 | -rw-r--r--  1 quoha  staff   0 Sep 29 22:13 public/post/second/index.html
 660 | $
 661 | ```
 662 | 
 663 | The new files are empty because because the templates used to generate the content are empty. The homepage doesn't show the new content, either. We have to update the templates to add the posts.
 664 | 
 665 | ### List and Single Templates
 666 | 
 667 | In Hugo, we have three major kinds of templates. There's the home page template that we updated previously. It is used only by the home page. We also have "single" templates which are used to generate output for a single content file. We also have "list" templates that are used to group multiple pieces of content before generating output.
 668 | 
 669 | Generally speaking, list templates are named "list.html" and single templates are named "single.html."
 670 | 
 671 | There are three other types of templates: partials, content views, and terms. We will not go into much detail on these.
 672 | 
 673 | ### Add Content to the Homepage
 674 | 
 675 | The home page will contain a list of posts. Let's update its template to add the posts that we just created. The logic in the template will run every time we build the site.
 676 | 
 677 | ```
 678 | $ vi themes/zafta/layouts/index.html 
 679 | <!DOCTYPE html>
 680 | <html>
 681 | <body>
 682 |   {{ range first 10 .Data.Pages }}
 683 |     <h1>{{ .Title }}</h1>
 684 |   {{ end }}
 685 | </body>
 686 | </html>
 687 | :wq
 688 | 
 689 | $
 690 | ```
 691 | 
 692 | Hugo uses the Go template engine. That engine scans the template files for commands which are enclosed between "{{" and "}}". In our template, the commands are:
 693 | 
 694 | 1. range
 695 | 2. .Title
 696 | 3. end
 697 | 
 698 | The "range" command is an iterator. We're going to use it to go through the first ten pages. Every HTML file that Hugo creates is treated as a page, so looping through the list of pages will look at every file that will be created.
 699 | 
 700 | The ".Title" command prints the value of the "title" variable. Hugo pulls it from the front matter in the Markdown file.
 701 | 
 702 | The "end" command signals the end of the range iterator. The engine loops back to the top of the iteration when it finds "end." Everything between the "range" and "end" is evaluated every time the engine goes through the iteration. In this file, that would cause the title from the first ten pages to be output as heading level one.
 703 | 
 704 | It's helpful to remember that some variables, like .Data, are created before any output files. Hugo loads every content file into the variable and then gives the template a chance to process before creating the HTML files.
 705 | 
 706 | Build the web site and then verify the results.
 707 | 
 708 | ```
 709 | $ rm -rf public
 710 | $ hugo --verbose
 711 | INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml
 712 | INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/themes/zafta/static/ to /Users/quoha/Sites/zafta/public/
 713 | INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/
 714 | INFO: 2014/09/29 found taxonomies: map[string]string{"tag":"tags", "category":"categories"}
 715 | WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html]
 716 | 0 draft content 
 717 | 0 future content 
 718 | 2 pages created 
 719 | 0 tags created
 720 | 0 categories created
 721 | in 4 ms
 722 | $ find public -type f -name '*.html' | xargs ls -l 
 723 | -rw-r--r--  1 quoha  staff  94 Sep 29 22:23 public/index.html
 724 | -rw-r--r--  1 quoha  staff   0 Sep 29 22:23 public/post/first/index.html
 725 | -rw-r--r--  1 quoha  staff   0 Sep 29 22:23 public/post/index.html
 726 | -rw-r--r--  1 quoha  staff   0 Sep 29 22:23 public/post/second/index.html
 727 | $ cat public/index.html 
 728 | <!DOCTYPE html>
 729 | <html>
 730 | <body>
 731 |   
 732 |     <h1>second</h1>
 733 |   
 734 |     <h1>first</h1>
 735 |   
 736 | </body>
 737 | </html>
 738 | $
 739 | ```
 740 | 
 741 | Congratulations, the home page shows the title of the two posts. The posts themselves are still empty, but let's take a moment to appreciate what we've done. Your template now generates output dynamically. Believe it or not, by inserting the range command inside of those curly braces, you've learned everything you need to know to build a theme. All that's really left is understanding which template will be used to generate each content file and becoming familiar with the commands for the template engine.
 742 | 
 743 | And, if that were entirely true, this tutorial would be much shorter. There are a few things to know that will make creating a new template much easier. Don't worry, though, that's all to come.
 744 | 
 745 | ### Add Content to the Posts
 746 | 
 747 | We're working with posts, which are in the content/post/ directory. That means that their section is "post" (and if we don't do something weird, their type is also "post").
 748 | 
 749 | Hugo uses the section and type to find the template file for every piece of content. Hugo will first look for a template file that matches the section or type name. If it can't find one, then it will look in the _default/ directory. There are some twists that we'll cover when we get to categories and tags, but for now we can assume that Hugo will try post/single.html, then _default/single.html.
 750 | 
 751 | Now that we know the search rule, let's see what we actually have available:
 752 | 
 753 | ```
 754 | $ find themes/zafta -name single.html | xargs ls -l
 755 | -rw-r--r--  1 quoha  staff  132 Sep 29 17:31 themes/zafta/layouts/_default/single.html
 756 | ```
 757 | 
 758 | We could create a new template, post/single.html, or change the default. Since we don't know of any other content types, let's start with updating the default.
 759 | 
 760 | Remember, any content that we haven't created a template for will end up using this template. That can be good or bad. Bad because I know that we're going to be adding different types of content and we're going to end up undoing some of the changes we've made. It's good because we'll be able to see immediate results. It's also good to start here because we can start to build the basic layout for the site. As we add more content types, we'll refactor this file and move logic around. Hugo makes that fairly painless, so we'll accept the cost and proceed.
 761 | 
 762 | Please see the Hugo documentation on template rendering for all the details on determining which template to use. And, as the docs mention, if you're building a single page application (SPA) web site, you can delete all of the other templates and work with just the default single page. That's a refreshing amount of joy right there.
 763 | 
 764 | #### Update the Template File
 765 | 
 766 | ```
 767 | $ vi themes/zafta/layouts/_default/single.html 
 768 | <!DOCTYPE html>
 769 | <html>
 770 | <head>
 771 |   <title>{{ .Title }}</title>
 772 | </head>
 773 | <body>
 774 |   <h1>{{ .Title }}</h1>
 775 |   {{ .Content }}
 776 | </body>
 777 | </html>
 778 | :wq
 779 | 
 780 | $
 781 | ```
 782 | 
 783 | Build the web site and verify the results.
 784 | 
 785 | ```
 786 | $ rm -rf public
 787 | $ hugo --verbose
 788 | INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml
 789 | INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/themes/zafta/static/ to /Users/quoha/Sites/zafta/public/
 790 | INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/
 791 | INFO: 2014/09/29 found taxonomies: map[string]string{"tag":"tags", "category":"categories"}
 792 | WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html]
 793 | 0 draft content 
 794 | 0 future content 
 795 | 2 pages created 
 796 | 0 tags created
 797 | 0 categories created
 798 | in 4 ms
 799 | 
 800 | $ find public -type f -name '*.html' | xargs ls -l
 801 | -rw-r--r--  1 quoha  staff   94 Sep 29 22:40 public/index.html
 802 | -rw-r--r--  1 quoha  staff  125 Sep 29 22:40 public/post/first/index.html
 803 | -rw-r--r--  1 quoha  staff    0 Sep 29 22:40 public/post/index.html
 804 | -rw-r--r--  1 quoha  staff  128 Sep 29 22:40 public/post/second/index.html
 805 | 
 806 | $ cat public/post/first/index.html 
 807 | <!DOCTYPE html>
 808 | <html>
 809 | <head>
 810 |   <title>first</title>
 811 | </head>
 812 | <body>
 813 |   <h1>first</h1>
 814 |   <p>my first post</p>
 815 | 
 816 | </body>
 817 | </html>
 818 | 
 819 | $ cat public/post/second/index.html 
 820 | <!DOCTYPE html>
 821 | <html>
 822 | <head>
 823 |   <title>second</title>
 824 | </head>
 825 | <body>
 826 |   <h1>second</h1>
 827 |   <p>my second post</p>
 828 | 
 829 | </body>
 830 | </html>
 831 | $
 832 | ```
 833 | 
 834 | Notice that the posts now have content. You can go to localhost:1313/post/first to verify.
 835 | 
 836 | ### Linking to Content
 837 | 
 838 | The posts are on the home page. Let's add a link from there to the post. Since this is the home page, we'll update its template.
 839 | 
 840 | ```
 841 | $ vi themes/zafta/layouts/index.html
 842 | <!DOCTYPE html>
 843 | <html>
 844 | <body>
 845 |   {{ range first 10 .Data.Pages }}
 846 |     <h1><a href="{{ .Permalink }}">{{ .Title }}</a></h1>
 847 |   {{ end }}
 848 | </body>
 849 | </html>
 850 | ```
 851 | 
 852 | Build the web site and verify the results.
 853 | 
 854 | ```
 855 | $ rm -rf public
 856 | $ hugo --verbose
 857 | INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml
 858 | INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/themes/zafta/static/ to /Users/quoha/Sites/zafta/public/
 859 | INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/
 860 | INFO: 2014/09/29 found taxonomies: map[string]string{"tag":"tags", "category":"categories"}
 861 | WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html]
 862 | 0 draft content 
 863 | 0 future content 
 864 | 2 pages created 
 865 | 0 tags created
 866 | 0 categories created
 867 | in 4 ms
 868 | 
 869 | $ find public -type f -name '*.html' | xargs ls -l
 870 | -rw-r--r--  1 quoha  staff  149 Sep 29 22:44 public/index.html
 871 | -rw-r--r--  1 quoha  staff  125 Sep 29 22:44 public/post/first/index.html
 872 | -rw-r--r--  1 quoha  staff    0 Sep 29 22:44 public/post/index.html
 873 | -rw-r--r--  1 quoha  staff  128 Sep 29 22:44 public/post/second/index.html
 874 | 
 875 | $ cat public/index.html 
 876 | <!DOCTYPE html>
 877 | <html>
 878 | <body>
 879 |   
 880 |     <h1><a href="/post/second/">second</a></h1>
 881 |   
 882 |     <h1><a href="/post/first/">first</a></h1>
 883 |   
 884 | </body>
 885 | </html>
 886 | 
 887 | $
 888 | ```
 889 | 
 890 | ### Create a Post Listing
 891 | 
 892 | We have the posts displaying on the home page and on their own page. We also have a file public/post/index.html that is empty. Let's make it show a list of all posts (not just the first ten).
 893 | 
 894 | We need to decide which template to update. This will be a listing, so it should be a list template. Let's take a quick look and see which list templates are available.
 895 | 
 896 | ```
 897 | $ find themes/zafta -name list.html | xargs ls -l
 898 | -rw-r--r--  1 quoha  staff  0 Sep 29 17:31 themes/zafta/layouts/_default/list.html
 899 | ```
 900 | 
 901 | As with the single post, we have to decide to update _default/list.html or create post/list.html. We still don't have multiple content types, so let's stay consistent and update the default list template.
 902 | 
 903 | ## Creating Top Level Pages
 904 | 
 905 | Let's add an "about" page and display it at the top level (as opposed to a sub-level like we did with posts).
 906 | 
 907 | The default in Hugo is to use the directory structure of the content/ directory to guide the location of the generated html in the public/ directory. Let's verify that by creating an "about" page at the top level:
 908 | 
 909 | ```
 910 | $ vi content/about.md 
 911 | +++
 912 | title = "about"
 913 | description = "about this site"
 914 | date = "2014-09-27"
 915 | slug = "about time"
 916 | +++
 917 | 
 918 | ## about us
 919 | 
 920 | i'm speechless
 921 | :wq
 922 | ```
 923 | 
 924 | Generate the web site and verify the results.
 925 | 
 926 | ```
 927 | $ find public -name '*.html' | xargs ls -l
 928 | -rw-rw-r--  1 mdhender  staff   334 Sep 27 15:08 public/about-time/index.html
 929 | -rw-rw-r--  1 mdhender  staff   527 Sep 27 15:08 public/index.html
 930 | -rw-rw-r--  1 mdhender  staff   358 Sep 27 15:08 public/post/first-post/index.html
 931 | -rw-rw-r--  1 mdhender  staff     0 Sep 27 15:08 public/post/index.html
 932 | -rw-rw-r--  1 mdhender  staff   342 Sep 27 15:08 public/post/second-post/index.html
 933 | ```
 934 | 
 935 | Notice that the page wasn't created at the top level. It was created in a sub-directory named 'about-time/'. That name came from our slug. Hugo will use the slug to name the generated content. It's a reasonable default, by the way, but we can learn a few things by fighting it for this file.
 936 | 
 937 | One other thing. Take a look at the home page.
 938 | 
 939 | ```
 940 | $ cat public/index.html
 941 | <!DOCTYPE html>
 942 | <html>
 943 | <body>
 944 |     <h1><a href="http://localhost:1313/post/theme/">creating a new theme</a></h1>
 945 |     <h1><a href="http://localhost:1313/about-time/">about</a></h1>
 946 |     <h1><a href="http://localhost:1313/post/second-post/">second</a></h1>
 947 |     <h1><a href="http://localhost:1313/post/first-post/">first</a></h1>
 948 | <script>document.write('<script src="http://'
 949 |         + (location.host || 'localhost').split(':')[0]
 950 | 		+ ':1313/livereload.js?mindelay=10"></'
 951 |         + 'script>')</script></body>
 952 | </html>
 953 | ```
 954 | 
 955 | Notice that the "about" link is listed with the posts? That's not desirable, so let's change that first.
 956 | 
 957 | ```
 958 | $ vi themes/zafta/layouts/index.html
 959 | <!DOCTYPE html>
 960 | <html>
 961 | <body>
 962 |   <h1>posts</h1>
 963 |   {{ range first 10 .Data.Pages }}
 964 |     {{ if eq .Type "post"}}
 965 |       <h2><a href="{{ .Permalink }}">{{ .Title }}</a></h2>
 966 |     {{ end }}
 967 |   {{ end }}
 968 | 
 969 |   <h1>pages</h1>
 970 |   {{ range .Data.Pages }}
 971 |     {{ if eq .Type "page" }}
 972 |       <h2><a href="{{ .Permalink }}">{{ .Title }}</a></h2>
 973 |     {{ end }}
 974 |   {{ end }}
 975 | </body>
 976 | </html>
 977 | :wq
 978 | ```
 979 | 
 980 | Generate the web site and verify the results. The home page has two sections, posts and pages, and each section has the right set of headings and links in it.
 981 | 
 982 | But, that about page still renders to about-time/index.html.
 983 | 
 984 | ```
 985 | $ find public -name '*.html' | xargs ls -l
 986 | -rw-rw-r--  1 mdhender  staff    334 Sep 27 15:33 public/about-time/index.html
 987 | -rw-rw-r--  1 mdhender  staff    645 Sep 27 15:33 public/index.html
 988 | -rw-rw-r--  1 mdhender  staff    358 Sep 27 15:33 public/post/first-post/index.html
 989 | -rw-rw-r--  1 mdhender  staff      0 Sep 27 15:33 public/post/index.html
 990 | -rw-rw-r--  1 mdhender  staff    342 Sep 27 15:33 public/post/second-post/index.html
 991 | ```
 992 | 
 993 | Knowing that hugo is using the slug to generate the file name, the simplest solution is to change the slug. Let's do it the hard way and change the permalink in the configuration file.
 994 | 
 995 | ```
 996 | $ vi config.toml
 997 | [permalinks]
 998 | 	page = "/:title/"
 999 | 	about = "/:filename/"
1000 | ```
1001 | 
1002 | Generate the web site and verify that this didn't work. Hugo lets "slug" or "URL" override the permalinks setting in the configuration file. Go ahead and comment out the slug in content/about.md, then generate the web site to get it to be created in the right place.
1003 | 
1004 | ## Sharing Templates
1005 | 
1006 | If you've been following along, you probably noticed that posts have titles in the browser and the home page doesn't. That's because we didn't put the title in the home page's template (layouts/index.html). That's an easy thing to do, but let's look at a different option.
1007 | 
1008 | We can put the common bits into a shared template that's stored in the themes/zafta/layouts/partials/ directory.
1009 | 
1010 | ### Create the Header and Footer Partials
1011 | 
1012 | In Hugo, a partial is a sugar-coated template. Normally a template reference has a path specified. Partials are different. Hugo searches for them along a TODO defined search path. This makes it easier for end-users to override the theme's presentation.
1013 | 
1014 | ```
1015 | $ vi themes/zafta/layouts/partials/header.html
1016 | <!DOCTYPE html>
1017 | <html>
1018 | <head>
1019 | 	<title>{{ .Title }}</title>
1020 | </head>
1021 | <body>
1022 | :wq
1023 | 
1024 | $ vi themes/zafta/layouts/partials/footer.html
1025 | </body>
1026 | </html>
1027 | :wq
1028 | ```
1029 | 
1030 | ### Update the Home Page Template to Use the Partials
1031 | 
1032 | The most noticeable difference between a template call and a partials call is the lack of path:
1033 | 
1034 | ```
1035 | {{ template "theme/partials/header.html" . }}
1036 | ```
1037 | versus
1038 | ```
1039 | {{ partial "header.html" . }}
1040 | ```
1041 | Both pass in the context.
1042 | 
1043 | Let's change the home page template to use these new partials.
1044 | 
1045 | ```
1046 | $ vi themes/zafta/layouts/index.html
1047 | {{ partial "header.html" . }}
1048 | 
1049 |   <h1>posts</h1>
1050 |   {{ range first 10 .Data.Pages }}
1051 |     {{ if eq .Type "post"}}
1052 |       <h2><a href="{{ .Permalink }}">{{ .Title }}</a></h2>
1053 |     {{ end }}
1054 |   {{ end }}
1055 | 
1056 |   <h1>pages</h1>
1057 |   {{ range .Data.Pages }}
1058 |     {{ if or (eq .Type "page") (eq .Type "about") }}
1059 |       <h2><a href="{{ .Permalink }}">{{ .Type }} - {{ .Title }} - {{ .RelPermalink }}</a></h2>
1060 |     {{ end }}
1061 |   {{ end }}
1062 | 
1063 | {{ partial "footer.html" . }}
1064 | :wq
1065 | ```
1066 | 
1067 | Generate the web site and verify the results. The title on the home page is now "your title here", which comes from the "title" variable in the config.toml file.
1068 | 
1069 | ### Update the Default Single Template to Use the Partials
1070 | 
1071 | ```
1072 | $ vi themes/zafta/layouts/_default/single.html
1073 | {{ partial "header.html" . }}
1074 | 
1075 |   <h1>{{ .Title }}</h1>
1076 |   {{ .Content }}
1077 | 
1078 | {{ partial "footer.html" . }}
1079 | :wq
1080 | ```
1081 | 
1082 | Generate the web site and verify the results. The title on the posts and the about page should both reflect the value in the markdown file.
1083 | 
1084 | ## Add “Date Published” to Posts
1085 | 
1086 | It's common to have posts display the date that they were written or published, so let's add that. The front matter of our posts has a variable named "date." It's usually the date the content was created, but let's pretend that's the value we want to display.
1087 | 
1088 | ### Add “Date Published” to the Template
1089 | 
1090 | We'll start by updating the template used to render the posts. The template code will look like:
1091 | 
1092 | ```
1093 | {{ .Date.Format "Mon, Jan 2, 2006" }}
1094 | ```
1095 | 
1096 | Posts use the default single template, so we'll change that file.
1097 | 
1098 | ```
1099 | $ vi themes/zafta/layouts/_default/single.html
1100 | {{ partial "header.html" . }}
1101 | 
1102 |   <h1>{{ .Title }}</h1>
1103 |   <h2>{{ .Date.Format "Mon, Jan 2, 2006" }}</h2>
1104 |   {{ .Content }}
1105 | 
1106 | {{ partial "footer.html" . }}
1107 | :wq
1108 | ```
1109 | 
1110 | Generate the web site and verify the results. The posts now have the date displayed in them. There's a problem, though. The "about" page also has the date displayed.
1111 | 
1112 | As usual, there are a couple of ways to make the date display only on posts. We could do an "if" statement like we did on the home page. Another way would be to create a separate template for posts.
1113 | 
1114 | The "if" solution works for sites that have just a couple of content types. It aligns with the principle of "code for today," too.
1115 | 
1116 | Let's assume, though, that we've made our site so complex that we feel we have to create a new template type. In Hugo-speak, we're going to create a section template.
1117 | 
1118 | Let's restore the default single template before we forget.
1119 | 
1120 | ```
1121 | $ mkdir themes/zafta/layouts/post
1122 | $ vi themes/zafta/layouts/_default/single.html
1123 | {{ partial "header.html" . }}
1124 | 
1125 |   <h1>{{ .Title }}</h1>
1126 |   {{ .Content }}
1127 | 
1128 | {{ partial "footer.html" . }}
1129 | :wq
1130 | ```
1131 | 
1132 | Now we'll update the post's version of the single template. If you remember Hugo's rules, the template engine will use this version over the default.
1133 | 
1134 | ```
1135 | $ vi themes/zafta/layouts/post/single.html
1136 | {{ partial "header.html" . }}
1137 | 
1138 |   <h1>{{ .Title }}</h1>
1139 |   <h2>{{ .Date.Format "Mon, Jan 2, 2006" }}</h2>
1140 |   {{ .Content }}
1141 | 
1142 | {{ partial "footer.html" . }}
1143 | :wq
1144 | 
1145 | ```
1146 | 
1147 | Note that we removed the date logic from the default template and put it in the post template. Generate the web site and verify the results. Posts have dates and the about page doesn't.
1148 | 
1149 | ### Don't Repeat Yourself
1150 | 
1151 | DRY is a good design goal and Hugo does a great job supporting it. Part of the art of a good template is knowing when to add a new template and when to update an existing one. While you're figuring that out, accept that you'll be doing some refactoring. Hugo makes that easy and fast, so it's okay to delay splitting up a template.
1152 | 


--------------------------------------------------------------------------------