├── exampleSite ├── static │ └── .gitkeep ├── config.toml └── content │ ├── about.md │ └── post │ ├── hugoisforlovers.md │ ├── migrate-from-jekyll.md │ ├── goisforlovers.md │ └── creating-a-new-theme.md ├── archetypes └── default.md ├── .gitignore ├── layouts ├── _default │ ├── list.html │ └── single.html ├── 404.html ├── partials │ ├── footer.html │ ├── nav.html │ ├── header.html │ ├── disqus.html │ └── pager.html └── index.html ├── images ├── tn.png └── screenshot.png ├── package.json ├── theme.toml ├── gulpfile.js ├── LICENSE.md ├── README.md ├── sass └── style.sass └── static └── css └── style.css /exampleSite/static/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /archetypes/default.md: -------------------------------------------------------------------------------- 1 | +++ 2 | +++ 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | node_modules 3 | -------------------------------------------------------------------------------- /layouts/_default/list.html: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /images/tn.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tanksuzuki/hemingway/HEAD/images/tn.png -------------------------------------------------------------------------------- /images/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/tanksuzuki/hemingway/HEAD/images/screenshot.png -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "hemingway", 3 | "devDependencies": { 4 | "bulma": "^0.1.2", 5 | "gulp": "^3.9.1", 6 | "gulp-autoprefixer": "^3.1.1", 7 | "gulp-sass": "^2.3.2" 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /layouts/404.html: -------------------------------------------------------------------------------- 1 | {{ partial "header" . }} 2 |
3 |
4 |
5 |

404

6 |

7 | Page not found 8 |

9 | Home Page 10 |
11 |
12 |
13 | -------------------------------------------------------------------------------- /layouts/_default/single.html: -------------------------------------------------------------------------------- 1 | {{ partial "header" . }} 2 | {{ partial "nav" . }} 3 |
4 |
5 |

{{ .Date.Format "January 2, 2006" }}

6 |

{{ .Title }}

7 |
8 | {{ .Content }} 9 |
10 |
11 |
12 | {{ partial "disqus" . }} 13 | {{ partial "footer" . }} 14 | -------------------------------------------------------------------------------- /theme.toml: -------------------------------------------------------------------------------- 1 | # theme.toml template for a Hugo theme 2 | # See https://github.com/spf13/hugoThemes#themetoml for an example 3 | 4 | name = "Hemingway" 5 | license = "MIT" 6 | licenselink = "https://github.com/tanksuzuki/hemingway/blob/master/LICENSE.md" 7 | description = "Really minimal blog theme for hugo" 8 | homepage = "https://github.com/tanksuzuki/hemingway" 9 | tags = ["blog", "font awesome", "highlight.js"] 10 | features = ["html5", "css3"] 11 | min_version = 0.16 12 | 13 | [author] 14 | name = "tanksuzuki" 15 | homepage = "http://tanksuzuki.com" 16 | -------------------------------------------------------------------------------- /gulpfile.js: -------------------------------------------------------------------------------- 1 | var gulp = require('gulp'); 2 | var sass = require('gulp-sass'); 3 | var autoprefixer = require('gulp-autoprefixer'); 4 | 5 | gulp.task("default", function () { 6 | gulp.src('sass/style.sass') 7 | .pipe(sass({outputStyle: 'compressed'})) 8 | .pipe(autoprefixer()) 9 | .pipe(gulp.dest('static/css/')); 10 | }); 11 | 12 | gulp.task("watch", function () { 13 | gulp.watch('sass/style.sass', function() { 14 | gulp.src('sass/style.sass') 15 | .pipe(sass({outputStyle: 'compressed'})) 16 | .pipe(autoprefixer()) 17 | .pipe(gulp.dest('static/css/')); 18 | }); 19 | }); 20 | -------------------------------------------------------------------------------- /layouts/partials/footer.html: -------------------------------------------------------------------------------- 1 |
2 |
3 |

{{ .Site.Copyright | safeHTML }}

4 |
5 |
6 | 7 | {{ range .Site.Params.highlight.languages }} 8 | 9 | {{ end }} 10 | 11 | {{ if .Site.GoogleAnalytics }} 12 | {{ template "_internal/google_analytics_async.html" . }} 13 | {{ end }} 14 | -------------------------------------------------------------------------------- /exampleSite/config.toml: -------------------------------------------------------------------------------- 1 | baseurl = "https://example.com" 2 | languageCode = "en" 3 | title = "Hemingway" 4 | theme = "hemingway" 5 | copyright = "© Asuka Suzuki 2016" 6 | disqusShortname = "shortname" 7 | googleAnalytics = "" 8 | 9 | [params] 10 | 11 | [params.highlight] 12 | style = "github" 13 | languages = ["go", "dockerfile"] 14 | 15 | [[params.social]] 16 | url = "https://github.com/tanksuzuki" 17 | fa_icon = "fa-github" 18 | 19 | [[params.social]] 20 | url = "https://twitter.com/tanksuzuki" 21 | fa_icon = "fa-twitter" 22 | 23 | [[params.social]] 24 | url = "/index.xml" 25 | fa_icon = "fa-rss" 26 | -------------------------------------------------------------------------------- /layouts/partials/nav.html: -------------------------------------------------------------------------------- 1 |
2 |
3 | 19 |
20 |
21 | -------------------------------------------------------------------------------- /layouts/partials/header.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | {{ .Title }}{{ if eq .IsHome false }} | {{ .Site.Title }}{{ end }} 6 | 7 | 8 | {{ with .Site.Params.highlight.style }} 9 | 10 | {{ else }} 11 | 12 | {{ end }} 13 | -------------------------------------------------------------------------------- /layouts/partials/disqus.html: -------------------------------------------------------------------------------- 1 | {{ if .Site.DisqusShortname }} 2 |
3 |
4 | 5 | 13 | 14 |
15 |
16 | {{ end }} 17 | -------------------------------------------------------------------------------- /layouts/index.html: -------------------------------------------------------------------------------- 1 | {{ partial "header" . }} 2 | {{ partial "nav" . }} 3 |
4 |
5 | {{ range sort .Paginator.Pages }} 6 | 21 | {{ end }} 22 |
23 |
24 | {{ partial "pager" . }} 25 | {{ partial "footer" . }} 26 | -------------------------------------------------------------------------------- /exampleSite/content/about.md: -------------------------------------------------------------------------------- 1 | +++ 2 | title = "About Hugo" 3 | date = "2014-04-09" 4 | menu = "main" 5 | +++ 6 | 7 | Hugo is a static site engine written in Go. 8 | 9 | 10 | It makes use of a variety of open source projects including: 11 | 12 | * [Cobra](https://github.com/spf13/cobra) 13 | * [Viper](https://github.com/spf13/viper) 14 | * [J Walter Weatherman](https://github.com/spf13/jWalterWeatherman) 15 | * [Cast](https://github.com/spf13/cast) 16 | 17 | Learn more and contribute on [GitHub](https://github.com/spf13). 18 | 19 | ## Setup 20 | 21 | Some fun facts about [Hugo](http://gohugo.io/): 22 | 23 | * Built in [Go](http://golang.org/) 24 | * Loosely inspired by [Jekyll](http://jekyllrb.com/) 25 | * Primarily developed by [spf13](http://spf13.com/) on the train while commuting to and from Manhattan. 26 | * Coded in [Vim](http://vim.org) using [spf13-vim](http://vim.spf13.com/) 27 | 28 | Have questions or suggestions? Feel free to [open an issue on GitHub](https://github.com/spf13/hugo/issues/new) or [ask me on Twitter](https://twitter.com/spf13). 29 | 30 | Thanks for reading! 31 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2016 Asuka Suzuki 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 | -------------------------------------------------------------------------------- /layouts/partials/pager.html: -------------------------------------------------------------------------------- 1 |
2 |
3 | 43 |
44 |
45 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Hemingway 2 | 3 | Hemingway is a really minimal blog theme for hugo. 4 | 5 | ![](https://github.com/tanksuzuki/hemingway/blob/master/images/tn.png) 6 | 7 | ## Getting Started 8 | 9 | Clone this repository to your hugo theme directory. 10 | 11 | ``` 12 | mkdir themes 13 | cd themes 14 | git clone https://github.com/tanksuzuki/hemingway.git 15 | ``` 16 | 17 | ## Configuration 18 | 19 | Take a look in the [exampleSite](https://github.com/tanksuzuki/hemingway/tree/master/exampleSite) folder. 20 | 21 | This directory contains an example config file and the content for the demo. 22 | It serves as an example setup for your documentation. 23 | 24 | Copy the `config.toml` in the root directory of your website. Overwrite the existing config file if necessary. 25 | 26 | __[config.toml](https://github.com/tanksuzuki/hemingway/blob/master/exampleSite/config.toml)__: 27 | 28 | ```toml 29 | baseurl = "https://example.com" 30 | languageCode = "en" 31 | title = "Hemingway" 32 | theme = "hemingway" 33 | copyright = "© Asuka Suzuki 2016" 34 | disqusShortname = "shortname" 35 | googleAnalytics = "" 36 | 37 | [params] 38 | 39 | [params.highlight] 40 | style = "github" 41 | languages = ["go", "dockerfile"] 42 | 43 | [[params.social]] 44 | url = "https://github.com/tanksuzuki" 45 | fa_icon = "fa-github" 46 | 47 | [[params.social]] 48 | url = "https://twitter.com/tanksuzuki" 49 | fa_icon = "fa-twitter" 50 | 51 | [[params.social]] 52 | url = "/index.xml" 53 | fa_icon = "fa-rss" 54 | ``` 55 | 56 | ## Build 57 | 58 | ``` 59 | hugo server 60 | ``` 61 | 62 | You can go to localhost:1313 and this theme should be visible. 63 | 64 | ## License 65 | 66 | Hemingway is licensed under the [MIT License](LICENSE.md). 67 | 68 | ## Author 69 | 70 | [Asuka Suzuki](https://github.com/tanksuzuki) 71 | -------------------------------------------------------------------------------- /sass/style.sass: -------------------------------------------------------------------------------- 1 | $blue: #2077b2 2 | $primary: $blue 3 | $grey-dark: #42464c 4 | $family-sans-serif: "游ゴシック", YuGothic, "ヒラギノ角ゴ Pro", "Hiragino Kaku Gothic Pro", "メイリオ", "Meiryo", sans-serif 5 | 6 | @import "node_modules/bulma/bulma" 7 | 8 | .container 9 | max-width: 800px 10 | margin: 0 auto 11 | 12 | .content 13 | font-size: 16px 14 | line-height: 1.75 15 | 16 | .media-content 17 | .subtitle+.title 18 | margin-bottom: 10px 19 | .content 20 | line-height: 1.5 21 | 22 | .hero .nav 23 | box-shadow: none 24 | 25 | html 26 | background-color: transparent 27 | 28 | .section 29 | padding: 40px 20px 30 | 31 | .nav .level-item 32 | margin-left: 10px 33 | 34 | .subtitle 35 | color: #69707a 36 | 37 | .title 38 | line-height: 1.25 39 | font-size: 24px 40 | a 41 | color: #222324 42 | &.notfound 43 | font-size: 20vw 44 | 45 | code 46 | color: inherit 47 | background-color: transparent 48 | font-size: 90% 49 | 50 | 51 | 52 | article+article 53 | margin-top: 80px 54 | 55 | .content 56 | h1, h2, h3, h4, h5, h6 57 | line-height: 1.25 58 | &:not(:first-child) 59 | margin-top: 80px 60 | &::before 61 | color: #aeb1b5 62 | font-weight: bold 63 | code 64 | background-color: #f8f8f8 65 | h1+h2:not(:first-child), 66 | h2+h3:not(:first-child), 67 | h3+h4:not(:first-child), 68 | h4+h5:not(:first-child), 69 | h5+h6:not(:first-child) 70 | margin-top: 20px 71 | h1 72 | font-size: 24px 73 | &::before 74 | content: "# " 75 | h2 76 | font-size: 22px 77 | &::before 78 | content: "## " 79 | h3 80 | font-size: 20px 81 | &::before 82 | content: "### " 83 | h4 84 | font-size: 18px 85 | &::before 86 | content: "#### " 87 | h5 88 | font-size: 17px 89 | &::before 90 | content: "##### " 91 | h6 92 | font-size: 16px 93 | &::before 94 | content: "###### " 95 | p, 96 | ol, 97 | ul, 98 | pre, 99 | table 100 | &:not(:last-child) 101 | margin-bottom: 1.5em 102 | table 103 | td, 104 | th 105 | border: 1px solid #d3d6db 106 | padding: 8px 10px 107 | vertical-align: top 108 | & > code, p > code 109 | font-size: 90% 110 | padding: 2px 4px 111 | margin: 0 2px 112 | border: 1px solid #ddd 113 | border-radius: 4px 114 | background-color: #f8f8f8 115 | color: #42464c 116 | pre 117 | code 118 | font-size: 90% 119 | padding: 1em 120 | line-height: 1.5 121 | li 122 | pre, 123 | table 124 | margin-bottom: 1.5em 125 | -------------------------------------------------------------------------------- /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 | categories = [ 12 | "Development", 13 | "golang", 14 | ] 15 | menu = "main" 16 | +++ 17 | 18 | ## Step 1. Install Hugo 19 | 20 | Goto [hugo releases](https://github.com/spf13/hugo/releases) and download the 21 | appropriate version for your os and architecture. 22 | 23 | Save it somewhere specific as we will be using it in the next step. 24 | 25 | More complete instructions are available at [installing hugo](/overview/installing/) 26 | 27 | ## Step 2. Build the Docs 28 | 29 | Hugo has its own example site which happens to also be the documentation site 30 | you are reading right now. 31 | 32 | Follow the following steps: 33 | 34 | 1. Clone the [hugo repository](http://github.com/spf13/hugo) 35 | 2. Go into the repo 36 | 3. Run hugo in server mode and build the docs 37 | 4. Open your browser to http://localhost:1313 38 | 39 | Corresponding pseudo commands: 40 | 41 | git clone https://github.com/spf13/hugo 42 | cd hugo 43 | /path/to/where/you/installed/hugo server --source=./docs 44 | > 29 pages created 45 | > 0 tags index created 46 | > in 27 ms 47 | > Web Server is available at http://localhost:1313 48 | > Press ctrl+c to stop 49 | 50 | Once you've gotten here, follow along the rest of this page on your local build. 51 | 52 | ## Step 3. Change the docs site 53 | 54 | Stop the Hugo process by hitting ctrl+c. 55 | 56 | Now we are going to run hugo again, but this time with hugo in watch mode. 57 | 58 | /path/to/hugo/from/step/1/hugo server --source=./docs --watch 59 | > 29 pages created 60 | > 0 tags index created 61 | > in 27 ms 62 | > Web Server is available at http://localhost:1313 63 | > Watching for changes in /Users/spf13/Code/hugo/docs/content 64 | > Press ctrl+c to stop 65 | 66 | 67 | Open your [favorite editor](http://vim.spf13.com) and change one of the source 68 | content pages. How about changing this very file to *fix the typo*. How about changing this very file to *fix the typo*. 69 | 70 | Content files are found in `docs/content/`. Unless otherwise specified, files 71 | are located at the same relative location as the url, in our case 72 | `docs/content/overview/quickstart.md`. 73 | 74 | Change and save this file.. Notice what happened in your terminal. 75 | 76 | > Change detected, rebuilding site 77 | 78 | > 29 pages created 79 | > 0 tags index created 80 | > in 26 ms 81 | 82 | Refresh the browser and observe that the typo is now fixed. 83 | 84 | Notice how quick that was. Try to refresh the site before it's finished building.. I double dare you. 85 | Having nearly instant feedback enables you to have your creativity flow without waiting for long builds. 86 | 87 | ## Step 4. Have fun 88 | 89 | The best way to learn something is to play with it. 90 | -------------------------------------------------------------------------------- /exampleSite/content/post/migrate-from-jekyll.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2014-03-10 3 | linktitle: Migrating from Jekyll 4 | menu: 5 | main: 6 | parent: tutorials 7 | prev: /tutorials/mathjax 8 | title: Migrate to Hugo from Jekyll 9 | weight: 10 10 | --- 11 | 12 | ## Move static content to `static` 13 | 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. 14 | With Jekyll, something that looked like 15 | 16 | ▾ / 17 | ▾ images/ 18 | logo.png 19 | 20 | should become 21 | 22 | ▾ / 23 | ▾ static/ 24 | ▾ images/ 25 | logo.png 26 | 27 | Additionally, you'll want any files that should reside at the root (such as `CNAME`) to be moved to `static`. 28 | 29 | ## Create your Hugo configuration file 30 | 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. 31 | 32 | ## Set your configuration publish folder to `_site` 33 | 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: 34 | 35 | 1. Change your submodule to point to map `gh-pages` to public instead of `_site` (recommended). 36 | 37 | git submodule deinit _site 38 | git rm _site 39 | git submodule add -b gh-pages git@github.com:your-username/your-repo.git public 40 | 41 | 2. Or, change the Hugo configuration to use `_site` instead of `public`. 42 | 43 | { 44 | .. 45 | "publishdir": "_site", 46 | .. 47 | } 48 | 49 | ## Convert Jekyll templates to Hugo templates 50 | 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. 51 | 52 | As a single reference data point, converting my templates for [heyitsalex.net](http://heyitsalex.net/) took me no more than a few hours. 53 | 54 | ## Convert Jekyll plugins to Hugo shortcodes 55 | Jekyll has [plugins](http://jekyllrb.com/docs/plugins/); Hugo has [shortcodes](/doc/shortcodes/). It's fairly trivial to do a port. 56 | 57 | ### Implementation 58 | 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. 59 | 60 | Jekyll's plugin: 61 | 62 | module Jekyll 63 | class ImageTag < Liquid::Tag 64 | @url = nil 65 | @caption = nil 66 | @class = nil 67 | @link = nil 68 | // Patterns 69 | IMAGE_URL_WITH_CLASS_AND_CAPTION = 70 | IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK = /(\w+)(\s+)((https?:\/\/|\/)(\S+))(\s+)"(.*?)"(\s+)->((https?:\/\/|\/)(\S+))(\s*)/i 71 | IMAGE_URL_WITH_CAPTION = /((https?:\/\/|\/)(\S+))(\s+)"(.*?)"/i 72 | IMAGE_URL_WITH_CLASS = /(\w+)(\s+)((https?:\/\/|\/)(\S+))/i 73 | IMAGE_URL = /((https?:\/\/|\/)(\S+))/i 74 | def initialize(tag_name, markup, tokens) 75 | super 76 | if markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK 77 | @class = $1 78 | @url = $3 79 | @caption = $7 80 | @link = $9 81 | elsif markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION 82 | @class = $1 83 | @url = $3 84 | @caption = $7 85 | elsif markup =~ IMAGE_URL_WITH_CAPTION 86 | @url = $1 87 | @caption = $5 88 | elsif markup =~ IMAGE_URL_WITH_CLASS 89 | @class = $1 90 | @url = $3 91 | elsif markup =~ IMAGE_URL 92 | @url = $1 93 | end 94 | end 95 | def render(context) 96 | if @class 97 | source = "
" 98 | else 99 | source = "
" 100 | end 101 | if @link 102 | source += "" 103 | end 104 | source += "" 105 | if @link 106 | source += "" 107 | end 108 | source += "
#{@caption}
" if @caption 109 | source += "
" 110 | source 111 | end 112 | end 113 | end 114 | Liquid::Template.register_tag('image', Jekyll::ImageTag) 115 | 116 | is written as this Hugo shortcode: 117 | 118 | 119 |
120 | {{ with .Get "link"}}{{ end }} 121 | 122 | {{ if .Get "link"}}{{ end }} 123 | {{ if or (or (.Get "title") (.Get "caption")) (.Get "attr")}} 124 |
{{ if isset .Params "title" }} 125 | {{ .Get "title" }}{{ end }} 126 | {{ if or (.Get "caption") (.Get "attr")}}

127 | {{ .Get "caption" }} 128 | {{ with .Get "attrlink"}} {{ end }} 129 | {{ .Get "attr" }} 130 | {{ if .Get "attrlink"}} {{ end }} 131 |

{{ end }} 132 |
133 | {{ end }} 134 |
135 | 136 | 137 | ### Usage 138 | I simply changed: 139 | 140 | {% 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/ %} 141 | 142 | to this (this example uses a slightly extended version named `fig`, different than the built-in `figure`): 143 | 144 | {{%/* 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/" */%}} 145 | 146 | As a bonus, the shortcode named parameters are, arguably, more readable. 147 | 148 | ## Finishing touches 149 | ### Fix content 150 | 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. 151 | 152 | ### Clean up 153 | You'll want to remove the Jekyll configuration at this point. If you have anything else that isn't used, delete it. 154 | 155 | ## A practical example in a diff 156 | [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). 157 | -------------------------------------------------------------------------------- /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 | categories = [ 13 | "Development", 14 | "golang", 15 | ] 16 | menu = "main" 17 | +++ 18 | 19 | Hugo uses the excellent [go][] [html/template][gohtmltemplate] library for 20 | its template engine. It is an extremely lightweight engine that provides a very 21 | small amount of logic. In our experience that it is just the right amount of 22 | logic to be able to create a good static website. If you have used other 23 | template systems from different languages or frameworks you will find a lot of 24 | similarities in go templates. 25 | 26 | This document is a brief primer on using go templates. The [go docs][gohtmltemplate] 27 | provide more details. 28 | 29 | ## Introduction to Go Templates 30 | 31 | Go templates provide an extremely simple template language. It adheres to the 32 | belief that only the most basic of logic belongs in the template or view layer. 33 | One consequence of this simplicity is that go templates parse very quickly. 34 | 35 | A unique characteristic of go templates is they are content aware. Variables and 36 | content will be sanitized depending on the context of where they are used. More 37 | details can be found in the [go docs][gohtmltemplate]. 38 | 39 | ## Basic Syntax 40 | 41 | Go lang templates are html files with the addition of variables and 42 | functions. 43 | 44 | **Go variables and functions are accessible within {{ }}** 45 | 46 | Accessing a predefined variable "foo": 47 | 48 | {{ foo }} 49 | 50 | **Parameters are separated using spaces** 51 | 52 | Calling the add function with input of 1, 2: 53 | 54 | {{ add 1 2 }} 55 | 56 | **Methods and fields are accessed via dot notation** 57 | 58 | Accessing the Page Parameter "bar" 59 | 60 | {{ .Params.bar }} 61 | 62 | **Parentheses can be used to group items together** 63 | 64 | {{ if or (isset .Params "alt") (isset .Params "caption") }} Caption {{ end }} 65 | 66 | 67 | ## Variables 68 | 69 | Each go template has a struct (object) made available to it. In hugo each 70 | template is passed either a page or a node struct depending on which type of 71 | page you are rendering. More details are available on the 72 | [variables](/layout/variables) page. 73 | 74 | A variable is accessed by referencing the variable name. 75 | 76 | {{ .Title }} 77 | 78 | Variables can also be defined and referenced. 79 | 80 | {{ $address := "123 Main St."}} 81 | {{ $address }} 82 | 83 | 84 | ## Functions 85 | 86 | Go template ship with a few functions which provide basic functionality. The go 87 | template system also provides a mechanism for applications to extend the 88 | available functions with their own. [Hugo template 89 | functions](/layout/functions) provide some additional functionality we believe 90 | are useful for building websites. Functions are called by using their name 91 | followed by the required parameters separated by spaces. Template 92 | functions cannot be added without recompiling hugo. 93 | 94 | **Example:** 95 | 96 | {{ add 1 2 }} 97 | 98 | ## Includes 99 | 100 | When including another template you will pass to it the data it will be 101 | able to access. To pass along the current context please remember to 102 | include a trailing dot. The templates location will always be starting at 103 | the /layout/ directory within Hugo. 104 | 105 | **Example:** 106 | 107 | {{ template "chrome/header.html" . }} 108 | 109 | 110 | ## Logic 111 | 112 | Go templates provide the most basic iteration and conditional logic. 113 | 114 | ### Iteration 115 | 116 | Just like in go, the go templates make heavy use of range to iterate over 117 | a map, array or slice. The following are different examples of how to use 118 | range. 119 | 120 | **Example 1: Using Context** 121 | 122 | {{ range array }} 123 | {{ . }} 124 | {{ end }} 125 | 126 | **Example 2: Declaring value variable name** 127 | 128 | {{range $element := array}} 129 | {{ $element }} 130 | {{ end }} 131 | 132 | **Example 2: Declaring key and value variable name** 133 | 134 | {{range $index, $element := array}} 135 | {{ $index }} 136 | {{ $element }} 137 | {{ end }} 138 | 139 | ### Conditionals 140 | 141 | If, else, with, or, & and provide the framework for handling conditional 142 | logic in Go Templates. Like range, each statement is closed with `end`. 143 | 144 | 145 | Go Templates treat the following values as false: 146 | 147 | * false 148 | * 0 149 | * any array, slice, map, or string of length zero 150 | 151 | **Example 1: If** 152 | 153 | {{ if isset .Params "title" }}

{{ index .Params "title" }}

{{ end }} 154 | 155 | **Example 2: If -> Else** 156 | 157 | {{ if isset .Params "alt" }} 158 | {{ index .Params "alt" }} 159 | {{else}} 160 | {{ index .Params "caption" }} 161 | {{ end }} 162 | 163 | **Example 3: And & Or** 164 | 165 | {{ if and (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}} 166 | 167 | **Example 4: With** 168 | 169 | An alternative way of writing "if" and then referencing the same value 170 | is to use "with" instead. With rebinds the context `.` within its scope, 171 | and skips the block if the variable is absent. 172 | 173 | The first example above could be simplified as: 174 | 175 | {{ with .Params.title }}

{{ . }}

{{ end }} 176 | 177 | **Example 5: If -> Else If** 178 | 179 | {{ if isset .Params "alt" }} 180 | {{ index .Params "alt" }} 181 | {{ else if isset .Params "caption" }} 182 | {{ index .Params "caption" }} 183 | {{ end }} 184 | 185 | ## Pipes 186 | 187 | One of the most powerful components of go templates is the ability to 188 | stack actions one after another. This is done by using pipes. Borrowed 189 | from unix pipes, the concept is simple, each pipeline's output becomes the 190 | input of the following pipe. 191 | 192 | Because of the very simple syntax of go templates, the pipe is essential 193 | to being able to chain together function calls. One limitation of the 194 | pipes is that they only can work with a single value and that value 195 | becomes the last parameter of the next pipeline. 196 | 197 | A few simple examples should help convey how to use the pipe. 198 | 199 | **Example 1 :** 200 | 201 | {{ if eq 1 1 }} Same {{ end }} 202 | 203 | is the same as 204 | 205 | {{ eq 1 1 | if }} Same {{ end }} 206 | 207 | It does look odd to place the if at the end, but it does provide a good 208 | illustration of how to use the pipes. 209 | 210 | **Example 2 :** 211 | 212 | {{ index .Params "disqus_url" | html }} 213 | 214 | Access the page parameter called "disqus_url" and escape the HTML. 215 | 216 | **Example 3 :** 217 | 218 | {{ if or (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}} 219 | Stuff Here 220 | {{ end }} 221 | 222 | Could be rewritten as 223 | 224 | {{ isset .Params "caption" | or isset .Params "title" | or isset .Params "attr" | if }} 225 | Stuff Here 226 | {{ end }} 227 | 228 | 229 | ## Context (aka. the dot) 230 | 231 | The most easily overlooked concept to understand about go templates is that {{ . }} 232 | always refers to the current context. In the top level of your template this 233 | will be the data set made available to it. Inside of a iteration it will have 234 | the value of the current item. When inside of a loop the context has changed. . 235 | will no longer refer to the data available to the entire page. If you need to 236 | access this from within the loop you will likely want to set it to a variable 237 | instead of depending on the context. 238 | 239 | **Example:** 240 | 241 | {{ $title := .Site.Title }} 242 | {{ range .Params.tags }} 243 |
  • {{ . }} - {{ $title }}
    • 244 | {{ end }} 245 | 246 | Notice how once we have entered the loop the value of {{ . }} has changed. We 247 | have defined a variable outside of the loop so we have access to it from within 248 | the loop. 249 | 250 | # Hugo Parameters 251 | 252 | Hugo provides the option of passing values to the template language 253 | through the site configuration (for sitewide values), or through the meta 254 | data of each specific piece of content. You can define any values of any 255 | type (supported by your front matter/config format) and use them however 256 | you want to inside of your templates. 257 | 258 | 259 | ## Using Content (page) Parameters 260 | 261 | In each piece of content you can provide variables to be used by the 262 | templates. This happens in the [front matter](/content/front-matter). 263 | 264 | An example of this is used in this documentation site. Most of the pages 265 | benefit from having the table of contents provided. Sometimes the TOC just 266 | doesn't make a lot of sense. We've defined a variable in our front matter 267 | of some pages to turn off the TOC from being displayed. 268 | 269 | Here is the example front matter: 270 | 271 | ``` 272 | --- 273 | title: "Permalinks" 274 | date: "2013-11-18" 275 | aliases: 276 | - "/doc/permalinks/" 277 | groups: ["extras"] 278 | groups_weight: 30 279 | notoc: true 280 | --- 281 | ``` 282 | 283 | Here is the corresponding code inside of the template: 284 | 285 | {{ if not .Params.notoc }} 286 |
    287 | {{ .TableOfContents }} 288 |
    289 | {{ end }} 290 | 291 | 292 | 293 | ## Using Site (config) Parameters 294 | In your top-level configuration file (eg, `config.yaml`) you can define site 295 | parameters, which are values which will be available to you in chrome. 296 | 297 | For instance, you might declare: 298 | 299 | ```yaml 300 | params: 301 | CopyrightHTML: "Copyright © 2013 John Doe. All Rights Reserved." 302 | TwitterUser: "spf13" 303 | SidebarRecentLimit: 5 304 | ``` 305 | 306 | Within a footer layout, you might then declare a `