mirror of
https://github.com/adityatelange/hugo-PaperMod.git
synced 2023-12-21 10:22:58 +01:00
Remove outdated content (#46)
For some reason the old content was not deleted when #45 was merged. So I am sending this one to have it removed. cc: @digitalcraftsman
This commit is contained in:
Alexandros
digitalcraftsman
parent
5d9d7786a2
commit
4a9e2433df
File diff suppressed because it is too large
Load Diff
@ -1,346 +0,0 @@
|
|||||||
+++
|
|
||||||
title = "(Hu)go Template Primer"
|
|
||||||
description = ""
|
|
||||||
type = "posts"
|
|
||||||
tags = [
|
|
||||||
"go",
|
|
||||||
"golang",
|
|
||||||
"templates",
|
|
||||||
"themes",
|
|
||||||
"development",
|
|
||||||
]
|
|
||||||
date = "2014-04-02"
|
|
||||||
categories = [
|
|
||||||
"Development",
|
|
||||||
"golang",
|
|
||||||
]
|
|
||||||
series = ["Hugo 101"]
|
|
||||||
author = "Hugo Authors"
|
|
||||||
+++
|
|
||||||
|
|
||||||
Hugo uses the excellent [Go][] [html/template][gohtmltemplate] library for
|
|
||||||
its template engine. It is an extremely lightweight engine that provides a very
|
|
||||||
small amount of logic. In our experience that it is just the right amount of
|
|
||||||
logic to be able to create a good static website. If you have used other
|
|
||||||
template systems from different languages or frameworks you will find a lot of
|
|
||||||
similarities in Go templates.
|
|
||||||
|
|
||||||
This document is a brief primer on using Go templates. The [Go docs][gohtmltemplate]
|
|
||||||
provide more details.
|
|
||||||
|
|
||||||
## Introduction to Go Templates
|
|
||||||
|
|
||||||
Go templates provide an extremely simple template language. It adheres to the
|
|
||||||
belief that only the most basic of logic belongs in the template or view layer.
|
|
||||||
One consequence of this simplicity is that Go templates parse very quickly.
|
|
||||||
|
|
||||||
A unique characteristic of Go templates is they are content aware. Variables and
|
|
||||||
content will be sanitized depending on the context of where they are used. More
|
|
||||||
details can be found in the [Go docs][gohtmltemplate].
|
|
||||||
|
|
||||||
## Basic Syntax
|
|
||||||
|
|
||||||
Golang templates are HTML files with the addition of variables and
|
|
||||||
functions.
|
|
||||||
|
|
||||||
**Go variables and functions are accessible within {{ }}**
|
|
||||||
|
|
||||||
Accessing a predefined variable "foo":
|
|
||||||
|
|
||||||
{{ foo }}
|
|
||||||
|
|
||||||
**Parameters are separated using spaces**
|
|
||||||
|
|
||||||
Calling the add function with input of 1, 2:
|
|
||||||
|
|
||||||
{{ add 1 2 }}
|
|
||||||
|
|
||||||
**Methods and fields are accessed via dot notation**
|
|
||||||
|
|
||||||
Accessing the Page Parameter "bar"
|
|
||||||
|
|
||||||
{{ .Params.bar }}
|
|
||||||
|
|
||||||
**Parentheses can be used to group items together**
|
|
||||||
|
|
||||||
{{ if or (isset .Params "alt") (isset .Params "caption") }} Caption {{ end }}
|
|
||||||
|
|
||||||
|
|
||||||
## Variables
|
|
||||||
|
|
||||||
Each Go template has a struct (object) made available to it. In hugo each
|
|
||||||
template is passed either a page or a node struct depending on which type of
|
|
||||||
page you are rendering. More details are available on the
|
|
||||||
[variables](/layout/variables) page.
|
|
||||||
|
|
||||||
A variable is accessed by referencing the variable name.
|
|
||||||
|
|
||||||
<title>{{ .Title }}</title>
|
|
||||||
|
|
||||||
Variables can also be defined and referenced.
|
|
||||||
|
|
||||||
{{ $address := "123 Main St."}}
|
|
||||||
{{ $address }}
|
|
||||||
|
|
||||||
|
|
||||||
## Functions
|
|
||||||
|
|
||||||
Go template ship with a few functions which provide basic functionality. The Go
|
|
||||||
template system also provides a mechanism for applications to extend the
|
|
||||||
available functions with their own. [Hugo template
|
|
||||||
functions](/layout/functions) provide some additional functionality we believe
|
|
||||||
are useful for building websites. Functions are called by using their name
|
|
||||||
followed by the required parameters separated by spaces. Template
|
|
||||||
functions cannot be added without recompiling hugo.
|
|
||||||
|
|
||||||
**Example:**
|
|
||||||
|
|
||||||
{{ add 1 2 }}
|
|
||||||
|
|
||||||
## Includes
|
|
||||||
|
|
||||||
When including another template you will pass to it the data it will be
|
|
||||||
able to access. To pass along the current context please remember to
|
|
||||||
include a trailing dot. The templates location will always be starting at
|
|
||||||
the /layout/ directory within Hugo.
|
|
||||||
|
|
||||||
**Example:**
|
|
||||||
|
|
||||||
{{ template "chrome/header.html" . }}
|
|
||||||
|
|
||||||
|
|
||||||
## Logic
|
|
||||||
|
|
||||||
Go templates provide the most basic iteration and conditional logic.
|
|
||||||
|
|
||||||
### Iteration
|
|
||||||
|
|
||||||
Just like in Go, the Go templates make heavy use of range to iterate over
|
|
||||||
a map, array or slice. The following are different examples of how to use
|
|
||||||
range.
|
|
||||||
|
|
||||||
**Example 1: Using Context**
|
|
||||||
|
|
||||||
{{ range array }}
|
|
||||||
{{ . }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
**Example 2: Declaring value variable name**
|
|
||||||
|
|
||||||
{{range $element := array}}
|
|
||||||
{{ $element }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
**Example 2: Declaring key and value variable name**
|
|
||||||
|
|
||||||
{{range $index, $element := array}}
|
|
||||||
{{ $index }}
|
|
||||||
{{ $element }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
### Conditionals
|
|
||||||
|
|
||||||
If, else, with, or, & and provide the framework for handling conditional
|
|
||||||
logic in Go Templates. Like range, each statement is closed with `end`.
|
|
||||||
|
|
||||||
|
|
||||||
Go Templates treat the following values as false:
|
|
||||||
|
|
||||||
* false
|
|
||||||
* 0
|
|
||||||
* any array, slice, map, or string of length zero
|
|
||||||
|
|
||||||
**Example 1: If**
|
|
||||||
|
|
||||||
{{ if isset .Params "title" }}<h4>{{ index .Params "title" }}</h4>{{ end }}
|
|
||||||
|
|
||||||
**Example 2: If -> Else**
|
|
||||||
|
|
||||||
{{ if isset .Params "alt" }}
|
|
||||||
{{ index .Params "alt" }}
|
|
||||||
{{else}}
|
|
||||||
{{ index .Params "caption" }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
**Example 3: And & Or**
|
|
||||||
|
|
||||||
{{ if and (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}}
|
|
||||||
|
|
||||||
**Example 4: With**
|
|
||||||
|
|
||||||
An alternative way of writing "if" and then referencing the same value
|
|
||||||
is to use "with" instead. With rebinds the context `.` within its scope,
|
|
||||||
and skips the block if the variable is absent.
|
|
||||||
|
|
||||||
The first example above could be simplified as:
|
|
||||||
|
|
||||||
{{ with .Params.title }}<h4>{{ . }}</h4>{{ end }}
|
|
||||||
|
|
||||||
**Example 5: If -> Else If**
|
|
||||||
|
|
||||||
{{ if isset .Params "alt" }}
|
|
||||||
{{ index .Params "alt" }}
|
|
||||||
{{ else if isset .Params "caption" }}
|
|
||||||
{{ index .Params "caption" }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
## Pipes
|
|
||||||
|
|
||||||
One of the most powerful components of Go templates is the ability to
|
|
||||||
stack actions one after another. This is done by using pipes. Borrowed
|
|
||||||
from unix pipes, the concept is simple, each pipeline's output becomes the
|
|
||||||
input of the following pipe.
|
|
||||||
|
|
||||||
Because of the very simple syntax of Go templates, the pipe is essential
|
|
||||||
to being able to chain together function calls. One limitation of the
|
|
||||||
pipes is that they only can work with a single value and that value
|
|
||||||
becomes the last parameter of the next pipeline.
|
|
||||||
|
|
||||||
A few simple examples should help convey how to use the pipe.
|
|
||||||
|
|
||||||
**Example 1 :**
|
|
||||||
|
|
||||||
{{ if eq 1 1 }} Same {{ end }}
|
|
||||||
|
|
||||||
is the same as
|
|
||||||
|
|
||||||
{{ eq 1 1 | if }} Same {{ end }}
|
|
||||||
|
|
||||||
It does look odd to place the if at the end, but it does provide a good
|
|
||||||
illustration of how to use the pipes.
|
|
||||||
|
|
||||||
**Example 2 :**
|
|
||||||
|
|
||||||
{{ index .Params "disqus_url" | html }}
|
|
||||||
|
|
||||||
Access the page parameter called "disqus_url" and escape the HTML.
|
|
||||||
|
|
||||||
**Example 3 :**
|
|
||||||
|
|
||||||
{{ if or (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}}
|
|
||||||
Stuff Here
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
Could be rewritten as
|
|
||||||
|
|
||||||
{{ isset .Params "caption" | or isset .Params "title" | or isset .Params "attr" | if }}
|
|
||||||
Stuff Here
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
|
|
||||||
## Context (aka. the dot)
|
|
||||||
|
|
||||||
The most easily overlooked concept to understand about Go templates is that {{ . }}
|
|
||||||
always refers to the current context. In the top level of your template this
|
|
||||||
will be the data set made available to it. Inside of a iteration it will have
|
|
||||||
the value of the current item. When inside of a loop the context has changed. .
|
|
||||||
will no longer refer to the data available to the entire page. If you need to
|
|
||||||
access this from within the loop you will likely want to set it to a variable
|
|
||||||
instead of depending on the context.
|
|
||||||
|
|
||||||
**Example:**
|
|
||||||
|
|
||||||
{{ $title := .Site.Title }}
|
|
||||||
{{ range .Params.tags }}
|
|
||||||
<li> <a href="{{ $baseurl }}/tags/{{ . | urlize }}">{{ . }}</a> - {{ $title }} </li>
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
Notice how once we have entered the loop the value of {{ . }} has changed. We
|
|
||||||
have defined a variable outside of the loop so we have access to it from within
|
|
||||||
the loop.
|
|
||||||
|
|
||||||
# Hugo Parameters
|
|
||||||
|
|
||||||
Hugo provides the option of passing values to the template language
|
|
||||||
through the site configuration (for sitewide values), or through the meta
|
|
||||||
data of each specific piece of content. You can define any values of any
|
|
||||||
type (supported by your front matter/config format) and use them however
|
|
||||||
you want to inside of your templates.
|
|
||||||
|
|
||||||
|
|
||||||
## Using Content (page) Parameters
|
|
||||||
|
|
||||||
In each piece of content you can provide variables to be used by the
|
|
||||||
templates. This happens in the [front matter](/content/front-matter).
|
|
||||||
|
|
||||||
An example of this is used in this documentation site. Most of the pages
|
|
||||||
benefit from having the table of contents provided. Sometimes the TOC just
|
|
||||||
doesn't make a lot of sense. We've defined a variable in our front matter
|
|
||||||
of some pages to turn off the TOC from being displayed.
|
|
||||||
|
|
||||||
Here is the example front matter:
|
|
||||||
|
|
||||||
```
|
|
||||||
---
|
|
||||||
title: "Permalinks"
|
|
||||||
date: "2013-11-18"
|
|
||||||
aliases:
|
|
||||||
- "/doc/permalinks/"
|
|
||||||
groups: ["extras"]
|
|
||||||
groups_weight: 30
|
|
||||||
notoc: true
|
|
||||||
---
|
|
||||||
```
|
|
||||||
|
|
||||||
Here is the corresponding code inside of the template:
|
|
||||||
|
|
||||||
{{ if not .Params.notoc }}
|
|
||||||
<div id="toc" class="well col-md-4 col-sm-6">
|
|
||||||
{{ .TableOfContents }}
|
|
||||||
</div>
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Using Site (config) Parameters
|
|
||||||
In your top-level configuration file (eg, `config.yaml`) you can define site
|
|
||||||
parameters, which are values which will be available to you in chrome.
|
|
||||||
|
|
||||||
For instance, you might declare:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
params:
|
|
||||||
CopyrightHTML: "Copyright © 2013 John Doe. All Rights Reserved."
|
|
||||||
TwitterUser: "spf13"
|
|
||||||
SidebarRecentLimit: 5
|
|
||||||
```
|
|
||||||
|
|
||||||
Within a footer layout, you might then declare a `<footer>` which is only
|
|
||||||
provided if the `CopyrightHTML` parameter is provided, and if it is given,
|
|
||||||
you would declare it to be HTML-safe, so that the HTML entity is not escaped
|
|
||||||
again. This would let you easily update just your top-level config file each
|
|
||||||
January 1st, instead of hunting through your templates.
|
|
||||||
|
|
||||||
```
|
|
||||||
{{if .Site.Params.CopyrightHTML}}<footer>
|
|
||||||
<div class="text-center">{{.Site.Params.CopyrightHTML | safeHtml}}</div>
|
|
||||||
</footer>{{end}}
|
|
||||||
```
|
|
||||||
|
|
||||||
An alternative way of writing the "if" and then referencing the same value
|
|
||||||
is to use "with" instead. With rebinds the context `.` within its scope,
|
|
||||||
and skips the block if the variable is absent:
|
|
||||||
|
|
||||||
```
|
|
||||||
{{with .Site.Params.TwitterUser}}<span class="twitter">
|
|
||||||
<a href="https://twitter.com/{{.}}" rel="author">
|
|
||||||
<img src="/images/twitter.png" width="48" height="48" title="Twitter: {{.}}"
|
|
||||||
alt="Twitter"></a>
|
|
||||||
</span>{{end}}
|
|
||||||
```
|
|
||||||
|
|
||||||
Finally, if you want to pull "magic constants" out of your layouts, you can do
|
|
||||||
so, such as in this example:
|
|
||||||
|
|
||||||
```
|
|
||||||
<nav class="recent">
|
|
||||||
<h1>Recent Posts</h1>
|
|
||||||
<ul>{{range first .Site.Params.SidebarRecentLimit .Site.Recent}}
|
|
||||||
<li><a href="{{.RelPermalink}}">{{.Title}}</a></li>
|
|
||||||
{{end}}</ul>
|
|
||||||
</nav>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
[go]: https://golang.org/
|
|
||||||
[gohtmltemplate]: https://golang.org/pkg/html/template/
|
|
||||||
@ -1,90 +0,0 @@
|
|||||||
+++
|
|
||||||
title = "Getting Started with Hugo"
|
|
||||||
description = ""
|
|
||||||
tags = [
|
|
||||||
"go",
|
|
||||||
"golang",
|
|
||||||
"hugo",
|
|
||||||
"development",
|
|
||||||
]
|
|
||||||
date = "2014-04-02"
|
|
||||||
categories = [
|
|
||||||
"Development",
|
|
||||||
"golang",
|
|
||||||
]
|
|
||||||
series = ["Hugo 101"]
|
|
||||||
author = "Hugo Authors"
|
|
||||||
+++
|
|
||||||
|
|
||||||
## Step 1. Install Hugo
|
|
||||||
|
|
||||||
Go to [Hugo releases](https://github.com/spf13/hugo/releases) and download the
|
|
||||||
appropriate version for your OS and architecture.
|
|
||||||
|
|
||||||
Save it somewhere specific as we will be using it in the next step.
|
|
||||||
|
|
||||||
More complete instructions are available at [Install Hugo](https://gohugo.io/getting-started/installing/)
|
|
||||||
|
|
||||||
## Step 2. Build the Docs
|
|
||||||
|
|
||||||
Hugo has its own example site which happens to also be the documentation site
|
|
||||||
you are reading right now.
|
|
||||||
|
|
||||||
Follow the following steps:
|
|
||||||
|
|
||||||
1. Clone the [Hugo repository](http://github.com/spf13/hugo)
|
|
||||||
2. Go into the repo
|
|
||||||
3. Run hugo in server mode and build the docs
|
|
||||||
4. Open your browser to http://localhost:1313
|
|
||||||
|
|
||||||
Corresponding pseudo commands:
|
|
||||||
|
|
||||||
git clone https://github.com/spf13/hugo
|
|
||||||
cd hugo
|
|
||||||
/path/to/where/you/installed/hugo server --source=./docs
|
|
||||||
> 29 pages created
|
|
||||||
> 0 tags index created
|
|
||||||
> in 27 ms
|
|
||||||
> Web Server is available at http://localhost:1313
|
|
||||||
> Press ctrl+c to stop
|
|
||||||
|
|
||||||
Once you've gotten here, follow along the rest of this page on your local build.
|
|
||||||
|
|
||||||
## Step 3. Change the docs site
|
|
||||||
|
|
||||||
Stop the Hugo process by hitting Ctrl+C.
|
|
||||||
|
|
||||||
Now we are going to run hugo again, but this time with hugo in watch mode.
|
|
||||||
|
|
||||||
/path/to/hugo/from/step/1/hugo server --source=./docs --watch
|
|
||||||
> 29 pages created
|
|
||||||
> 0 tags index created
|
|
||||||
> in 27 ms
|
|
||||||
> Web Server is available at http://localhost:1313
|
|
||||||
> Watching for changes in /Users/spf13/Code/hugo/docs/content
|
|
||||||
> Press ctrl+c to stop
|
|
||||||
|
|
||||||
|
|
||||||
Open your [favorite editor](http://vim.spf13.com) and change one of the source
|
|
||||||
content pages. How about changing this very file to *fix the typo*. How about changing this very file to *fix the typo*.
|
|
||||||
|
|
||||||
Content files are found in `docs/content/`. Unless otherwise specified, files
|
|
||||||
are located at the same relative location as the url, in our case
|
|
||||||
`docs/content/overview/quickstart.md`.
|
|
||||||
|
|
||||||
Change and save this file.. Notice what happened in your terminal.
|
|
||||||
|
|
||||||
> Change detected, rebuilding site
|
|
||||||
|
|
||||||
> 29 pages created
|
|
||||||
> 0 tags index created
|
|
||||||
> in 26 ms
|
|
||||||
|
|
||||||
Refresh the browser and observe that the typo is now fixed.
|
|
||||||
|
|
||||||
Notice how quick that was. Try to refresh the site before it's finished building. I double dare you.
|
|
||||||
Having nearly instant feedback enables you to have your creativity flow without waiting for long builds.
|
|
||||||
|
|
||||||
## Step 4. Have fun
|
|
||||||
|
|
||||||
The best way to learn something is to play with it.
|
|
||||||
@ -1,158 +0,0 @@
|
|||||||
---
|
|
||||||
author: "Hugo Authors"
|
|
||||||
date: 2014-03-10
|
|
||||||
linktitle: Migrating from Jekyll
|
|
||||||
title: Migrate to Hugo from Jekyll
|
|
||||||
type: posts
|
|
||||||
weight: 10
|
|
||||||
series:
|
|
||||||
- Hugo 101
|
|
||||||
aliases:
|
|
||||||
- /blog/migrate-from-jekyll/
|
|
||||||
---
|
|
||||||
|
|
||||||
## Move static content to `static`
|
|
||||||
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.
|
|
||||||
With Jekyll, something that looked like
|
|
||||||
|
|
||||||
▾ <root>/
|
|
||||||
▾ images/
|
|
||||||
logo.png
|
|
||||||
|
|
||||||
should become
|
|
||||||
|
|
||||||
▾ <root>/
|
|
||||||
▾ static/
|
|
||||||
▾ images/
|
|
||||||
logo.png
|
|
||||||
|
|
||||||
Additionally, you'll want any files that should reside at the root (such as `CNAME`) to be moved to `static`.
|
|
||||||
|
|
||||||
## Create your Hugo configuration file
|
|
||||||
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.
|
|
||||||
|
|
||||||
## Set your configuration publish folder to `_site`
|
|
||||||
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:
|
|
||||||
|
|
||||||
1. Change your submodule to point to map `gh-pages` to public instead of `_site` (recommended).
|
|
||||||
|
|
||||||
git submodule deinit _site
|
|
||||||
git rm _site
|
|
||||||
git submodule add -b gh-pages git@github.com:your-username/your-repo.git public
|
|
||||||
|
|
||||||
2. Or, change the Hugo configuration to use `_site` instead of `public`.
|
|
||||||
|
|
||||||
{
|
|
||||||
..
|
|
||||||
"publishdir": "_site",
|
|
||||||
..
|
|
||||||
}
|
|
||||||
|
|
||||||
## Convert Jekyll templates to Hugo templates
|
|
||||||
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.
|
|
||||||
|
|
||||||
As a single reference data point, converting my templates for [heyitsalex.net](http://heyitsalex.net/) took me no more than a few hours.
|
|
||||||
|
|
||||||
## Convert Jekyll plugins to Hugo shortcodes
|
|
||||||
Jekyll has [plugins](http://jekyllrb.com/docs/plugins/); Hugo has [shortcodes](/doc/shortcodes/). It's fairly trivial to do a port.
|
|
||||||
|
|
||||||
### Implementation
|
|
||||||
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.
|
|
||||||
|
|
||||||
Jekyll's plugin:
|
|
||||||
|
|
||||||
module Jekyll
|
|
||||||
class ImageTag < Liquid::Tag
|
|
||||||
@url = nil
|
|
||||||
@caption = nil
|
|
||||||
@class = nil
|
|
||||||
@link = nil
|
|
||||||
// Patterns
|
|
||||||
IMAGE_URL_WITH_CLASS_AND_CAPTION =
|
|
||||||
IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK = /(\w+)(\s+)((https?:\/\/|\/)(\S+))(\s+)"(.*?)"(\s+)->((https?:\/\/|\/)(\S+))(\s*)/i
|
|
||||||
IMAGE_URL_WITH_CAPTION = /((https?:\/\/|\/)(\S+))(\s+)"(.*?)"/i
|
|
||||||
IMAGE_URL_WITH_CLASS = /(\w+)(\s+)((https?:\/\/|\/)(\S+))/i
|
|
||||||
IMAGE_URL = /((https?:\/\/|\/)(\S+))/i
|
|
||||||
def initialize(tag_name, markup, tokens)
|
|
||||||
super
|
|
||||||
if markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK
|
|
||||||
@class = $1
|
|
||||||
@url = $3
|
|
||||||
@caption = $7
|
|
||||||
@link = $9
|
|
||||||
elsif markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION
|
|
||||||
@class = $1
|
|
||||||
@url = $3
|
|
||||||
@caption = $7
|
|
||||||
elsif markup =~ IMAGE_URL_WITH_CAPTION
|
|
||||||
@url = $1
|
|
||||||
@caption = $5
|
|
||||||
elsif markup =~ IMAGE_URL_WITH_CLASS
|
|
||||||
@class = $1
|
|
||||||
@url = $3
|
|
||||||
elsif markup =~ IMAGE_URL
|
|
||||||
@url = $1
|
|
||||||
end
|
|
||||||
end
|
|
||||||
def render(context)
|
|
||||||
if @class
|
|
||||||
source = "<figure class='#{@class}'>"
|
|
||||||
else
|
|
||||||
source = "<figure>"
|
|
||||||
end
|
|
||||||
if @link
|
|
||||||
source += "<a href=\"#{@link}\">"
|
|
||||||
end
|
|
||||||
source += "<img src=\"#{@url}\">"
|
|
||||||
if @link
|
|
||||||
source += "</a>"
|
|
||||||
end
|
|
||||||
source += "<figcaption>#{@caption}</figcaption>" if @caption
|
|
||||||
source += "</figure>"
|
|
||||||
source
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
Liquid::Template.register_tag('image', Jekyll::ImageTag)
|
|
||||||
|
|
||||||
is written as this Hugo shortcode:
|
|
||||||
|
|
||||||
<!-- image -->
|
|
||||||
<figure {{ with .Get "class" }}class="{{.}}"{{ end }}>
|
|
||||||
{{ with .Get "link"}}<a href="{{.}}">{{ end }}
|
|
||||||
<img src="{{ .Get "src" }}" {{ if or (.Get "alt") (.Get "caption") }}alt="{{ with .Get "alt"}}{{.}}{{else}}{{ .Get "caption" }}{{ end }}"{{ end }} />
|
|
||||||
{{ if .Get "link"}}</a>{{ end }}
|
|
||||||
{{ if or (or (.Get "title") (.Get "caption")) (.Get "attr")}}
|
|
||||||
<figcaption>{{ if isset .Params "title" }}
|
|
||||||
{{ .Get "title" }}{{ end }}
|
|
||||||
{{ if or (.Get "caption") (.Get "attr")}}<p>
|
|
||||||
{{ .Get "caption" }}
|
|
||||||
{{ with .Get "attrlink"}}<a href="{{.}}"> {{ end }}
|
|
||||||
{{ .Get "attr" }}
|
|
||||||
{{ if .Get "attrlink"}}</a> {{ end }}
|
|
||||||
</p> {{ end }}
|
|
||||||
</figcaption>
|
|
||||||
{{ end }}
|
|
||||||
</figure>
|
|
||||||
<!-- image -->
|
|
||||||
|
|
||||||
### Usage
|
|
||||||
I simply changed:
|
|
||||||
|
|
||||||
{% 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/ %}
|
|
||||||
|
|
||||||
to this (this example uses a slightly extended version named `fig`, different than the built-in `figure`):
|
|
||||||
|
|
||||||
{{%/* 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/" */%}}
|
|
||||||
|
|
||||||
As a bonus, the shortcode named parameters are, arguably, more readable.
|
|
||||||
|
|
||||||
## Finishing touches
|
|
||||||
### Fix content
|
|
||||||
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.
|
|
||||||
|
|
||||||
### Clean up
|
|
||||||
You'll want to remove the Jekyll configuration at this point. If you have anything else that isn't used, delete it.
|
|
||||||
|
|
||||||
## A practical example in a diff
|
|
||||||
[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).
|
|
||||||
File diff suppressed because it is too large
Load Diff
@ -1,346 +0,0 @@
|
|||||||
+++
|
|
||||||
title = "(Hu)go Template Primer"
|
|
||||||
description = ""
|
|
||||||
type = "posts"
|
|
||||||
tags = [
|
|
||||||
"go",
|
|
||||||
"golang",
|
|
||||||
"templates",
|
|
||||||
"themes",
|
|
||||||
"development",
|
|
||||||
]
|
|
||||||
date = "2014-04-02"
|
|
||||||
categories = [
|
|
||||||
"Development",
|
|
||||||
"golang",
|
|
||||||
]
|
|
||||||
series = ["Hugo 101"]
|
|
||||||
author = "Hugo Authors"
|
|
||||||
+++
|
|
||||||
|
|
||||||
Hugo uses the excellent [Go][] [html/template][gohtmltemplate] library for
|
|
||||||
its template engine. It is an extremely lightweight engine that provides a very
|
|
||||||
small amount of logic. In our experience that it is just the right amount of
|
|
||||||
logic to be able to create a good static website. If you have used other
|
|
||||||
template systems from different languages or frameworks you will find a lot of
|
|
||||||
similarities in Go templates.
|
|
||||||
|
|
||||||
This document is a brief primer on using Go templates. The [Go docs][gohtmltemplate]
|
|
||||||
provide more details.
|
|
||||||
|
|
||||||
## Introduction to Go Templates
|
|
||||||
|
|
||||||
Go templates provide an extremely simple template language. It adheres to the
|
|
||||||
belief that only the most basic of logic belongs in the template or view layer.
|
|
||||||
One consequence of this simplicity is that Go templates parse very quickly.
|
|
||||||
|
|
||||||
A unique characteristic of Go templates is they are content aware. Variables and
|
|
||||||
content will be sanitized depending on the context of where they are used. More
|
|
||||||
details can be found in the [Go docs][gohtmltemplate].
|
|
||||||
|
|
||||||
## Basic Syntax
|
|
||||||
|
|
||||||
Golang templates are HTML files with the addition of variables and
|
|
||||||
functions.
|
|
||||||
|
|
||||||
**Go variables and functions are accessible within {{ }}**
|
|
||||||
|
|
||||||
Accessing a predefined variable "foo":
|
|
||||||
|
|
||||||
{{ foo }}
|
|
||||||
|
|
||||||
**Parameters are separated using spaces**
|
|
||||||
|
|
||||||
Calling the add function with input of 1, 2:
|
|
||||||
|
|
||||||
{{ add 1 2 }}
|
|
||||||
|
|
||||||
**Methods and fields are accessed via dot notation**
|
|
||||||
|
|
||||||
Accessing the Page Parameter "bar"
|
|
||||||
|
|
||||||
{{ .Params.bar }}
|
|
||||||
|
|
||||||
**Parentheses can be used to group items together**
|
|
||||||
|
|
||||||
{{ if or (isset .Params "alt") (isset .Params "caption") }} Caption {{ end }}
|
|
||||||
|
|
||||||
|
|
||||||
## Variables
|
|
||||||
|
|
||||||
Each Go template has a struct (object) made available to it. In hugo each
|
|
||||||
template is passed either a page or a node struct depending on which type of
|
|
||||||
page you are rendering. More details are available on the
|
|
||||||
[variables](/layout/variables) page.
|
|
||||||
|
|
||||||
A variable is accessed by referencing the variable name.
|
|
||||||
|
|
||||||
<title>{{ .Title }}</title>
|
|
||||||
|
|
||||||
Variables can also be defined and referenced.
|
|
||||||
|
|
||||||
{{ $address := "123 Main St."}}
|
|
||||||
{{ $address }}
|
|
||||||
|
|
||||||
|
|
||||||
## Functions
|
|
||||||
|
|
||||||
Go template ship with a few functions which provide basic functionality. The Go
|
|
||||||
template system also provides a mechanism for applications to extend the
|
|
||||||
available functions with their own. [Hugo template
|
|
||||||
functions](/layout/functions) provide some additional functionality we believe
|
|
||||||
are useful for building websites. Functions are called by using their name
|
|
||||||
followed by the required parameters separated by spaces. Template
|
|
||||||
functions cannot be added without recompiling hugo.
|
|
||||||
|
|
||||||
**Example:**
|
|
||||||
|
|
||||||
{{ add 1 2 }}
|
|
||||||
|
|
||||||
## Includes
|
|
||||||
|
|
||||||
When including another template you will pass to it the data it will be
|
|
||||||
able to access. To pass along the current context please remember to
|
|
||||||
include a trailing dot. The templates location will always be starting at
|
|
||||||
the /layout/ directory within Hugo.
|
|
||||||
|
|
||||||
**Example:**
|
|
||||||
|
|
||||||
{{ template "chrome/header.html" . }}
|
|
||||||
|
|
||||||
|
|
||||||
## Logic
|
|
||||||
|
|
||||||
Go templates provide the most basic iteration and conditional logic.
|
|
||||||
|
|
||||||
### Iteration
|
|
||||||
|
|
||||||
Just like in Go, the Go templates make heavy use of range to iterate over
|
|
||||||
a map, array or slice. The following are different examples of how to use
|
|
||||||
range.
|
|
||||||
|
|
||||||
**Example 1: Using Context**
|
|
||||||
|
|
||||||
{{ range array }}
|
|
||||||
{{ . }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
**Example 2: Declaring value variable name**
|
|
||||||
|
|
||||||
{{range $element := array}}
|
|
||||||
{{ $element }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
**Example 2: Declaring key and value variable name**
|
|
||||||
|
|
||||||
{{range $index, $element := array}}
|
|
||||||
{{ $index }}
|
|
||||||
{{ $element }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
### Conditionals
|
|
||||||
|
|
||||||
If, else, with, or, & and provide the framework for handling conditional
|
|
||||||
logic in Go Templates. Like range, each statement is closed with `end`.
|
|
||||||
|
|
||||||
|
|
||||||
Go Templates treat the following values as false:
|
|
||||||
|
|
||||||
* false
|
|
||||||
* 0
|
|
||||||
* any array, slice, map, or string of length zero
|
|
||||||
|
|
||||||
**Example 1: If**
|
|
||||||
|
|
||||||
{{ if isset .Params "title" }}<h4>{{ index .Params "title" }}</h4>{{ end }}
|
|
||||||
|
|
||||||
**Example 2: If -> Else**
|
|
||||||
|
|
||||||
{{ if isset .Params "alt" }}
|
|
||||||
{{ index .Params "alt" }}
|
|
||||||
{{else}}
|
|
||||||
{{ index .Params "caption" }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
**Example 3: And & Or**
|
|
||||||
|
|
||||||
{{ if and (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}}
|
|
||||||
|
|
||||||
**Example 4: With**
|
|
||||||
|
|
||||||
An alternative way of writing "if" and then referencing the same value
|
|
||||||
is to use "with" instead. With rebinds the context `.` within its scope,
|
|
||||||
and skips the block if the variable is absent.
|
|
||||||
|
|
||||||
The first example above could be simplified as:
|
|
||||||
|
|
||||||
{{ with .Params.title }}<h4>{{ . }}</h4>{{ end }}
|
|
||||||
|
|
||||||
**Example 5: If -> Else If**
|
|
||||||
|
|
||||||
{{ if isset .Params "alt" }}
|
|
||||||
{{ index .Params "alt" }}
|
|
||||||
{{ else if isset .Params "caption" }}
|
|
||||||
{{ index .Params "caption" }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
## Pipes
|
|
||||||
|
|
||||||
One of the most powerful components of Go templates is the ability to
|
|
||||||
stack actions one after another. This is done by using pipes. Borrowed
|
|
||||||
from unix pipes, the concept is simple, each pipeline's output becomes the
|
|
||||||
input of the following pipe.
|
|
||||||
|
|
||||||
Because of the very simple syntax of Go templates, the pipe is essential
|
|
||||||
to being able to chain together function calls. One limitation of the
|
|
||||||
pipes is that they only can work with a single value and that value
|
|
||||||
becomes the last parameter of the next pipeline.
|
|
||||||
|
|
||||||
A few simple examples should help convey how to use the pipe.
|
|
||||||
|
|
||||||
**Example 1 :**
|
|
||||||
|
|
||||||
{{ if eq 1 1 }} Same {{ end }}
|
|
||||||
|
|
||||||
is the same as
|
|
||||||
|
|
||||||
{{ eq 1 1 | if }} Same {{ end }}
|
|
||||||
|
|
||||||
It does look odd to place the if at the end, but it does provide a good
|
|
||||||
illustration of how to use the pipes.
|
|
||||||
|
|
||||||
**Example 2 :**
|
|
||||||
|
|
||||||
{{ index .Params "disqus_url" | html }}
|
|
||||||
|
|
||||||
Access the page parameter called "disqus_url" and escape the HTML.
|
|
||||||
|
|
||||||
**Example 3 :**
|
|
||||||
|
|
||||||
{{ if or (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}}
|
|
||||||
Stuff Here
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
Could be rewritten as
|
|
||||||
|
|
||||||
{{ isset .Params "caption" | or isset .Params "title" | or isset .Params "attr" | if }}
|
|
||||||
Stuff Here
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
|
|
||||||
## Context (aka. the dot)
|
|
||||||
|
|
||||||
The most easily overlooked concept to understand about Go templates is that {{ . }}
|
|
||||||
always refers to the current context. In the top level of your template this
|
|
||||||
will be the data set made available to it. Inside of a iteration it will have
|
|
||||||
the value of the current item. When inside of a loop the context has changed. .
|
|
||||||
will no longer refer to the data available to the entire page. If you need to
|
|
||||||
access this from within the loop you will likely want to set it to a variable
|
|
||||||
instead of depending on the context.
|
|
||||||
|
|
||||||
**Example:**
|
|
||||||
|
|
||||||
{{ $title := .Site.Title }}
|
|
||||||
{{ range .Params.tags }}
|
|
||||||
<li> <a href="{{ $baseurl }}/tags/{{ . | urlize }}">{{ . }}</a> - {{ $title }} </li>
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
Notice how once we have entered the loop the value of {{ . }} has changed. We
|
|
||||||
have defined a variable outside of the loop so we have access to it from within
|
|
||||||
the loop.
|
|
||||||
|
|
||||||
# Hugo Parameters
|
|
||||||
|
|
||||||
Hugo provides the option of passing values to the template language
|
|
||||||
through the site configuration (for sitewide values), or through the meta
|
|
||||||
data of each specific piece of content. You can define any values of any
|
|
||||||
type (supported by your front matter/config format) and use them however
|
|
||||||
you want to inside of your templates.
|
|
||||||
|
|
||||||
|
|
||||||
## Using Content (page) Parameters
|
|
||||||
|
|
||||||
In each piece of content you can provide variables to be used by the
|
|
||||||
templates. This happens in the [front matter](/content/front-matter).
|
|
||||||
|
|
||||||
An example of this is used in this documentation site. Most of the pages
|
|
||||||
benefit from having the table of contents provided. Sometimes the TOC just
|
|
||||||
doesn't make a lot of sense. We've defined a variable in our front matter
|
|
||||||
of some pages to turn off the TOC from being displayed.
|
|
||||||
|
|
||||||
Here is the example front matter:
|
|
||||||
|
|
||||||
```
|
|
||||||
---
|
|
||||||
title: "Permalinks"
|
|
||||||
date: "2013-11-18"
|
|
||||||
aliases:
|
|
||||||
- "/doc/permalinks/"
|
|
||||||
groups: ["extras"]
|
|
||||||
groups_weight: 30
|
|
||||||
notoc: true
|
|
||||||
---
|
|
||||||
```
|
|
||||||
|
|
||||||
Here is the corresponding code inside of the template:
|
|
||||||
|
|
||||||
{{ if not .Params.notoc }}
|
|
||||||
<div id="toc" class="well col-md-4 col-sm-6">
|
|
||||||
{{ .TableOfContents }}
|
|
||||||
</div>
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Using Site (config) Parameters
|
|
||||||
In your top-level configuration file (eg, `config.yaml`) you can define site
|
|
||||||
parameters, which are values which will be available to you in chrome.
|
|
||||||
|
|
||||||
For instance, you might declare:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
params:
|
|
||||||
CopyrightHTML: "Copyright © 2013 John Doe. All Rights Reserved."
|
|
||||||
TwitterUser: "spf13"
|
|
||||||
SidebarRecentLimit: 5
|
|
||||||
```
|
|
||||||
|
|
||||||
Within a footer layout, you might then declare a `<footer>` which is only
|
|
||||||
provided if the `CopyrightHTML` parameter is provided, and if it is given,
|
|
||||||
you would declare it to be HTML-safe, so that the HTML entity is not escaped
|
|
||||||
again. This would let you easily update just your top-level config file each
|
|
||||||
January 1st, instead of hunting through your templates.
|
|
||||||
|
|
||||||
```
|
|
||||||
{{if .Site.Params.CopyrightHTML}}<footer>
|
|
||||||
<div class="text-center">{{.Site.Params.CopyrightHTML | safeHtml}}</div>
|
|
||||||
</footer>{{end}}
|
|
||||||
```
|
|
||||||
|
|
||||||
An alternative way of writing the "if" and then referencing the same value
|
|
||||||
is to use "with" instead. With rebinds the context `.` within its scope,
|
|
||||||
and skips the block if the variable is absent:
|
|
||||||
|
|
||||||
```
|
|
||||||
{{with .Site.Params.TwitterUser}}<span class="twitter">
|
|
||||||
<a href="https://twitter.com/{{.}}" rel="author">
|
|
||||||
<img src="/images/twitter.png" width="48" height="48" title="Twitter: {{.}}"
|
|
||||||
alt="Twitter"></a>
|
|
||||||
</span>{{end}}
|
|
||||||
```
|
|
||||||
|
|
||||||
Finally, if you want to pull "magic constants" out of your layouts, you can do
|
|
||||||
so, such as in this example:
|
|
||||||
|
|
||||||
```
|
|
||||||
<nav class="recent">
|
|
||||||
<h1>Recent Posts</h1>
|
|
||||||
<ul>{{range first .Site.Params.SidebarRecentLimit .Site.Recent}}
|
|
||||||
<li><a href="{{.RelPermalink}}">{{.Title}}</a></li>
|
|
||||||
{{end}}</ul>
|
|
||||||
</nav>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
[go]: https://golang.org/
|
|
||||||
[gohtmltemplate]: https://golang.org/pkg/html/template/
|
|
||||||
@ -1,90 +0,0 @@
|
|||||||
+++
|
|
||||||
title = "Getting Started with Hugo"
|
|
||||||
description = ""
|
|
||||||
tags = [
|
|
||||||
"go",
|
|
||||||
"golang",
|
|
||||||
"hugo",
|
|
||||||
"development",
|
|
||||||
]
|
|
||||||
date = "2014-04-02"
|
|
||||||
categories = [
|
|
||||||
"Development",
|
|
||||||
"golang",
|
|
||||||
]
|
|
||||||
series = ["Hugo 101"]
|
|
||||||
author = "Hugo Authors"
|
|
||||||
+++
|
|
||||||
|
|
||||||
## Step 1. Install Hugo
|
|
||||||
|
|
||||||
Go to [Hugo releases](https://github.com/spf13/hugo/releases) and download the
|
|
||||||
appropriate version for your OS and architecture.
|
|
||||||
|
|
||||||
Save it somewhere specific as we will be using it in the next step.
|
|
||||||
|
|
||||||
More complete instructions are available at [Install Hugo](https://gohugo.io/getting-started/installing/)
|
|
||||||
|
|
||||||
## Step 2. Build the Docs
|
|
||||||
|
|
||||||
Hugo has its own example site which happens to also be the documentation site
|
|
||||||
you are reading right now.
|
|
||||||
|
|
||||||
Follow the following steps:
|
|
||||||
|
|
||||||
1. Clone the [Hugo repository](http://github.com/spf13/hugo)
|
|
||||||
2. Go into the repo
|
|
||||||
3. Run hugo in server mode and build the docs
|
|
||||||
4. Open your browser to http://localhost:1313
|
|
||||||
|
|
||||||
Corresponding pseudo commands:
|
|
||||||
|
|
||||||
git clone https://github.com/spf13/hugo
|
|
||||||
cd hugo
|
|
||||||
/path/to/where/you/installed/hugo server --source=./docs
|
|
||||||
> 29 pages created
|
|
||||||
> 0 tags index created
|
|
||||||
> in 27 ms
|
|
||||||
> Web Server is available at http://localhost:1313
|
|
||||||
> Press ctrl+c to stop
|
|
||||||
|
|
||||||
Once you've gotten here, follow along the rest of this page on your local build.
|
|
||||||
|
|
||||||
## Step 3. Change the docs site
|
|
||||||
|
|
||||||
Stop the Hugo process by hitting Ctrl+C.
|
|
||||||
|
|
||||||
Now we are going to run hugo again, but this time with hugo in watch mode.
|
|
||||||
|
|
||||||
/path/to/hugo/from/step/1/hugo server --source=./docs --watch
|
|
||||||
> 29 pages created
|
|
||||||
> 0 tags index created
|
|
||||||
> in 27 ms
|
|
||||||
> Web Server is available at http://localhost:1313
|
|
||||||
> Watching for changes in /Users/spf13/Code/hugo/docs/content
|
|
||||||
> Press ctrl+c to stop
|
|
||||||
|
|
||||||
|
|
||||||
Open your [favorite editor](http://vim.spf13.com) and change one of the source
|
|
||||||
content pages. How about changing this very file to *fix the typo*. How about changing this very file to *fix the typo*.
|
|
||||||
|
|
||||||
Content files are found in `docs/content/`. Unless otherwise specified, files
|
|
||||||
are located at the same relative location as the url, in our case
|
|
||||||
`docs/content/overview/quickstart.md`.
|
|
||||||
|
|
||||||
Change and save this file.. Notice what happened in your terminal.
|
|
||||||
|
|
||||||
> Change detected, rebuilding site
|
|
||||||
|
|
||||||
> 29 pages created
|
|
||||||
> 0 tags index created
|
|
||||||
> in 26 ms
|
|
||||||
|
|
||||||
Refresh the browser and observe that the typo is now fixed.
|
|
||||||
|
|
||||||
Notice how quick that was. Try to refresh the site before it's finished building. I double dare you.
|
|
||||||
Having nearly instant feedback enables you to have your creativity flow without waiting for long builds.
|
|
||||||
|
|
||||||
## Step 4. Have fun
|
|
||||||
|
|
||||||
The best way to learn something is to play with it.
|
|
||||||
@ -1,158 +0,0 @@
|
|||||||
---
|
|
||||||
author: "Hugo Authors"
|
|
||||||
date: 2014-03-10
|
|
||||||
linktitle: Migrating from Jekyll
|
|
||||||
title: Migrate to Hugo from Jekyll
|
|
||||||
type: posts
|
|
||||||
weight: 10
|
|
||||||
series:
|
|
||||||
- Hugo 101
|
|
||||||
aliases:
|
|
||||||
- /blog/migrate-from-jekyll/
|
|
||||||
---
|
|
||||||
|
|
||||||
## Move static content to `static`
|
|
||||||
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.
|
|
||||||
With Jekyll, something that looked like
|
|
||||||
|
|
||||||
▾ <root>/
|
|
||||||
▾ images/
|
|
||||||
logo.png
|
|
||||||
|
|
||||||
should become
|
|
||||||
|
|
||||||
▾ <root>/
|
|
||||||
▾ static/
|
|
||||||
▾ images/
|
|
||||||
logo.png
|
|
||||||
|
|
||||||
Additionally, you'll want any files that should reside at the root (such as `CNAME`) to be moved to `static`.
|
|
||||||
|
|
||||||
## Create your Hugo configuration file
|
|
||||||
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.
|
|
||||||
|
|
||||||
## Set your configuration publish folder to `_site`
|
|
||||||
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:
|
|
||||||
|
|
||||||
1. Change your submodule to point to map `gh-pages` to public instead of `_site` (recommended).
|
|
||||||
|
|
||||||
git submodule deinit _site
|
|
||||||
git rm _site
|
|
||||||
git submodule add -b gh-pages git@github.com:your-username/your-repo.git public
|
|
||||||
|
|
||||||
2. Or, change the Hugo configuration to use `_site` instead of `public`.
|
|
||||||
|
|
||||||
{
|
|
||||||
..
|
|
||||||
"publishdir": "_site",
|
|
||||||
..
|
|
||||||
}
|
|
||||||
|
|
||||||
## Convert Jekyll templates to Hugo templates
|
|
||||||
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.
|
|
||||||
|
|
||||||
As a single reference data point, converting my templates for [heyitsalex.net](http://heyitsalex.net/) took me no more than a few hours.
|
|
||||||
|
|
||||||
## Convert Jekyll plugins to Hugo shortcodes
|
|
||||||
Jekyll has [plugins](http://jekyllrb.com/docs/plugins/); Hugo has [shortcodes](/doc/shortcodes/). It's fairly trivial to do a port.
|
|
||||||
|
|
||||||
### Implementation
|
|
||||||
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.
|
|
||||||
|
|
||||||
Jekyll's plugin:
|
|
||||||
|
|
||||||
module Jekyll
|
|
||||||
class ImageTag < Liquid::Tag
|
|
||||||
@url = nil
|
|
||||||
@caption = nil
|
|
||||||
@class = nil
|
|
||||||
@link = nil
|
|
||||||
// Patterns
|
|
||||||
IMAGE_URL_WITH_CLASS_AND_CAPTION =
|
|
||||||
IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK = /(\w+)(\s+)((https?:\/\/|\/)(\S+))(\s+)"(.*?)"(\s+)->((https?:\/\/|\/)(\S+))(\s*)/i
|
|
||||||
IMAGE_URL_WITH_CAPTION = /((https?:\/\/|\/)(\S+))(\s+)"(.*?)"/i
|
|
||||||
IMAGE_URL_WITH_CLASS = /(\w+)(\s+)((https?:\/\/|\/)(\S+))/i
|
|
||||||
IMAGE_URL = /((https?:\/\/|\/)(\S+))/i
|
|
||||||
def initialize(tag_name, markup, tokens)
|
|
||||||
super
|
|
||||||
if markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK
|
|
||||||
@class = $1
|
|
||||||
@url = $3
|
|
||||||
@caption = $7
|
|
||||||
@link = $9
|
|
||||||
elsif markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION
|
|
||||||
@class = $1
|
|
||||||
@url = $3
|
|
||||||
@caption = $7
|
|
||||||
elsif markup =~ IMAGE_URL_WITH_CAPTION
|
|
||||||
@url = $1
|
|
||||||
@caption = $5
|
|
||||||
elsif markup =~ IMAGE_URL_WITH_CLASS
|
|
||||||
@class = $1
|
|
||||||
@url = $3
|
|
||||||
elsif markup =~ IMAGE_URL
|
|
||||||
@url = $1
|
|
||||||
end
|
|
||||||
end
|
|
||||||
def render(context)
|
|
||||||
if @class
|
|
||||||
source = "<figure class='#{@class}'>"
|
|
||||||
else
|
|
||||||
source = "<figure>"
|
|
||||||
end
|
|
||||||
if @link
|
|
||||||
source += "<a href=\"#{@link}\">"
|
|
||||||
end
|
|
||||||
source += "<img src=\"#{@url}\">"
|
|
||||||
if @link
|
|
||||||
source += "</a>"
|
|
||||||
end
|
|
||||||
source += "<figcaption>#{@caption}</figcaption>" if @caption
|
|
||||||
source += "</figure>"
|
|
||||||
source
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
Liquid::Template.register_tag('image', Jekyll::ImageTag)
|
|
||||||
|
|
||||||
is written as this Hugo shortcode:
|
|
||||||
|
|
||||||
<!-- image -->
|
|
||||||
<figure {{ with .Get "class" }}class="{{.}}"{{ end }}>
|
|
||||||
{{ with .Get "link"}}<a href="{{.}}">{{ end }}
|
|
||||||
<img src="{{ .Get "src" }}" {{ if or (.Get "alt") (.Get "caption") }}alt="{{ with .Get "alt"}}{{.}}{{else}}{{ .Get "caption" }}{{ end }}"{{ end }} />
|
|
||||||
{{ if .Get "link"}}</a>{{ end }}
|
|
||||||
{{ if or (or (.Get "title") (.Get "caption")) (.Get "attr")}}
|
|
||||||
<figcaption>{{ if isset .Params "title" }}
|
|
||||||
{{ .Get "title" }}{{ end }}
|
|
||||||
{{ if or (.Get "caption") (.Get "attr")}}<p>
|
|
||||||
{{ .Get "caption" }}
|
|
||||||
{{ with .Get "attrlink"}}<a href="{{.}}"> {{ end }}
|
|
||||||
{{ .Get "attr" }}
|
|
||||||
{{ if .Get "attrlink"}}</a> {{ end }}
|
|
||||||
</p> {{ end }}
|
|
||||||
</figcaption>
|
|
||||||
{{ end }}
|
|
||||||
</figure>
|
|
||||||
<!-- image -->
|
|
||||||
|
|
||||||
### Usage
|
|
||||||
I simply changed:
|
|
||||||
|
|
||||||
{% 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/ %}
|
|
||||||
|
|
||||||
to this (this example uses a slightly extended version named `fig`, different than the built-in `figure`):
|
|
||||||
|
|
||||||
{{%/* 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/" */%}}
|
|
||||||
|
|
||||||
As a bonus, the shortcode named parameters are, arguably, more readable.
|
|
||||||
|
|
||||||
## Finishing touches
|
|
||||||
### Fix content
|
|
||||||
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.
|
|
||||||
|
|
||||||
### Clean up
|
|
||||||
You'll want to remove the Jekyll configuration at this point. If you have anything else that isn't used, delete it.
|
|
||||||
|
|
||||||
## A practical example in a diff
|
|
||||||
[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).
|
|
||||||
Loading…
Reference in New Issue
Block a user