phoenix/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-07-01 07:24:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Squashed 'docs/' changes from b0470688..73f355ce

Browse source 
73f355ce Update theme
83ff50c2 Use example.com in examples
71292134 Add alias news > release-notes
2e15f642 Update theme
8eef09d2 Add Pygments configuration
572b9e75 Clean up the code shortcode use
a1b2fd3b Remove the code fence language codes
1473b1d9 Remove redundant text
b92c2042 Update theme
8f439c28 Edit contributing section in README
8bcf8a19 Add contributing section to README
4c44ee1c Fix broken content file
2bdc7710 Clarify .Data.Pages sorting in lists.md
092271c2 Use infinitive mood for main titles
b9b8abef Update theme to reflect change to home page content
b897b71b Change copy to use sentence case
fd675ee5 Enable RSS feed for sections
060a5e27 Correct movie title in taxonomies.md
6a5ca96a Update displayed site name for Hub
22f4b7a4 Add example of starting up the local server
d9612cb3 Update theme
a8c3988a Update theme
4198189d Update theme
12d6b016 Update theme
2b1c4197 Update theme
b6d90a1e Fix News release titles
cfe751db Add some build info to README

git-subtree-dir: docs
git-subtree-split: 73f355ce0dd88d032062ea70067431ab980cdd8d
This commit is contained in:
Bjørn Erik Pedersen 2017-07-21 11:00:08 +02:00
parent 6dbde8d731
commit 2c0d1ccdcd
146 changed files with 1037 additions and 1443 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -2,12 +2,37 @@
Documentation site for [Hugo](https://github.com/gohugoio/hugo), the very fast and flexible static site generator built with love in GoLang.
## Branches
## Contributing
* The `master` branch is the **current Hugo version** and will be auto-deployed to [gohugo.io/](https://gohugo.io/).
* Anything not relevant to the current Hugo version goes into the `dev` branch.
* Changes in [hugo/docs](https://github.com/gohugoio/hugo/tree/master/docs) will, in general, be merged once every release, but can be manually merged/cherry picked if needed. This goes both ways.
* All contributions that is not tightly coupled with code changes, should be made directly to `hugoDocs`.
* But we also merge PRs into [hugo/docs](https://github.com/gohugoio/hugo/tree/master/docs), but preferably changes that is related to the code in the PR itself
We welcome contributions to Hugo of any kind including documentation, suggestions, bug reports, pull requests etc. Also check out our [contribution guide](https://gohugo.io/contribute/documentation/). We would love to hear from you.
To summarize, we have two branches in this repository: `master` (current Hugo) and `dev` (next Hugo).
Note that this repository contains solely the documentation for Hugo. For contributions that aren't documentation-related please refer to the [hugo](https://github.com/gohugoio/hugo) repository.
*Pull requests shall **only** contain changes to the actual documentation. However, changes on the code base of Hugo **and** the documentation shall be a single, atomic pull request in the [hugo](https://github.com/gohugoio/hugo) repository.*
## Build
To view the documentation site locally, you need to clone this repository with submodules:
```bash
git clone --recursive https://github.com/gohugoio/hugoDocs.git
```
Or if you already have a clone locally:
```bash
git submodule update --init
```
Also note that the documentation version for a given version of Hugo can also be found in the `/docs` sub-folder of the [Hugo source repository](https://github.com/gohugoio/hugo).
Then to view the docs in your browser, run Hugo and open up the link:
```bash
hugo serve
Started building sites ...
.
.
Serving pages from memory
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop
```

9
config.toml
View file

@ -16,8 +16,17 @@ pluralizeListTitles = false
# We do redirects via Netlify's _redirects file, generated by Hugo (see "outputs" below).
disableAliases = true
# Highlighting config (Pygments)
# It is (currently) not in use, but you can do ```go in a content file if you want to.
pygmentsCodeFences = true
# See https://help.farbox.com/pygments.html
pygmentsStyle = "friendly"
[outputs]
home = [ "HTML", "RSS", "REDIR" ]
section = [ "HTML", "RSS"]
[mediaTypes]
[mediaTypes."text/netlify"]

2
content/_index.md
View file

@ -29,7 +29,7 @@ features:
- heading: Custom Outputs
image_path: /images/icon-custom-outputs.svg
tagline: HTML not Enough?
tagline: HTML not enough?
copy: Hugo allows you to output your content in multiple formats, including JSON or AMP, and makes it easy to create your own.
sections:
- heading: "100s of Themes"

6
content/about/license.md
View file

@ -148,8 +148,7 @@ _END OF TERMS AND CONDITIONS_
To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets `[]` replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same “printed page” as the copyright notice for easier identification within third-party archives.
{{% code file="apache-notice.txt" download="apache-notice.txt" %}}
```
{{< code file="apache-notice.txt" download="apache-notice.txt" >}}
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
@ -163,5 +162,4 @@ distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
{{% /code %}}
{{< /code >}}

44
content/content-management/archetypes.md
View file

@ -31,17 +31,15 @@ See above
The `hugo new` generator for archetypes assumes your working directory is the content folder at the root of your project. Hugo is able to infer the appropriate archetype by assuming the content type from the content section passed to the CLI command:
```bash
```
hugo new <content-section>/<file-name.md>
```
We can use this pattern to create a new `.md` file in the `posts` section:
{{% code file="archetype-example.sh" %}}
```bash
{{< code file="archetype-example.sh" >}}
hugo new posts/my-first-post.md
```
{{% /code %}}
{{< /code >}}
{{% note "Override Content Type in a New File" %}}
To override the content type Hugo infers from `[content-section]`, add the `--kind` flag to the end of the `hugo new` command.
@ -50,7 +48,7 @@ To override the content type Hugo infers from `[content-section]`, add the `--ki
Running this command in a new site that does not have default or custom archetypes will create the following file:
{{% output file="content/posts/my-first-post.md" %}}
```toml
```
+++
date = "2017-02-01T19:20:04-07:00"
title = "my first post"
@ -100,14 +98,12 @@ When you create a new Hugo project using `hugo new site`, you'll notice that Hug
The following examples are from a site that's using `tags` and `categories` as [taxonomies][]. If we assume that all content files will require these two key-values, we can create a `default.md` archetype that *extends* Hugo's base archetype. In this example, we are including "golang" and "hugo" as tags and "web development" as a category.
{{% code file="archetypes/default.md" %}}
```toml
{{< code file="archetypes/default.md" >}}
+++
tags = ["golang", "hugo"]
categories = ["web development"]
+++
```
{{% /code %}}
{{< /code >}}
{{% warning "EOL Characters in Text Editors"%}}
If you get an `EOF error` when using `hugo new`, add a carriage return after the closing `+++` or `---` for your TOML or YAML front matter, respectively. (See the [troubleshooting article on EOF errors](/troubleshooting/eof-error/) for more information.)
@ -117,16 +113,14 @@ If you get an `EOF error` when using `hugo new`, add a carriage return after the
With an `archetypes/default.md` in place, we can use the CLI to create a new post in the `posts` content section:
{{% code file="new-post-from-default.sh" %}}
```bash
{{< code file="new-post-from-default.sh" >}}
$ hugo new posts/my-new-post.md
```
{{% /code %}}
{{< /code >}}
Hugo then creates a new markdown file with the following front matter:
{{% output file="content/posts/my-new-post.md" %}}
```toml
```
+++
categories = ["web development"]
date = "2017-02-01T19:20:04-07:00"
@ -148,30 +142,26 @@ Suppose your site's `posts` section requires more sophisticated front matter tha
### Create a Custom Archetype
{{% code file="archetypes/posts.md"%}}
```toml
{{< code file="archetypes/posts.md">}}
+++
description = ""
tags = ""
categories = ""
+++
```
{{% /code %}}
{{< /code >}}
### Use a Custom Archetype
With an `archetypes/posts.md` in place, you can use the Hugo CLI to create a new post with your preconfigured front matter in the `posts` content section:
{{% code file="new-post-from-custom.sh" %}}
```bash
{{< code file="new-post-from-custom.sh" >}}
$ hugo new posts/post-from-custom.md
```
{{% /code %}}
{{< /code >}}
This time, Hugo recognizes our custom `archetypes/posts.md` archetype and uses it instead of `archetypes/default.md`. The generated file will now include the full list of front matter parameters, as well as the base archetype's `title` and `date`:
{{% output file="content/posts/post-from-custom-archetype.md" %}}
```toml
```
+++
categories = ""
date = 2017-02-13T17:24:43-08:00
@ -186,11 +176,9 @@ title = "post from custom archetype"
As an example of archetypes in practice, the following is the `functions` archetype from the Hugo docs:
{{% code file="archetypes/functions.md" %}}
```yaml
{{< code file="archetypes/functions.md" >}}
{{< readfile file="/themes/gohugoioTheme/archetypes/functions.md" >}}
```
{{% /code %}}
{{< /code >}}
{{% note %}}
The preceding archetype is kept up to date with every Hugo build by using Hugo's [`readFile` function](/functions/readfile/). For similar examples, see [Local File Templates](/templates/files/).

32
content/content-management/authors.md
View file

@ -30,8 +30,7 @@ You can create a profile containing metadata for each author on your website. Th
Let's suppose Alice Allison is a blogger. A simple unique identifier would be `alice`. Now, we have to create a file called `alice.toml` in the `data/_authors/` directory. The following example is the standardized template written in TOML:
{{% code file="data/_authors/alice.toml" %}}
```toml
{{< code file="data/_authors/alice.toml" >}}
givenName = "Alice" # or firstName as alias
familyName = "Allison" # or lastName as alias
displayName = "Alice Allison"
@ -50,8 +49,7 @@ weight = 10
[params]
random = "whatever you want"
```
{{% /code %}}
{{< /code >}}
All variables are optional but it's advised to fill all important ones (e.g. names and biography) because themes can vary in their usage.
@ -67,7 +65,7 @@ The `params` section can contain arbitrary data much like the same-named section
Earlier it was mentioned that content can be associated with an author through their corresponding identifier. In our case, blogger Alice has the identifier `alice`. In the front matter of a content file, you can create a list of identifiers and assign it to the `authors` variable. Here are examples for `alice` using YAML and TOML, respectively.
```yaml
```
---
title: Why Hugo is so Awesome
date: 2016-08-22T14:27:502:00
@ -77,7 +75,7 @@ authors: ["alice"]
Nothing to read here. Move along...
```
```toml
```
+++
title = Why Hugo is so Awesome
date = "2016-08-22T14:27:502:00"
@ -116,8 +114,7 @@ This is can be done with the `.Social.URL` function. Its only parameter is the n
Most articles feature a small section with information about the author at the end. Let's create one containing the author's name, a thumbnail, a (summarized) biography and links to all social networks:
{{% code file="layouts/partials/author-info.html" download="author-info.html" %}}
```html
{{< code file="layouts/partials/author-info.html" download="author-info.html" >}}
{{ with .Author }}
<h3>{{ .DisplayName }}</h3>
<img src="{{ .Thumbnail | absURL }}" alt="{{ .DisplayName }}">
@ -128,8 +125,7 @@ Most articles feature a small section with information about the author at the e
{{ end }}
</ul>
{{ end }}
```
{{% /code %}}
{{< /code >}}
## Who Published What?
@ -137,12 +133,12 @@ That question can be answered with a list of all authors and another list contai
In order to let Hugo know that we want to group content based on their author, we have to create a new taxonomy called `author` (the name corresponds to the variable in the front matter). Here is the snippet in a `config.yaml` and `config.toml`, respectively:
```yaml
```
taxonomies:
author: authors
```
```toml
```
[taxonomies]
author = "authors"
```
@ -152,8 +148,7 @@ taxonomies:
In the next step we can create a template to list all authors of your website. Later, the list can be accessed at `www.example.com/authors/`. Create a new template in the `layouts/taxonomy/` directory called `authors.term.html`. This template will be exclusively used for this taxonomy.
{{% code file="layouts/taxonomy/author.term.html" download="author.term.html" %}}
```html
{{< code file="layouts/taxonomy/author.term.html" download="author.term.html" >}}
<ul>
{{ range $author, $v := .Data.Terms }}
{{ $profile := $.Authors.Get $author }}
@ -164,8 +159,7 @@ In the next step we can create a template to list all authors of your website. L
</li>
{{ end }}
</ul>
```
{{% /code %}}
{{< /code >}}
`.Data.Terms` contains the identifiers of all authors and we can range over it to create a list with all author names. The `$profile` variable gives us access to the profile of the current author. This allows you to generate a nice info box with a thumbnail, a biography and social media links, like at the [end of a blog post](#linking-social-network-accounts-automatically).
@ -175,15 +169,13 @@ Last but not least, we have to create the second list that contains all publicat
The layout for this page can be defined in the template `layouts/taxonomy/author.html`.
{{% code file="layouts/taxonomy/author.html" download="author.html" %}}
```html
{{< code file="layouts/taxonomy/author.html" download="author.html" >}}
{{ range .Data.Pages }}
<h2><a href="{{ .Permalink }}">{{ .Title }}</a></h2>
<span>written by {{ .Author.DisplayName }}</span>
{{ .Summary }}
{{ end }}
```
{{% /code %}}
{{< /code >}}
The example above generates a simple list of all posts written by a single author. Inside the loop you've access to the complete set of [page variables][pagevars]. Therefore, you can add additional information about the current posts like the publishing date or the tags.

4
content/content-management/comments.md
View file

@ -29,11 +29,11 @@ Hugo comes with all the code you need to load Disqus into your templates. Before
Disqus comments require you set a single value in your [site's configuration file][configuration]. The following show the configuration variable in a `config.toml` and `config.yml`, respectively:
```toml
```
disqusShortname = "yourdiscussshortname"
```
```yaml
```
disqusShortname: "yourdiscussshortname"
```

24
content/content-management/cross-references.md
View file

@ -20,7 +20,7 @@ toc: true
## Use `ref` and `relref`
```md
```
{{</* ref "document" */>}}
{{</* ref "#anchor" */>}}
{{</* ref "document#anchor" */>}}
@ -35,14 +35,14 @@ The single parameter to `ref` is a string with a content `documentname` (e.g., `
The `documentname` is the name of a document, including the format extension; this may be just the filename, or the relative path from the `content/` directory. With a document `content/blog/post.md`, either format will produce the same result:
```md
```
{{</* relref "blog/post.md" */>}} => `/blog/post/`
{{</* relref "post.md" */>}} => `/blog/post/`
```
If you have the same filename used across multiple sections, you should only use the relative path format; otherwise, the behavior will be `undefined`. This is best illustrated with an example `content` directory:
```bash
```
.
└── content
├── events
@ -57,16 +57,14 @@ If you have the same filename used across multiple sections, you should only use
To be sure to get the correct reference in this case, use the full path:
{{% code file="content/meta/my-article.md" copy="false" %}}
```md
{{< code file="content/meta/my-article.md" copy="false" >}}
{{</* relref "events/my-birthday.md" */>}} => /events/my-birthday/
```
{{% /code %}}
{{< /code >}}
{{< todo >}}Remove this warning when https://github.com/gohugoio/hugo/issues/3703 is released.{{< /todo >}}
A relative document name must *not* begin with a slash (`/`).
```md
```
{{</* relref "/events/my-birthday.md" */>}} => ""
```
@ -82,14 +80,14 @@ If the page exists in multiple [output formats][], `ref` or `relref` can be used
When an `anchor` is provided by itself, the current page’s unique identifier will be appended; when an `anchor` is provided appended to `documentname`, the found page's unique identifier will be appended:
```md
```
{{</* relref "#anchors" */>}} => #anchors:9decaf7
{{</* relref "about-hugo/hugo-features.md#content" */>}} => /blog/post/#who:badcafe
```
The above examples render as follows for this very page as well as a reference to the "Content" heading in the Hugo docs features pageyoursite
```md
```
{{</* relref "#who" */>}} => #who:9decaf7
{{</* relref "blog/post.md#who" */>}} => /blog/post/#who:badcafe
```
@ -98,8 +96,8 @@ More information about document unique identifiers and headings can be found [be
### Examples
* `{{</* ref "blog/post.md" */>}}` => `http://yoursite.com/blog/post/`
* `{{</* ref "post.md#tldr" */>}}` => `http://yoursite.com/blog/post/#tldr:caffebad`
* `{{</* ref "blog/post.md" */>}}` => `http://example.com/blog/post/`
* `{{</* ref "post.md#tldr" */>}}` => `http://example.com/blog/post/#tldr:caffebad`
* `{{</* relref "post.md" */>}}` => `/blog/post/`
* `{{</* relref "blog/post.md#tldr" */>}}` => `/blog/post/#tldr:caffebad`
* `{{</* ref "#tldr" */>}}` => `#tldr:badcaffe`
@ -113,7 +111,7 @@ Ensuring heading uniqueness across the site is accomplished with a unique identi
`ref` and `relref` were added so you can make these reference links without having to know the document’s unique identifier. (The links in document tables of contents are automatically up-to-date with this value.)
```md
```
{{</* relref "content-management/cross-references.md#hugo-heading-anchors" */>}}
/content-management/cross-references/#hugo-heading-anchors:77cd9ea530577debf4ce0f28c8dca242
```

28
content/content-management/formats.md
View file

@ -41,20 +41,18 @@ Hugo supports [GitHub-styled task lists (i.e., TODO lists)][gfmtasks] for the Bl
#### Example Task List Input
{{% code file="content/my-to-do-list.md" %}}
```markdown
{{< code file="content/my-to-do-list.md" >}}
- [ ] a task list item
- [ ] list syntax required
- [ ] incomplete
- [x] completed
```
{{% /code %}}
{{< /code >}}
#### Example Task List Output
The preceding markdown produces the following HTML in your rendered website:
```html
```
<ul class="task-list">
<li><input type="checkbox" disabled="" class="task-list-item"> a task list item</li>
<li><input type="checkbox" disabled="" class="task-list-item"> list syntax required</li>
@ -98,7 +96,7 @@ As Hugo ships with Mmark, using the syntax is as easy as changing the extension
In the event that you want to only use Mmark in specific files, you can also define the Mmark syntax in your content's front matter:
```yaml
```
---
title: My Post
date: 2017-04-01
@ -120,12 +118,10 @@ This is not an introduction into actually using MathJax to render typeset mathem
The first step is to enable MathJax on pages that you would like to have typeset math. There are multiple ways to do this (adventurous readers can consult the [Loading and Configuring](http://docs.mathjax.org/en/latest/configuration.html) section of the MathJax documentation for additional methods of including MathJax), but the easiest way is to use the secure MathJax CDN by include a `<script>` tag for the officially recommended secure CDN ([cdn.js.com](https://cdnjs.com)):
{{% code file="add-mathjax-to-page.html" %}}
```html
{{< code file="add-mathjax-to-page.html" >}}
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>
```
{{% /code %}}
{{< /code >}}
One way to ensure that this code is included in all pages is to put it in one of the templates that live in the `layouts/partials/` directory. For example, I have included this in the bottom of my template `footer.html` because I know that the footer will be included in every page of my website.
@ -149,8 +145,7 @@ There are multiple ways to remedy this problem. One solution is to simply escape
Another option is to tell Markdown to treat the MathJax code as verbatim code and not process it. One way to do this is to wrap the math expression inside a `<div>` `</div>` block. Markdown would ignore these sections and they would get passed directly on to MathJax and processed correctly. This works great for display style mathematics, but for inline math expressions the line break induced by the `<div>` is not acceptable. The syntax for instructing Markdown to treat inline text as verbatim is by wrapping it in backticks (`` ` ``). You might have noticed, however, that the text included in between backticks is rendered differently than standard text (on this site these are items highlighted in red). To get around this problem, we could create a new CSS entry that would apply standard styling to all inline verbatim text that includes MathJax code. Below I will show the HTML and CSS source that would accomplish this (note this solution was adapted from [this blog post](http://doswa.com/2011/07/20/mathjax-in-markdown.html)---all credit goes to the original author).
{{% code file="mathjax-markdown-solution.html" %}}
```js
{{< code file="mathjax-markdown-solution.html" >}}
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
tex2jax: {
@ -176,15 +171,13 @@ MathJax.Hub.Config({
}
});
</script>
```
{{% /code %}}
{{< /code >}}
As before, this content should be included in the HTML source of each page that will be using MathJax. The next code snippet contains the CSS that is used to have verbatim MathJax blocks render with the same font style as the body of the page.
{{% code file="mathjax-style.css" %}}
```css
{{< code file="mathjax-style.css" >}}
code.has-jax {
font: inherit;
font-size: 100%;
@ -192,8 +185,7 @@ code.has-jax {
border: inherit;
color: #515151;
}
```
{{% /code %}}
{{< /code >}}
In the CSS snippet, notice the line `color: #515151;`. `#515151` is the value assigned to the `color` attribute of the `body` class in my CSS. In order for the equations to fit in with the body of a web page, this value should be the same as the color of the body.

8
content/content-management/front-matter.md
View file

@ -34,7 +34,7 @@ JSON
### TOML Example
```toml
```
+++
title = "spf13-vim 3.0 release and new website"
description = "spf13-vim is a cross platform distribution of vim plugins and resources for Vim."
@ -50,7 +50,7 @@ slug = "spf13-vim-3-0-release-and-new-website"
### YAML Example
```yaml
```
---
title: "spf13-vim 3.0 release and new website"
description: "spf13-vim is a cross platform distribution of vim plugins and resources for Vim."
@ -66,7 +66,7 @@ slug: "spf13-vim-3-0-release-and-new-website"
### JSON Example
```json
```
{
"title": "spf13-vim 3.0 release and new website",
"description": "spf13-vim is a cross platform distribution of vim plugins and resources for Vim.",
@ -154,7 +154,7 @@ You can add fields to your front matter arbitrarily to meet your needs. These us
The following fields can be accessed via `.Params.include_toc` and `.Params.show_comments`, respectively. The [Variables][] section provides more information on using Hugo's page- and site-level variables in your templates.
```yaml
```
include_toc: true
show_comments: false
```

18
content/content-management/menus.md
View file

@ -88,7 +88,7 @@ If all you need to do is add an entry to a menu, the simple form works well.
#### A Single Menu
```yaml
```
---
menu: "main"
---
@ -96,7 +96,7 @@ menu: "main"
#### Multiple Menus
```yaml
```
---
menu: ["main", "footer"]
---
@ -105,7 +105,7 @@ menu: ["main", "footer"]
#### Advanced
```yaml
```
---
menu:
docs:
@ -120,8 +120,7 @@ You can also add entries to menus that aren’t attached to a piece of content.
Here’s an example snippet pulled from a `config.toml`:
{{% code file="config.toml" %}}
```toml
{{< code file="config.toml" >}}
[[menu.main]]
name = "about hugo"
pre = "<i class='fa fa-heart'></i>"
@ -133,13 +132,11 @@ Here’s an example snippet pulled from a `config.toml`:
pre = "<i class='fa fa-road'></i>"
weight = -100
url = "/getting-started/"
```
{{% /code %}}
{{< /code >}}
Here's the equivalent snippet in a `config.yaml`:
{{% code file="config.yml" %}}
```yaml
{{< code file="config.yml" >}}
---
menu:
docs:
@ -153,8 +150,7 @@ menu:
Weight: -100
URL: "/getting-started/"
---
```
{{% /code %}}
{{< /code >}}
{{% note %}}
The URLs must be relative to the context root. If the `baseURL` is `http://example.com/mysite/`, then the URLs in the menu must not include the context root `mysite`. Using an absolute URL will overide the baseURL. If the value used for `URL` in the above example is `http://subdomain.example.com/`, the output will be `http://subdomain.example.com`.

26
content/content-management/multilingual.md
View file

@ -23,8 +23,7 @@ You should define the available languages in a `Languages` section in your site
The following is an example of a TOML site configuration for a multilingual Hugo project:
{{% code file="config.toml" download="config.toml" %}}
```toml
{{< code file="config.toml" download="config.toml" >}}
DefaultContentLanguage = "en"
copyright = "Everything is mine"
@ -46,8 +45,7 @@ weight = 2
linkedin = "lien-francais"
[Languages.fr.navigation]
help = "Aide"
```
{{% /code %}}
{{< /code >}}
Anything not defined in a `[Languages]` block will fall back to the global
value for that key (e.g., `copyright` for the English [`en`] language).
@ -66,8 +64,7 @@ Only the obvious non-global options can be overridden per language. Examples of
Taxonomies and [Blackfriday configuration][config] can also be set per language:
{{% code file="bf-config.toml" %}}
```toml
{{< code file="bf-config.toml" >}}
[Taxonomies]
tag = "tags"
@ -87,8 +84,7 @@ weight = 2
title = "Français"
[Languages.fr.Taxonomies]
plaque = "plaques"
```
{{% /code %}}
{{< /code >}}
## Translate Your Content
@ -110,7 +106,7 @@ By having the same *base filename*, the content pieces are linked together as tr
If you need distinct URLs per language, you can set the slug in the non-default language file. For example, you can define a custom slug for a French translation in the front matter of `content/about.fr.md` as follows:
```yaml
```
slug: "a-propos"
```
@ -127,8 +123,7 @@ We will fix this in https://github.com/gohugoio/hugo/issues/2699
To create a list of links to translated content, use a template similar to the following:
{{% code file="layouts/partials/i18nlist.html" %}}
```html
{{< code file="layouts/partials/i18nlist.html" >}}
{{ if .IsTranslated }}
<h4>{{ i18n "translations" }}</h4>
<ul>
@ -139,8 +134,7 @@ To create a list of links to translated content, use a template similar to the f
{{ end}}
</ul>
{{ end }}
```
{{% /code %}}
{{< /code >}}
The above can be put in a `partial` (i.e., inside `layouts/partials/`) and included in any template, be it for a [single content page][contenttemplate] or the [homepage][]. It will not print anything if there are no translations for a given page, or if there are translations---in the case of the homepage, section listing, etc.---a site with only render one language.
@ -191,7 +185,7 @@ And then in the template:
```
To track down missing translation strings, run Hugo with the `--i18n-warnings` flag:
```bash
```
hugo --i18n-warnings | grep i18n
i18n|MISSING_TRANSLATION|en|wordCount
```
@ -229,7 +223,7 @@ This technique extracts the day, month and year by specifying ``.Date.Day``, ``.
You can define your menus for each language independently. The [creation of a menu][menus] works analogous to earlier versions of Hugo, except that they have to be defined in their language-specific block in the configuration file:
```toml
```
defaultContentLanguage = "en"
[languages.en]
@ -254,7 +248,7 @@ weight = 0
The rendering of the main navigation works as usual. `.Site.Menus` will just contain the menu of the current language. Pay attention to the generation of the menu links. `absLangURL` takes care that you link to the correct locale of your website. Otherwise, both menu entries would link to the English version as the default content language that resides in the root directory.
```html
```
<ul>
{{- $currentPage := . -}}
{{ range .Site.Menus.main -}}

56
content/content-management/organization.md
View file

@ -34,20 +34,20 @@ While Hugo supports content nested at any level, the top levels (i.e. `content/<
.
└── content
└── about
| └── _index.md // <- http://yoursite.com/about/
| └── _index.md // <- http://example.com/about/
├── post
| ├── firstpost.md // <- http://yoursite.com/post/firstpost/
| ├── firstpost.md // <- http://example.com/post/firstpost/
| ├── happy
| | └── ness.md // <- http://yoursite.com/post/happy/ness/
| └── secondpost.md // <- http://yoursite.com/post/secondpost/
| | └── ness.md // <- http://example.com/post/happy/ness/
| └── secondpost.md // <- http://example.com/post/secondpost/
└── quote
├── first.md // <- http://yoursite.com/quote/first/
└── second.md // <- http://yoursite.com/quote/second/
├── first.md // <- http://example.com/quote/first/
└── second.md // <- http://example.com/quote/second/
```
## Path Breakdown in Hugo
The following demonstrates the relationships between your content organization and the output URL structure for your Hugo website when it renders. These examples assume you are [using pretty URLs][pretty], which is the default behavior for Hugo. The examples also assume a key-value of `baseurl = "http://yoursite.com"` in your [site's configuration file][config].
The following demonstrates the relationships between your content organization and the output URL structure for your Hugo website when it renders. These examples assume you are [using pretty URLs][pretty], which is the default behavior for Hugo. The examples also assume a key-value of `baseurl = "http://example.com"` in your [site's configuration file][config].
### Index Pages: `_index.md`
@ -56,7 +56,7 @@ The following demonstrates the relationships between your content organization a
You can keep one `_index.md` for your homepage and one in each of your content sections, taxonomies, and taxonomy terms. The following shows typical placement of an `_index.md` that would contain content and front matter for a `posts` section list page on a Hugo website:
```bash
```
. url
. ⊢--^-⊣
. path slug
@ -68,7 +68,7 @@ content/posts/_index.md
At build, this will output to the following destination with the associated values:
```bash
```
url ("/posts/")
⊢-^-⊣
@ -76,7 +76,7 @@ At build, this will output to the following destination with the associated valu
⊢--------^---------⊣⊢-^-⊣
permalink
⊢----------^-------------⊣
http://yoursite.com/posts/index.html
http://example.com/posts/index.html
```
### Single Pages in Sections
@ -84,7 +84,7 @@ http://yoursite.com/posts/index.html
Single content files in each of your sections are going to be rendered as [single page templates][singles]. Here is an example of a single `post` within `posts`:
```bash
```
path ("posts/my-first-hugo-post.md")
. ⊢-----------^------------⊣
. section slug
@ -94,7 +94,7 @@ content/posts/my-first-hugo-post.md
At the time Hugo builds your site, the content will be output to the following destination:
```bash
```
url ("/posts/my-first-hugo-post/")
⊢------------^----------⊣
@ -102,7 +102,7 @@ At the time Hugo builds your site, the content will be output to the following d
⊢--------^--------⊣⊢-^--⊣⊢-------^---------⊣
permalink
⊢--------------------^---------------------⊣
http://yoursite.com/posts/my-first-hugo-post/index.html
http://example.com/posts/my-first-hugo-post/index.html
```
### Section with Nested Directories
@ -110,7 +110,7 @@ http://yoursite.com/posts/my-first-hugo-post/index.html
To continue the example, the following demonstrates destination paths for a file located at `content/events/chicago/lollapalooza.md` in the same site:
```bash
```
section
⊢--^--⊣
url
@ -120,7 +120,7 @@ To continue the example, the following demonstrates destination paths for a file
⊢--------^--------⊣ ⊢------^-----⊣⊢----^------⊣
permalink
⊢----------------------^-----------------------⊣
http://yoursite.com/events/chicago/lollapalooza/
http://example.com/events/chicago/lollapalooza/
```
{{% note %}}
@ -166,25 +166,23 @@ The following items are defined in this order for a specific reason: items expla
### `filename`
This isn't in the front matter, but is the actual name of the file minus the extension. This will be the name of the file in the destination (e.g., `content/posts/my-post.md` becomes `yoursite.com/posts/my-post/`).
This isn't in the front matter, but is the actual name of the file minus the extension. This will be the name of the file in the destination (e.g., `content/posts/my-post.md` becomes `example.com/posts/my-post/`).
### `slug`
When defined in the front matter, the `slug` can take the place of the filename for the destination.
{{% code file="content/posts/old-post.md" %}}
```yaml
{{< code file="content/posts/old-post.md" >}}
---
title: New Post
slug: "new-post"
---
```
{{% /code %}}
{{< /code >}}
This will render to the following destination according to Hugo's default behavior:
```
yoursite.com/posts/new-post/
example.com/posts/new-post/
```
### `section`
@ -195,15 +193,13 @@ yoursite.com/posts/new-post/
A content's `type` is also determined by its location on disk but, unlike `section`, it *can* be specified in the front matter. See [types][]. This can come in especially handy when you want a piece of content to render using a different layout. In the following example, you can create a layout at `layouts/new/mylayout.html` that Hugo will use to render this piece of content, even in the midst of many other posts.
{{% code file="content/posts/my-post.md" %}}
```yaml
{{< code file="content/posts/my-post.md" >}}
---
title: My Post
type: new
layout: mylayout
---
```
{{% /code %}}
{{< /code >}}
<!-- See https://discourse.gohugo.io/t/path-not-works/6387 -->
<!-- ### `path`
@ -213,19 +209,17 @@ layout: mylayout
A complete URL can be provided. This will override all the above as it pertains to the end destination. This must be the path from the baseURL (starting with a `/`). `url` will be used exactly as it provided in the front matter and will ignore the `--uglyURLs` setting in your site configuration:
{{% code file="content/posts/old-url.md" %}}
```yaml
{{< code file="content/posts/old-url.md" >}}
---
title: Old URL
url: /blog/new-url/
---
```
{{% /code %}}
{{< /code >}}
Assuming your `baseURL` is [configured][config] to `https://yoursite.com`, the addition of `url` to the front matter will make `old-url.md` render to the following destination:
Assuming your `baseURL` is [configured][config] to `https://example.com`, the addition of `url` to the front matter will make `old-url.md` render to the following destination:
```
https://yoursite.com/blog/new-url/
https://example.com/blog/new-url/
```
You can see more information on how to control output paths in [URL Management][urls].

28
content/content-management/sections.md
View file

@ -30,25 +30,25 @@ Following this pattern, Hugo uses the top level of your content organization as
The following example shows a content directory structure for a website that has three sections: "authors," "events," and "posts":
```bash
```
.
└── content
├── authors
| ├── _index.md // <- yoursite.com/authors/
| ├── john-doe.md // <- yoursite.com/authors/john-doe/
| └── jane-doe.md // <- yoursite.com/authors/jane-doe/
| ├── _index.md // <- example.com/authors/
| ├── john-doe.md // <- example.com/authors/john-doe/
| └── jane-doe.md // <- example.com/authors/jane-doe/
└── events
| ├── _index.md // <- yoursite.com/events/
| ├── event-1.md // <- yoursite.com/events/event-1/
| ├── event-2.md // <- yoursite.com/events/event-2/
| └── event-3.md // <- yoursite.com/events/event-3/
| ├── _index.md // <- example.com/events/
| ├── event-1.md // <- example.com/events/event-1/
| ├── event-2.md // <- example.com/events/event-2/
| └── event-3.md // <- example.com/events/event-3/
└── posts
| ├── _index.md // <- yoursite.com/posts/
| ├── event-1.md // <- yoursite.com/posts/event-1/
| ├── event-2.md // <- yoursite.com/posts/event-2/
| ├── event-3.md // <- yoursite.com/posts/event-3/
| ├── event-4.md // <- yoursite.com/posts/event-4/
| └── event-5.md // <- yoursite.com/posts/event-5/
| ├── _index.md // <- example.com/posts/
| ├── event-1.md // <- example.com/posts/event-1/
| ├── event-2.md // <- example.com/posts/event-2/
| ├── event-3.md // <- example.com/posts/event-3/
| ├── event-4.md // <- example.com/posts/event-4/
| └── event-5.md // <- example.com/posts/event-5/
```
## Content Section Lists

102
content/content-management/shortcodes.md
View file

@ -38,11 +38,11 @@ Some shortcodes use or require closing shortcodes. Again like HTML, the opening
Here are two examples of paired shortcodes:
```md
```
{{%/* mdshortcode */%}}Stuff to `process` in the *center*.{{%/* /mdshortcode */%}}
```
```md
```
{{</* highlight go */>}} A bunch of code here {{</* /highlight */>}}
```
@ -52,7 +52,7 @@ The examples above use two different delimiters, the difference being the `%` ch
The `%` character indicates that the shortcode's inner content---called in the [shortcode template][sctemps] with the [`.Inner` variable][scvars]---needs further processing by the page's rendering processor (i.e. markdown via Blackfriday). In the following example, Blackfriday would convert `**World**` to `<strong>World</strong>`:
```md
```
{{%/* myshortcode */%}}Hello **World!**{{%/* /myshortcode */%}}
```
@ -60,7 +60,7 @@ The `%` character indicates that the shortcode's inner content---called in the [
The `<` character indicates that the shortcode's inner content does *not* need further rendering. Often shortcodes without markdown include internal HTML:
```md
```
{{</* myshortcode */>}}<p>Hello <strong>World!</strong></p>{{</* /myshortcode */>}}
```
@ -89,16 +89,14 @@ The `figure` shortcode can use the following named parameters:
#### Example `figure` Input
{{% code file="figure-input-example.md" %}}
```markdown
{{< code file="figure-input-example.md" >}}
{{</* figure src="/media/spf13.jpg" title="Steve Francia" */>}}
```
{{% /code %}}
{{< /code >}}
#### Example `figure` Output
{{% output file="figure-output-example.html" %}}
```html
```
<figure>
<img src="/media/spf13.jpg" />
<figcaption>
@ -112,13 +110,13 @@ The `figure` shortcode can use the following named parameters:
Bloggers often want to include GitHub gists when writing posts. Let's suppose we want to use the [gist at the following url][examplegist]:
```html
```
https://gist.github.com/spf13/7896402
```
We can embed the gist in our content via username and gist ID pulled from the URL:
```md
```
{{</* gist spf13 7896402 */>}}
```
@ -126,16 +124,14 @@ We can embed the gist in our content via username and gist ID pulled from the UR
If the gist contains several files and you want to quote just one of them, you can pass the filename (quoted) as an optional third argument:
{{% code file="gist-input.md" %}}
```md
{{< code file="gist-input.md" >}}
{{</* gist spf13 7896402 "img.html" */>}}
```
{{% /code %}}
{{< /code >}}
#### Example `gist` Output
{{% output file="gist-output.html" %}}
```html
```
{{< gist spf13 7896402 >}}
```
{{% /output %}}
@ -152,8 +148,7 @@ This shortcode will convert the source code provided into syntax-highlighted HTM
#### Example `highlight` Input
{{% code file="content/tutorials/learn-html.md" %}}
```html
{{< code file="content/tutorials/learn-html.md" >}}
{{</* highlight html */>}}
<section id="main">
<div>
@ -164,15 +159,14 @@ This shortcode will convert the source code provided into syntax-highlighted HTM
</div>
</section>
{{</* /highlight */>}}
```
{{% /code %}}
{{< /code >}}
#### Example `highlight` Output
The `highlight` shortcode example above would produce the following HTML when the site is rendered:
{{% output file="tutorials/learn-html/index.html" %}}
```html
```
<span style="color: #f92672">&lt;section</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">&quot;main&quot;</span><span style="color: #f92672">&gt;</span>
<span style="color: #f92672">&lt;div&gt;</span>
<span style="color: #f92672">&lt;h1</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">&quot;title&quot;</span><span style="color: #f92672">&gt;</span>{{ .Title }}<span style="color: #f92672">&lt;/h1&gt;</span>
@ -192,32 +186,28 @@ To see even more options for adding syntax-highlighted code blocks to your websi
If you'd like to embed a photo from [Instagram][], you only need the photo's ID. You can discern an Instagram photo ID from the URL:
```html
```
https://www.instagram.com/p/BWNjjyYFxVx/
```
#### Example `instagram` Input
{{% code file="instagram-input.md" %}}
```md
{{< code file="instagram-input.md" >}}
{{</* instagram BWNjjyYFxVx */>}}
```
{{% /code %}}
{{< /code >}}
You also have the option to hide the caption:
{{% code file="instagram-input-hide-caption.md" %}}
```md
{{< code file="instagram-input-hide-caption.md" >}}
{{</* instagram BWNjjyYFxVx hidecaption */>}}
```
{{% /code %}}
{{< /code >}}
#### Example `instagram` Output
By adding the preceding `hidecaption` example, the following HTML will be added to your rendered website's markup:
{{% output file="instagram-hide-caption-output.html" %}}
```html
```
{{< instagram BWNjjyYFxVx hidecaption >}}
```
{{% /output %}}
@ -243,7 +233,7 @@ Read a more extensive description of `ref` and `relref` in the [cross references
#### Example `ref` and `relref` Input
```md
```
[Neat]({{</* ref "blog/neat.md" */>}})
[Who]({{</* relref "about.md#who" */>}})
```
@ -252,7 +242,7 @@ Read a more extensive description of `ref` and `relref` in the [cross references
Assuming that standard Hugo pretty URLs are turned on.
```html
```
<a href="/blog/neat">Neat</a>
<a href="/about/#who:c28654c202e73453784cfd2c5ab356c0">Who</a>
```
@ -261,7 +251,7 @@ Assuming that standard Hugo pretty URLs are turned on.
To embed slides from [Speaker Deck][], click on "&lt;&#8239;/&gt;&nbsp;Embed" (under Share right next to the template on Speaker Deck) and copy the URL:
```html
```
<script async class="speakerdeck-embed" data-id="4e8126e72d853c0060001f97" data-ratio="1.33333333333333" src="//speakerdeck.com/assets/embed.js"></script>
```
@ -269,16 +259,14 @@ To embed slides from [Speaker Deck][], click on "&lt;&#8239;/&gt;&nbsp;Embed" (u
Extract the value from the field `data-id` and pass it to the shortcode:
{{% code file="speakerdeck-example-input.md" %}}
```md
{{< code file="speakerdeck-example-input.md" >}}
{{</* speakerdeck 4e8126e72d853c0060001f97 */>}}
```
{{% /code %}}
{{< /code >}}
#### `speakerdeck` Example Output
{{% output file="speakerdeck-example-input.md" %}}
```html
```
{{< speakerdeck 4e8126e72d853c0060001f97 >}}
```
{{% /output %}}
@ -301,18 +289,16 @@ https://twitter.com/spf13/status/877500564405444608
Pass the tweet's ID from the URL as a parameter to the `tweet` shortcode:
{{% code file="example-tweet-input.md" %}}
```md
{{< code file="example-tweet-input.md" >}}
{{</* tweet 877500564405444608 */>}}
```
{{% /code %}}
{{< /code >}}
#### Example `tweet` Output
Using the preceding `tweet` example, the following HTML will be added to your rendered website's markup:
{{% output file="example-tweet-output.html" %}}
```html
```
{{< tweet 877500564405444608 >}}
```
{{% /output %}}
@ -335,18 +321,16 @@ https://vimeo.com/channels/staffpicks/146022717
Extract the ID from the video's URL and pass it to the `vimeo` shortcode:
{{% code file="example-vimeo-input.md" %}}
```md
{{< code file="example-vimeo-input.md" >}}
{{</* vimeo 146022717 */>}}
```
{{% /code %}}
{{< /code >}}
#### Example `vimeo` Output
Using the preceding `vimeo` example, the following HTML will be added to your rendered website's markup:
{{% output file="example-vimeo-output.html" %}}
```html
```
{{< vimeo 146022717 >}}
```
{{% /output %}}
@ -354,7 +338,7 @@ Using the preceding `vimeo` example, the following HTML will be added to your re
{{% tip %}}
If you want to further customize the visual styling of the YouTube or Vimeo output, add a `class` named parameter when calling the shortcode. The new `class` will be added to the `<div>` that wraps the `<iframe>` *and* will remove the inline styles. Note that you will need to call the `id` as a named parameter as well.
```md
```
{{</* vimeo id="146022717" class="my-vimeo-wrapper-class" */>}}
```
{{% /tip %}}
@ -378,30 +362,24 @@ https://www.youtube.com/watch?v=w7Ft2ymGmfc
Copy the YouTube video ID that follows `v=` in the video's URL and pass it to the `youtube` shortcode:
{{% code file="example-youtube-input.md" %}}
```md
{{< code file="example-youtube-input.md" >}}
{{</* youtube w7Ft2ymGmfc */>}}
```
{{% /code %}}
{{< /code >}}
Furthermore, you can automatically start playback of the embedded video by setting the `autoplay` parameter to `true`. Remember that you can't mix named an unnamed parameters, so you'll need to assign the yet unnamed video id to the parameter `id`:
{{% code file="example-youtube-input-with-autoplay.md" %}}
```md
{{< code file="example-youtube-input-with-autoplay.md" >}}
{{</* youtube id="w7Ft2ymGmfc" autoplay="true" */>}}
```
{{% /code %}}
{{< /code >}}
#### Example `youtube` Output
Using the preceding `youtube` example, the following HTML will be added to your rendered website's markup:
{{% code file="example-youtube-output.html" %}}
```html
{{< code file="example-youtube-output.html" >}}
{{< youtube id="w7Ft2ymGmfc" autoplay="true" >}}
```
{{% /code %}}
{{< /code >}}
#### Example `youtube` Display

6
content/content-management/summaries.md
View file

@ -56,8 +56,7 @@ Be careful to enter <code>&#60;&#33;&#45;&#45;more&#45;&#45;&#62;</code> exactly
You can show content summaries with the following code. You could use the following snippet, for example, in a [section template][].
{{% code file="page-list-with-summaries.html" %}}
```html
{{< code file="page-list-with-summaries.html" >}}
{{ range first 10 .Data.Pages }}
<article>
<!-- this <div> includes the title summary -->
@ -73,8 +72,7 @@ You can show content summaries with the following code. You could use the follow
{{ end }}
</article>
{{ end }}
```
{{% /code %}}
{{< /code >}}
Note how the `.Truncated` boolean valuable may be used to hide the "Read More..." link when the content is not truncated; i.e., when the summary contains the entire article.

20
content/content-management/taxonomies.md
View file

@ -52,7 +52,7 @@ To continue with the example of a movie site, the following demonstrates content
```
Actor <- Taxonomy
Bruce Willis <- Term
The Six Sense <- Content
The Sixth Sense <- Content
Unbreakable <- Content
Moonrise Kingdom <- Content
Samuel L. Jackson <- Term
@ -86,7 +86,7 @@ Hugo natively supports taxonomies.
Without adding a single line to your site's configuration file, Hugo will automatically create taxonomies for `tags` and `categories`. If you do not want Hugo to create any taxonomies, set `disableKinds` in your site's configuration to the following:
```toml
```
disableKinds = ["taxonomy","taxonomyTerm"]
```
@ -94,7 +94,7 @@ disableKinds = ["taxonomy","taxonomyTerm"]
When taxonomies are used---and [taxonomy templates][] are provided---Hugo will automatically create both a page listing all the taxonomy's terms and individual pages with lists of content associated with each term. For example, a `categories` taxonomy declared in your your configuration and used in your content front matter will create the following pages:
* A single page at `yoursite.com/categories/` that lists all the [terms within the taxonomy][]
* A single page at `example.com/categories/` that lists all the [terms within the taxonomy][]
* [Individual taxonomy list pages][taxonomy templates] (e.g., `/categories/development/`) for each of the terms that shows a listing of all pages marked as part of that taxonomy within any content file's [front matter][]
## Configure Taxonomies
@ -103,7 +103,7 @@ Taxonomies must be defined in your [website configuration][config] before they c
### Example: TOML Taxonomy Configuration
```toml
```
[taxonomies]
tag = "tags"
category = "categories"
@ -112,7 +112,7 @@ Taxonomies must be defined in your [website configuration][config] before they c
### Example: YAML Taxonomy Configuration
```yaml
```
taxonomies:
tag: "tags"
category: "categories"
@ -145,7 +145,7 @@ If you would like the ability to quickly generate content files with preconfigur
### Example: TOML Front Matter with Taxonomies
```toml
```
+++
title = "Hugo: A fast and flexible static site generator"
tags = [ "Development", "Go", "fast", "Blogging" ]
@ -158,7 +158,7 @@ project_url = "https://github.com/gohugoio/hugo"
### Example: YAML Front Matter with Taxonomies
```yaml
```
---
title: "Hugo: A fast and flexible static site generator"
#tags: ["Development", "Go", "fast", "Blogging"]
@ -171,7 +171,7 @@ project_url: "https://github.com/gohugoio/hugo"
### Example: JSON Front Matter with Taxonomies
```json
```
{
"title": "Hugo: A fast and flexible static site generator",
"tags": [
@ -199,7 +199,7 @@ The following TOML and YAML examples show a piece of content that has a weight o
### Example: TOML Taxonomic `weight`
```toml
```
+++
title = "foo"
tags = [ "a", "b", "c" ]
@ -211,7 +211,7 @@ categories_weight = 44
### Example: YAML Taxonomic `weight`
```yaml
```
---
title: foo
#tags: [ "a", "b", "c" ]

14
content/content-management/toc.md
View file

@ -25,7 +25,7 @@ Currently, the `{{.TableOfContents}}` [page variable](/variables/page/) does not
Create your markdown the way you normally would with the appropriate headings. Here is some example content:
```md
```
<!-- Your front matter up here -->
## Introduction
@ -49,8 +49,7 @@ The built-in `.TableOfContents` variables outputs a `<nav id="TableOfContents">`
The following is an example of a very basic [single page template][]:
{{% code file="layout/_default/single.html" download="single.html" %}}
```html
{{< code file="layout/_default/single.html" download="single.html" >}}
{{ define "main" }}
<main>
<article>
@ -64,15 +63,13 @@ The following is an example of a very basic [single page template][]:
</aside>
</main>
{{ end }}
```
{{% /code %}}
{{< /code >}}
## Template Example: TOC Partial
The following is a [partial template][partials] that adds slightly more logic for page-level control over your table of contents. It assumes you are using a `toc` field in your content's [front matter][] that, unless specifically set to `false`, will add a TOC to any page with a `.WordCount` (see [Page Variables][pagevars]) greater than 400. This example also demonstrates how to use [conditionals][] in your templating:
{{% code file="layouts/partials/toc.html" download="toc.html" %}}
```html
{{< code file="layouts/partials/toc.html" download="toc.html" >}}
{{ if and (gt .WordCount 400 ) (ne .Params.toc "false") }}
<aside>
<header>
@ -81,8 +78,7 @@ The following is a [partial template][partials] that adds slightly more logic fo
{{.TableOfContents}}
</aside>
{{ end }}
```
{{% /code %}}
{{< /code >}}
{{% note %}}
With the preceding example, even pages with > 400 words *and* `toc` not set to `false` will not render a table of contents if there are no headings in the page for the `{{.TableOfContents}}` variable to pull from.

6
content/content-management/types.md
View file

@ -44,8 +44,7 @@ Remember, all of the following are *optional*. If you do not specifically declar
The following examples take you stepwise through creating a new type layout for a content file that contains the following front matter:
{{% code file="content/events/my-first-event.md" copy="false" %}}
```toml
{{< code file="content/events/my-first-event.md" copy="false" >}}
+++
title = My First Event
date = "2016-06-24T19:20:04-07:00"
@ -53,8 +52,7 @@ description = "Today is my 36th birthday. How time flies."
type = "event"
layout = "birthday"
+++
```
{{% /code %}}
{{< /code >}}
By default, Hugo assumes `*.md` under `events` is of the `events` content type. However, we have specified that this particular file at `content/events/ my-first-event.md` is of type `event` and should render using the `birthday` layout.

84
content/content-management/urls.md
View file

@ -31,23 +31,19 @@ For example, if one of your [sections][] is called `post` and you want to adjust
### YAML Permalinks Configuration Example
{{% code file="config.yml" copy="false" %}}
```yaml
{{< code file="config.yml" copy="false" >}}
permalinks:
post: /:year/:month/:title/
```
{{% /code %}}
{{< /code >}}
### TOML Permalinks Configuration Example
{{% code file="config.toml" copy="false" %}}
```toml
{{< code file="config.toml" copy="false" >}}
[permalinks]
post = "/:year/:month/:title/"
```
{{% /code %}}
{{< /code >}}
Only the content under `post/` will have the new URL structure. For example, the file `content/post/sample-entry.md` with `date: 2017-02-27T19:20:00-05:00` in its front matter will render to `public/2017/02/sample-entry/index.html` at build time and therefore be reachable at `http://yoursite.com/2013/11/sample-entry/`.
Only the content under `post/` will have the new URL structure. For example, the file `content/post/sample-entry.md` with `date: 2017-02-27T19:20:00-05:00` in its front matter will render to `public/2017/02/sample-entry/index.html` at build time and therefore be reachable at `http://example.com/2013/11/sample-entry/`.
### Permalink Configuration Values
@ -98,30 +94,26 @@ Let's assume you create a new piece of content at `content/posts/my-awesome-blog
#### TOML Front Matter
{{% code file="content/posts/my-awesome-post.md" copy="false" %}}
```toml
{{< code file="content/posts/my-awesome-post.md" copy="false" >}}
+++
aliases = [
"/posts/my-original-url/",
"/2010/01/01/even-earlier-url.html"
]
+++
```
{{% /code %}}
{{< /code >}}
#### YAML Front Matter
{{% code file="content/posts/my-awesome-post.md" copy="false" %}}
```yaml
{{< code file="content/posts/my-awesome-post.md" copy="false" >}}
---
aliases:
- /posts/my-original-url/
- /2010/01/01/even-earlier-url.html
---
```
{{% /code %}}
{{< /code >}}
Now when you visit any of the locations specified in aliases---i.e., *assuming the same site domain*---you'll be redirected to the page they are specified on. For example, a visitor to `yoursite.com/posts/my-original-url/` will be immediately redirected to `yoursite.com/posts/my-awesome-blog-post/`.
Now when you visit any of the locations specified in aliases---i.e., *assuming the same site domain*---you'll be redirected to the page they are specified on. For example, a visitor to `example.com/posts/my-original-url/` will be immediately redirected to `example.com/posts/my-awesome-blog-post/`.
### Example: Aliases in Multilingual
@ -129,7 +121,7 @@ On [multilingual sites][multilingual], each translation of a post can have uniqu
In `/posts/my-new-post.es.md`:
```yaml
```
---
aliases:
- /es/posts/my-original-post/
@ -142,29 +134,29 @@ When aliases are specified, Hugo creates a directory to match the alias entry. I
For example, a content file at `posts/my-intended-url.md` with the following in the front matter:
```yaml
```
---
title: My New post
aliases: [/posts/my-old-url/]
---
```
Assuming a `baseURL` of `yoursite.com`, the contents of the auto-generated alias `.html` found at `https://yoursite.com/posts/my-old-url/ will contain the following:`
Assuming a `baseURL` of `example.com`, the contents of the auto-generated alias `.html` found at `https://example.com/posts/my-old-url/ will contain the following:`
```html
```
<!DOCTYPE html>
<html>
<head>
<title>http://yoursite.com/posts/my-intended-url</title>
<link rel="canonical" href="http://yoursite.com/posts/my-intended-url"/>
<title>http://example.com/posts/my-intended-url</title>
<link rel="canonical" href="http://example.com/posts/my-intended-url"/>
<meta name=\"robots\" content=\"noindex\">
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta http-equiv="refresh" content="0; url=http://yoursite.com/posts/my-intended-url"/>
<meta http-equiv="refresh" content="0; url=http://example.com/posts/my-intended-url"/>
</head>
</html>
```
The `http-equiv="refresh"` line is what performs the redirect, in 0 seconds in this case. If an end user of your website goes to `https://yoursite.com/posts/my-old-url`, they will now be automatically redirected to the newer, correct URL. The addition of `<meta name=\"robots\" content=\"noindex\">` lets search engine bots know they they should not crawl and index your new alias page.
The `http-equiv="refresh"` line is what performs the redirect, in 0 seconds in this case. If an end user of your website goes to `https://example.com/posts/my-old-url`, they will now be automatically redirected to the newer, correct URL. The addition of `<meta name=\"robots\" content=\"noindex\">` lets search engine bots know they they should not crawl and index your new alias page.
### Customize
You may customize this alias page by creating an `alias.html` template in the
@ -189,51 +181,51 @@ Hugo's default behavior is to render your content with "pretty" URLs. No non-sta
The following demonstrates the concept:
```bash
```
content/posts/_index.md
=> yoursite.com/posts/index.html
=> example.com/posts/index.html
content/posts/post-1.md
=> yoursite.com/posts/post-1/
=> example.com/posts/post-1/
```
## Ugly URLs
If you would like to have are often referred to as "ugly URLs" (e.g., yoursite.com/urls.html), set `uglyurls = true` or `uglyurls: true` in your site's `config.toml` or `config.yaml`, respectively. You can also use the `--uglyURLs=true` [flag from the command line][usage] with `hugo` or `hugo server`..
If you would like to have are often referred to as "ugly URLs" (e.g., example.com/urls.html), set `uglyurls = true` or `uglyurls: true` in your site's `config.toml` or `config.yaml`, respectively. You can also use the `--uglyURLs=true` [flag from the command line][usage] with `hugo` or `hugo server`..
If you want a specific piece of content to have an exact URL, you can specify this in the [front matter][] under the `url` key. The following are examples of the same content directory and what the eventual URL structure will be when Hugo runs with its default behavior.
See [Content Organization][contentorg] for more details on paths.
```bash
```
.
└── content
└── about
| └── _index.md // <- http://yoursite.com/about/
| └── _index.md // <- http://example.com/about/
├── post
| ├── firstpost.md // <- http://yoursite.com/post/firstpost/
| ├── firstpost.md // <- http://example.com/post/firstpost/
| ├── happy
| | └── ness.md // <- http://yoursite.com/post/happy/ness/
| └── secondpost.md // <- http://yoursite.com/post/secondpost/
| | └── ness.md // <- http://example.com/post/happy/ness/
| └── secondpost.md // <- http://example.com/post/secondpost/
└── quote
├── first.md // <- http://yoursite.com/quote/first/
└── second.md // <- http://yoursite.com/quote/second/
├── first.md // <- http://example.com/quote/first/
└── second.md // <- http://example.com/quote/second/
```
Here's the same organization run with `hugo --uglyURLs`:
```bash
```
.
└── content
└── about
| └── _index.md // <- http://yoursite.com/about/index.html
| └── _index.md // <- http://example.com/about/index.html
├── post
| ├── firstpost.md // <- http://yoursite.com/post/firstpost.html
| ├── firstpost.md // <- http://example.com/post/firstpost.html
| ├── happy
| | └── ness.md // <- http://yoursite.com/post/happy/ness.html
| └── secondpost.md // <- http://yoursite.com/post/secondpost.html
| | └── ness.md // <- http://example.com/post/happy/ness.html
| └── secondpost.md // <- http://example.com/post/secondpost.html
└── quote
├── first.md // <- http://yoursite.com/quote/first.html
└── second.md // <- http://yoursite.com/quote/second.html
├── first.md // <- http://example.com/quote/first.html
└── second.md // <- http://example.com/quote/second.html
```
@ -241,7 +233,7 @@ Here's the same organization run with `hugo --uglyURLs`:
By default, all relative URLs encountered in the input are left unmodified, e.g. `/css/foo.css` would stay as `/css/foo.css`. The `canonifyURLs` field in your site `config` has a default value of `false`.
By setting `canonifyURLs` to `true`, all relative URLs would instead be *canonicalized* using `baseURL`. For example, assuming you have `baseURL = https://yoursite.com/`, the relative URL `/css/foo.css` would be turned into the absolute URL `http://yoursite.com/css/foo.css`.
By setting `canonifyURLs` to `true`, all relative URLs would instead be *canonicalized* using `baseURL`. For example, assuming you have `baseURL = https://example.com/`, the relative URL `/css/foo.css` would be turned into the absolute URL `http://example.com/css/foo.css`.
Benefits of canonicalization include fixing all URLs to be absolute, which may aid with some parsing tasks. Note, however, that all modern browsers handle this on the client without issue.
@ -253,7 +245,7 @@ In the May 2014 release of Hugo v0.11, the default value of `canonifyURLs` was s
To find out the current value of `canonifyURLs` for your website, you may use the handy `hugo config` command added in v0.13.
```bash
```
hugo config | grep -i canon
```

4
content/contribute/_index.md
View file

@ -1,6 +1,6 @@
---
title: Contributing to the Hugo Project
linktitle: Contributing to Hugo
title: Contribute to the Hugo Project
linktitle: Contribute to Hugo
description: Contribute to Hugo development and documentation.
date: 2017-02-01
publishdate: 2017-02-01

60
content/contribute/development.md
View file

@ -46,13 +46,13 @@ If you are having trouble following the installation guides for go, check out [G
Once you're finished installing Go, let's confirm everything is working correctly. Open a terminal---or command line under Windows--and type the following:
```bash
```
go version
```
You should see something similar to the following written to the console. Note that the version here reflects the most recent version of Go as of the last update for this page:
```bash
```
go version go1.8 darwin/amd64
```
@ -60,7 +60,7 @@ Next, make sure that you set up your `GOPATH` [as described in the installation
You can print the `GOPATH` with `echo $GOPATH`. You should see a non-empty string containing a valid path to your Go workspace; .e.g.:
```bash
```
/Users/<yourusername>/Code/go
```
@ -68,11 +68,9 @@ You can print the `GOPATH` with `echo $GOPATH`. You should see a non-empty strin
If you are a macOS user and have [Homebrew](https://brew.sh/) installed on your machine, installing Go is as simple as the following command:
{{% code file="install-go.sh" %}}
```bash
{{< code file="install-go.sh" >}}
brew install go
```
{{% /code %}}
{{< /code >}}
### Install Go via GVM
@ -102,23 +100,23 @@ There are several [GUI clients](https://git-scm.com/downloads/guis) that help yo
### Install Hub on Your System (Optional)
Hub is a great tool for working with GitHub. The main site for it is [www.hub.github.com](https://hub.github.com/). Feel free to install this little Git wrapper.
Hub is a great tool for working with GitHub. The main site for it is [hub.github.com](https://hub.github.com/). Feel free to install this little Git wrapper.
On a Mac, you can install [Hub](https://github.com/github/hub) using [Homebrew](https://brew.sh):
```sh
```
brew install hub
```
Now we'll create an [alias in Bash](http://tldp.org/LDP/abs/html/aliases.html) so that typing `git` actually runs `Hub`:
```sh
```
echo "alias git='hub'" >> ~/.bash_profile
```
Confirm the installation:
```sh
```
git version 2.6.3
hub version 2.2.2
```
@ -137,7 +135,7 @@ We're going to clone the [master Hugo repository](https://github.com/gohugoio/hu
So, let's clone that master repository:
```sh
```
go get -v -u github.com/gohugoio/hugo
```
@ -159,13 +157,13 @@ Now open your fork repository on GitHub and copy the remote url of your fork. Yo
Switch back to the terminal and move into the directory of the cloned master repository from the last step.
```sh
```
cd $GOPATH/src/github.com/gohugoio/hugo
```
Now Git needs to know that our fork exists by adding the copied remote url:
```sh
```
git remote add <YOUR-GITHUB-USERNAME> <COPIED REMOTE-URL>
```
@ -173,7 +171,7 @@ git remote add <YOUR-GITHUB-USERNAME> <COPIED REMOTE-URL>
Alternatively, you can use the Git wrapper Hub. Hub makes forking a repository easy:
```sh
```
git fork
```
@ -183,13 +181,13 @@ That command will log in to GitHub using your account, create a fork of the repo
Let's check if everything went right by listing all known remotes:
```sh
```
git remote -v
```
The output should look similar:
```sh
```
digitalcraftsman git@github.com:digitalcraftsman/hugo.git (fetch)
digitalcraftsman git@github.com:digitalcraftsman/hugo.git (push)
origin https://github.com/gohugoio/hugo (fetch)
@ -204,14 +202,14 @@ You should never develop against the "master" branch. The development team will
First, you should always pull the latest changes from the master repository:
```sh
```
git checkout master
git pull
```
Now we can create a new branch for your additions:
```sh
```
git checkout -b <BRANCH-NAME>
```
@ -229,7 +227,7 @@ We have developed a [separate Hugo documentation contribution guide][docscontrib
While making changes in the codebase it's a good idea to build the binary to test them:
```sh
```
go build -o hugo main.go
```
@ -241,13 +239,13 @@ Make sure the commands `go test ./...` passes, and `go build` completes.
### Formatting
The Go code styleguide maybe is opiniated but it ensures that the codebase looks the same, regardless who wrote the code. Go comes with its own formatting tool. Let's apply the styleguide to our addtions:
```sh
```
go fmt ./...
```
Once you made your additions commit your changes. Make sure that you follow our [code contribution guidelines](https://github.com/gohugoio/hugo/blob/master/CONTRIBUTING.md):
```sh
```
# Add all changed files
git add --all
git commit --message "YOUR COMMIT MESSAGE"
@ -265,20 +263,20 @@ If you are unsure what a command does leave the commit as it is. We can fix your
Let's say you want to modify the last commit message. Run the following command and replace the current message:
```sh
```
git commit --amend -m"YOUR NEW COMMIT MESSAGE"
```
Take a look at the commit log to see the change:
```sh
```
git log
# Exit with q
```
After making the last commit you may forgot something. There is no need to create a new commit. Just add the latest changes and merge them into the intended commit:
```sh
```
git add --all
git commit --amend
```
@ -291,13 +289,13 @@ Modifications such as those described in this section can have serious unintende
This is a bit more advanced. Git allows you to [rebase](https://git-scm.com/docs/git-rebase) commits interactively. In other words: it allows you to rewrite the commit history.
```sh
```
git rebase --interactive @~6
```
The `6` at the end of the command represents the number of commits that should be modified. An editor should open and present a list of last six commit messages:
```sh
```
pick 80d02a1 tpl: Add hasPrefix to the template funcs' "smoke test"
pick aaee038 tpl: Sort the smoke tests
pick f0dbf2c tpl: Add the other test case for hasPrefix
@ -310,7 +308,7 @@ In the case above we should merge the last to commits in the commit of this tuto
All operations are written before the commit message. Replace "pick" with an operation. In this case `squash` or `s` for short:
```sh
```
pick 80d02a1 tpl: Add hasPrefix to the template funcs' "smoke test"
pick aaee038 tpl: Sort the smoke tests
pick f0dbf2c tpl: Add the other test case for hasPrefix
@ -323,7 +321,7 @@ We also want to rewrite the commits message of the third last commit. We forgot
You should end up with a similar setup:
```sh
```
pick 80d02a1 tpl: Add hasPrefix to the template funcs' "smoke test"
pick aaee038 tpl: Sort the smoke tests
pick f0dbf2c tpl: Add the other test case for hasPrefix
@ -336,7 +334,7 @@ Close the editor. It should open again with a new tab. A text is instructing you
A last time a new tab opens. Enter a new commit message and save again. Your terminal should contain a status message. Hopefully this one:
```sh
```
Successfully rebased and updated refs/heads/<BRANCHNAME>.
```
@ -346,7 +344,7 @@ Check the commit log if everything looks as expected. Should an error occur you
To push our commits to the fork on GitHub we need to speficy a destination. A destination is defined by the remote and a branch name. Earlier, the defined that the remote url of our fork is the same as our GitHub handle, in my case `digitalcraftsman`. The branch should have the same as our local one. This makes it easy to identify corresponding branches.
```sh
```
git push --set-upstream <YOUR-GITHUB-USERNAME> <BRANCHNAME>
```

74
content/contribute/documentation.md
View file

@ -24,7 +24,7 @@ It's best to make changes to the Hugo docs on your local machine to check for co
You can then create a separate branch for your additions. Be sure to choose a descriptive branch name that best fits the type of content. The following is an example of a branch name you might use for adding a new website to the showcase:
```git
```
git checkout -b jon-doe-showcase-addition
```
@ -52,11 +52,9 @@ hugo new functions/newfunction.md
The archetype for `functions` according to the Hugo theme is as follows:
{{% code file="archetypes/functions.md" %}}
```yaml
{{< code file="archetypes/functions.md" >}}
{{< readfile file="/themes/gohugoioTheme/archetypes/functions.md">}}
```
{{% /code %}}
{{< /code >}}
#### New Function Required Fields
@ -104,11 +102,9 @@ hugo new tutorials/my-new-tutorial.md
The archetype for the `tutorials` content type is as follows:
{{% code file="archetypes/tutorials.md" %}}
```yaml
{{< code file="archetypes/tutorials.md" >}}
{{< readfile file="/themes/gohugoioTheme/archetypes/tutorials.md">}}
```
{{% /code %}}
{{< /code >}}
## Add Code Blocks
@ -120,11 +116,11 @@ Across all pages on the Hugo docs, the typical triple-back-tick markdown syntax
Your options for languages are `xml`/`html`, `go`/`golang`, `md`/`markdown`/`mkd`, `handlebars`, `apache`, `toml`, `yaml`, `json`, `css`, `asciidoc`, `ruby`, `powershell`/`ps`, `scss`, `sh`/`zsh`/`bash`/`git`, `http`/`https`, and `javascript`/`js`.
````html
```html
```
```
<h1>Hello world!</h1>
```
````
```
### Code Block Shortcode
@ -138,13 +134,13 @@ With the `code` shortcodes, *you must include triple back ticks and a language d
`code` is the Hugo docs shortcode you'll use most often. `code` requires has only one named parameter: `file`. Here is the pattern:
````markdown
```
{{%/* code file="smart/file/name/with/path.html" download="download.html" copy="true" */%}}
```language
```
A whole bunch of coding going on up in here!
```
{{%/* /code */%}}
````
```
The following are the arguments passed into `code`:
@ -164,9 +160,9 @@ This example HTML code block tells Hugo users the following:
1. This file *could* live in `layouts/_default`, as demonstrated by `layouts/_default/single.html` as the value for `file`.
2. This snippet is complete enough to be downloaded and implemented in a Hugo project, as demonstrated by `download="single.html"`.
````md
```
{{%/* code file="layouts/_default/single.html" download="single.html" */%}}
```html
```
{{ define "main" }}
<main>
<article>
@ -186,14 +182,13 @@ This example HTML code block tells Hugo users the following:
{{ end }}
```
{{%/* /code */%}}
````
```
##### Example 'code' Display
The output of this example will render to the Hugo docs as follows:
{{% code file="layouts/_default/single.html" download="single.html" %}}
```html
{{< code file="layouts/_default/single.html" download="single.html" >}}
{{ define "main" }}
<main>
<article>
@ -211,26 +206,25 @@ The output of this example will render to the Hugo docs as follows:
</article>
</main>
{{ end }}
```
{{% /code %}}
{{< /code >}}
<!-- #### Output Code Block
The `output` shortcode is almost identical to the `code` shortcode but only takes and requires `file`. The purpose of `output` is to show *rendered* HTML and therefore almost always follows another basic code block *or* and instance of the `code` shortcode:
````html
```
{{%/* output file="post/my-first-post/index.html" */%}}
```html
```
<h1>This is my First Hugo Blog Post</h1>
<p>I am excited to be using Hugo.</p>
```
{{%/* /output */%}}
````
```
The preceding `output` example will render as follows to the Hugo docs:
{{% output file="post/my-first-post/index.html" %}}
```html
```
<h1>This is my First Hugo Blog Post</h1>
<p>I am excited to be using Hugo.</p>
```
@ -240,7 +234,7 @@ The preceding `output` example will render as follows to the Hugo docs:
Blockquotes can be added to the Hugo documentation using [typical Markdown blockquote syntax][bqsyntax]:
```markdown
```
> Without the threat of punishment, there is no joy in flight.
```
@ -250,7 +244,7 @@ The preceding blockquote will render as follows in the Hugo docs:
However, you can add a quick and easy `<cite>` element (added on the client via JavaScript) by separating your main blockquote and the citation with a hyphen with a single space on each side:
```markdown
```
> Without the threat of punishment, there is no joy in flight. - [Kobo Abe](https://en.wikipedia.org/wiki/Kobo_Abe)
```
@ -276,18 +270,16 @@ Use the `note` shortcode when you want to draw attention to information subtly.
#### Example `note` Input
{{% code file="note-with-heading.md" %}}
```markdown
{{< code file="note-with-heading.md" >}}
{{%/* note */%}}
Here is a piece of information I would like to draw your **attention** to.
{{%/* /note */%}}
```
{{% /code %}}
{{< /code >}}
#### Example `note` Output
{{% output file="note-with-heading.html" %}}
```html
```
{{% note %}}
Here is a piece of information I would like to draw your **attention** to.
{{% /note %}}
@ -306,18 +298,16 @@ Use the `tip` shortcode when you want to give the reader advice. `tip`, like `no
#### Example `tip` Input
{{% code file="using-tip.md" %}}
```markdown
{{< code file="using-tip.md" >}}
{{%/* tip */%}}
Here's a bit of advice to improve your productivity with Hugo.
{{%/* /tip */%}}
```
{{% /code %}}
{{< /code >}}
#### Example `tip` Output
{{% output file="tip-output.html" %}}
```html
```
{{% tip %}}
Here's a bit of advice to improve your productivity with Hugo.
{{% /tip %}}
@ -336,18 +326,16 @@ Use the `warning` shortcode when you want to draw the user's attention to someth
#### Example `warning` Input
{{% code file="warning-admonition-input.md" %}}
```markdown
{{< code file="warning-admonition-input.md" >}}
{{%/* warning */%}}
This is a warning, which should be reserved for *important* information like breaking changes.
{{%/* /warning */%}}
```
{{% /code %}}
{{< /code >}}
#### Example `warning` Output
{{% output file="warning-admonition-output.html" %}}
```html
```
{{% warning %}}
This is a warning, which should be reserved for *important* information like breaking changes.
{{% /warning %}}

16
content/contribute/themes.md
View file

@ -59,13 +59,12 @@ The easiest way to add your theme is to [open up a new issue in the theme reposi
`theme.toml` contains metadata about the theme and its creator and should be created automatically when running the `hugo new theme`. The auto-generated file is provided here as well for easy downloading:
{{% code file="theme.toml" download="theme.toml" %}}
```toml
{{< code file="theme.toml" download="theme.toml" >}}
name = ""
license = "MIT"
licenselink = "https://github.com/<YOURNAME>/<YOURTHEME>/blob/master/LICENSE.md"
description = ""
homepage = "http://yoursite.com/"
homepage = "http://example.com/"
tags = []
features = []
min_version = 0.19
@ -79,12 +78,11 @@ min_version = 0.19
name = ""
homepage = ""
repo = ""
```
{{% /code %}}
{{< /code >}}
The following fields are required:
```toml
```
name = "Hyde"
license = "MIT"
licenselink = "https://github.com/spf13/hyde/blob/master/LICENSE.md"
@ -133,8 +131,7 @@ Your theme's README file should be written in markdown and saved at the root of
You can download the following `README.md` as an outline:
{{% code file="README.md" download="README.md" %}}
```markdown
{{< code file="README.md" download="README.md" >}}
# Theme Title
@ -143,8 +140,7 @@ You can download the following `README.md` as an outline:
```
{{% /code %}}
{{< /code >}}
{{% note "Screenshots in your `README.md`"%}}
If you add screenshots to the README, please make use of absolute file paths instead of relative ones like `/images/screenshot.png`. Relative paths work great on GitHub but they don't correspond to the directory structure of [themes.gohugo.io](http://themes.gohugo.io/). Therefore, browsers will not be able to display screenshots on the theme site under the given (relative) path.

6
content/functions/GetPage.md
View file

@ -51,16 +51,14 @@ This code snippet---in the form of a [partial template][partials]---allows you t
3. Sort the terms associated with the taxonomy by popularity.
4. Grab the top two most popular terms in the taxonomy (i.e., the two most popular tags assigned to content.
{{% code file="grab-top-two-tags.html" %}}
```html
{{< code file="grab-top-two-tags.html" >}}
<ul class="most-popular-tags">
{{ $t := $.Site.GetPage "taxonomyTerm" "tags" }}
{{ range first 2 $t.Data.Terms.ByCount }}
<li>{{.}}</li>
{{ end }}
</ul>
```
{{% /code %}}
{{< /code >}}
[partials]: /templates/partials/

6
content/functions/abslangurl.md
View file

@ -20,9 +20,9 @@ aliases: []
Both `absLangURL` and [`relLangURL`](/functions/rellangurl/) are similar to their [`absURL`](/functions/absurl/) and [`relURL`](/functions/relurl) relatives but will add the correct language prefix when the site is configured with more than one language.
So for a site `baseURL` set to `http://yoursite.com/hugo/` and the current language is `en`:
So for a site `baseURL` set to `http://example.com/hugo/` and the current language is `en`:
```golang
{{ "blog/" | absLangURL }} → "http://yoursite.com/hugo/en/blog/"
```
{{ "blog/" | absLangURL }} → "http://example.com/hugo/en/blog/"
{{ "blog/" | relLangURL }} → "/hugo/en/blog/"
```

12
content/functions/absurl.md
View file

@ -18,10 +18,10 @@ deprecated: false
aliases: []
---
Both `absURL` and `relURL` consider the configured value of `baseURL` in your site's [`config` file][configuration]. Given a `baseURL` set to `http://yoursite.com/hugo/`:
Both `absURL` and `relURL` consider the configured value of `baseURL` in your site's [`config` file][configuration]. Given a `baseURL` set to `http://example.com/hugo/`:
```golang
{{ "mystyle.css" | absURL }} → "http://yoursite.com/hugo/mystyle.css"
```
{{ "mystyle.css" | absURL }} → "http://example.com/hugo/mystyle.css"
{{ "mystyle.css" | relURL }} → "/hugo/mystyle.css"
{{ "http://gohugo.io/" | relURL }} → "http://gohugo.io/"
{{ "http://gohugo.io/" | absURL }} → "http://gohugo.io/"
@ -29,8 +29,7 @@ Both `absURL` and `relURL` consider the configured value of `baseURL` in your si
The last two examples may look strange but can be very useful. For example, the following shows how to use `absURL` in [JSON-LD structured data (SEO)][jsonld], where some of your images for a piece of content may or may not be hosted locally:
{{% code file="layouts/partials/schemaorg-metadata.html" download="schemaorg-metadata.html" %}}
```html
{{< code file="layouts/partials/schemaorg-metadata.html" download="schemaorg-metadata.html" >}}
<script type="application/ld+json">
{
"@context" : "http://schema.org",
@ -38,8 +37,7 @@ The last two examples may look strange but can be very useful. For example, the
"image" : {{ apply .Params.images "absURL" "." }}
}
</script>
```
{{% /code %}}
{{< /code >}}
The above uses the [apply function][] and also exposes how the Go template parser JSON-encodes objects inside `<script>` tags. See [the safeJS template function][safejs] for examples of how to tell Hugo not to escape strings inside of such tags.

8
content/functions/adddate.md
View file

@ -25,7 +25,7 @@ The `AddDate` function takes three arguments in logical order of `years`, `month
Let's assume you have a file at `data/tweets.toml` that contains a list of Tweets to display on your site's homepage. The file is filled with `[[tweet]]` blocks; e.g.---
```toml
```
[[tweet]]
name = "Steve Francia"
twitter_handle = "@spf13"
@ -36,8 +36,7 @@ date = "2017-01-07T00:00:00Z"
Let's assume you want to grab Tweets from the last two years and present them in a random order. In conjunction with the [`where`](/functions/where/) and [`now`](/functions/now/) functions, you can limit our range to the last two years via `now.AddDate -2 0 0`, which represents a point in time 2 years, 0 days, and 0 hours before the time of your last site build.
{{% code file="partials/templates/random-tweets.html" download="tweets.html" %}}
```html
{{< code file="partials/templates/random-tweets.html" download="tweets.html" >}}
{{ range where $.Site.Data.tweets.tweet "date" "ge" (now.AddDate -2 0 0) | shuffle }}
<div class="item">
<blockquote>
@ -50,5 +49,4 @@ Let's assume you want to grab Tweets from the last two years and present them in
</blockquote>
</div>
{{ end }}
```
{{% /code %}}
{{< /code >}}

10
content/functions/after.md
View file

@ -20,7 +20,7 @@ aliases: []
The following shows `after` being used in conjunction with the [`slice` function][slice]:
```html
```
{{ $data := slice "one" "two" "three" "four" }}
{{ range after 2 $data }}
{{ . }}
@ -30,13 +30,12 @@ The following shows `after` being used in conjunction with the [`slice` function
## Example of `after` with `first`: 2nd&ndash;4th Most Recent Articles
You can use `after` in combination with the [`first` function][] and Hugo's [powerful sorting methods][lists]. Let's assume you have a list page at `yoursite.com/articles`. You have 10 articles, but you want your templating for the [list/section page][] to show only two rows:
You can use `after` in combination with the [`first` function][] and Hugo's [powerful sorting methods][lists]. Let's assume you have a list page at `example.com/articles`. You have 10 articles, but you want your templating for the [list/section page][] to show only two rows:
1. The top row is titled "Featured" and shows only the most recently published article (i.e. by `publishdate` in the content files' front matter).
2. The second row is titled "Recent Articles" and shows only the 2nd- to 4th-most recently published articles.
{{% code file="layouts/section/articles.html" download="articles.html" %}}
```html
{{< code file="layouts/section/articles.html" download="articles.html" >}}
{{ define "main" }}
<section class="row featured-article">
<h2>Featured Article</h2>
@ -59,8 +58,7 @@ You can use `after` in combination with the [`first` function][] and Hugo's [pow
{{ end }}
</div>
{{ end }}
```
{{% /code %}}
{{< /code >}}
[`first` function]: /functions/first/
[list/section page]: /templates/section-templates/

26
content/functions/apply.md
View file

@ -31,7 +31,7 @@ aliases: []
Here is an example of a content file with `name:` as a front matter field:
```toml
```
+++
names: [ "Derek Perkins", "Joe Bergevin", "Tanner Linsley" ]
+++
@ -39,7 +39,7 @@ names: [ "Derek Perkins", "Joe Bergevin", "Tanner Linsley" ]
You can then use `apply` as follows:
```golang
```
{{ apply .Params.names "urlize" "." }}
```
@ -51,7 +51,7 @@ Which will result as follows:
This is *roughly* equivalent to using the following with [range][]
```golang
```
{{ range .Params.names }}{{ . | urlize }}{{ end }}
```
@ -59,8 +59,7 @@ However, it isn’t possible to provide the output of a range to the [`delimit`
If you have `post-tag-list.html` and `post-tag-link.html` as [partials][], you *could* use the following snippets, respectively:
{{% code file="layouts/partial/post-tag-list.html" copy="false" %}}
```html
{{< code file="layouts/partial/post-tag-list.html" copy="false" >}}
{{ with .Params.tags }}
<div class="tags-list">
Tags:
@ -76,20 +75,17 @@ If you have `post-tag-list.html` and `post-tag-link.html` as [partials][], you *
{{ end }}
</div>
{{ end }}
```
{{% /code %}}
{{< /code >}}
{{% code file="layouts/partial/post-tag-link.html" copy="false" %}}
```html
{{< code file="layouts/partial/post-tag-link.html" copy="false" >}}
<a class="post-tag post-tag-{{ . | urlize }}" href="/tags/{{ . | urlize }}">{{ . }}</a>
```
{{% /code %}}
{{< /code >}}
This works, but the complexity of `post-tag-list.html` is fairly high. The Hugo template needs to perform special behavior for the case where there’s only one tag, and it has to treat the last tag as special. Additionally, the tag list will be rendered something like `Tags: tag1 , tag2 , tag3` because of the way that the HTML is generated and then interpreted by a browser.
This first version of `layouts/partials/post-tag-list.html` separates all of the operations for ease of reading. The combined and DRYer version is shown next:
```html
```
{{ with .Params.tags }}
<div class="tags-list">
Tags:
@ -103,16 +99,14 @@ This first version of `layouts/partials/post-tag-list.html` separates all of the
Now in the completed version, you can sort the tags, convert the tags to links with `layouts/partials/post-tag-link.html`, [chomp][] off stray newlines, and join the tags together in a delimited list for presentation. Here is an even DRYer version of the preceding example:
{{% code file="layouts/partials/post-tag-list.html" download="post-tag-list.html" %}}
```html
{{< code file="layouts/partials/post-tag-list.html" download="post-tag-list.html" >}}
{{ with .Params.tags }}
<div class="tags-list">
Tags:
{{ delimit (apply (apply (sort .) "partial" "post-tag-link" ".") "chomp" ".") ", " }}
</div>
{{ end }}
```
{{% /code %}}
{{< /code >}}
{{% note %}}
`apply` does not work when receiving the sequence as an argument through a pipeline.

10
content/functions/base64.md
View file

@ -21,15 +21,13 @@ aliases: []
An example:
{{% code file="base64-input.html" %}}
```html
{{< code file="base64-input.html" >}}
<p>Hello world = {{ "Hello world" | base64Encode }}</p>
<p>SGVsbG8gd29ybGQ = {{ "SGVsbG8gd29ybGQ=" | base64Decode }}</p>
```
{{% /code %}}
{{< /code >}}
{{% output file="base-64-output.html" %}}
```html
```
<p>Hello world = SGVsbG8gd29ybGQ=</p>
<p>SGVsbG8gd29ybGQ = Hello world</p>
```
@ -47,7 +45,7 @@ You can also pass other data types as arguments to the template function which t
Using base64 to decode and encode becomes really powerful if we have to handle
responses from APIs.
```golang
```
{{ $resp := getJSON "https://api.github.com/repos/gohugoio/hugo/readme" }}
{{ $resp.content | base64Decode | markdownify }}
```

2
content/functions/chomp.md
View file

@ -19,6 +19,6 @@ deprecated: false
Useful in a pipeline to remove newlines added by other processing (e.g., [`markdownify`](/functions/markdownify/)).
```golang
```
{{chomp "<p>Blockhead</p>\n"}} → "<p>Blockhead</p>"
```

2
content/functions/countrunes.md
View file

@ -20,7 +20,7 @@ aliases: [/functions/countrunes/,/functions/countwords/]
In contrast with `countwords` function, which counts every word in a string, the `countrunes` function determines the number of runes in the content and excludes any whitespace. This has specific utility if you are dealing with CJK-like languages.
```html
```
{{ "Hello, 世界" | countrunes }}
<!-- outputs a content length of 8 runes. -->
```

2
content/functions/countwords.md
View file

@ -20,7 +20,7 @@ aliases: [/functions/countrunes/,/functions/countwords/]
The template function works similar to the [.WordCount page variable][pagevars].
```html
```
{{ "Hugo is a static site generator." | countwords }}
<!-- outputs a content length of 6 words. -->
```

34
content/functions/default.md
View file

@ -31,8 +31,7 @@ needsexamples: false
`default` function examples reference the following content page:
{{% code file="content/posts/default-function-example.md" %}}
```yaml
{{< code file="content/posts/default-function-example.md" >}}
---
title: Sane Defaults
seo_title:
@ -41,12 +40,11 @@ font:
oldparam: The default function helps make your templating DRYer.
newparam:
---
```
{{% /code %}}
{{< /code >}}
`default` can be written in more than one way:
```golang
```
{{ index .Params "font" | default "Roboto" }}
{{ default "Roboto" (index .Params "font") }}
```
@ -55,12 +53,10 @@ Both of the above `default` function calls return `Roboto`.
A `default` value, however, does not need to be hard coded like the previous example. The `default` value can be a variable or pulled directly from the front matter using dot notation:
{{% code file="variable-as-default-value.html" nocopy="true" %}}
```golang
{{< code file="variable-as-default-value.html" nocopy="true" >}}
{{$old := .Params.oldparam }}
<p>{{ .Params.newparam | default $old }}</p>
```
{{% /code %}}
{{< /code >}}
Which would return:
@ -70,16 +66,14 @@ Which would return:
And then using dot notation
{{% code file="dot-notation-default-value.html" %}}
```golang
{{< code file="dot-notation-default-value.html" >}}
<title>{{ .Params.seo_title | default .Title }}</title>
```
{{% /code %}}
{{< /code >}}
Which would return
{{% output file="dot-notation-default-return-value.html" %}}
```html
```
<title>Sane Defaults</title>
```
{{% /output %}}
@ -88,18 +82,14 @@ The following have equivalent return values but are far less terse. This demonst
Using `if`:
{{% code file="if-instead-of-default.html" nocopy="true" %}}
```golang
{{< code file="if-instead-of-default.html" nocopy="true" >}}
<title>{{if .Params.seo_title}}{{.Params.seo_title}}{{else}}{{.Title}}{{end}}</title>
=> Sane Defaults
```
{{% /code %}}
{{< /code >}}
Using `with`:
{{% code file="with-instead-of-default.html" nocopy="true" %}}
```golang
{{< code file="with-instead-of-default.html" nocopy="true" >}}
<title>{{with .Params.seo_title}}{{.}}{{else}}{{.Title}}{{end}}</title>
=> Sane Defaults
```
{{% /code %}}
{{< /code >}}

22
content/functions/delimit.md
View file

@ -33,37 +33,31 @@ To maintain a consistent output order, maps will be sorted by keys and only a sl
The examples of `delimit` that follow all use the same front matter:
{{% code file="delimit-example-front-matter.toml" nocopy="true" %}}
```toml
{{< code file="delimit-example-front-matter.toml" nocopy="true" >}}
+++
title: I love Delimit
#tags: [ "tag1", "tag2", "tag3" ]
+++
```
{{% /code %}}
{{< /code >}}
{{% code file="delimit-page-tags-input.html" %}}
```html
{{< code file="delimit-page-tags-input.html" >}}
<p>Tags: {{ delimit .Params.tags ", " }}</p>
```
{{% /code %}}
{{< /code >}}
{{% output file="delimit-page-tags-output.html" %}}
```html
```
<p>Tags: tag1, tag2, tag3</p>
```
{{% /output %}}
Here is the same example but with the optional "last" delimiter:
{{% code file="delimit-page-tags-final-and-input.html" %}}
```golang
{{< code file="delimit-page-tags-final-and-input.html" >}}
Tags: {{ delimit .Params.tags ", " ", and " }}
```
{{% /code %}}
{{< /code >}}
{{% output file="delimit-page-tags-final-and-output.html" %}}
```html
```
<p>Tags: tag1, tag2, and tag3</p>
```
{{% /output %}}

12
content/functions/dict.md
View file

@ -26,21 +26,17 @@ aliases: []
The partial below creates a SVG and expects `fill` `height` and `width` from the caller:
{{% code file="layouts/partials/svgs/external-links.svg" download="external-links.svg" %}}
```xml
{{< code file="layouts/partials/svgs/external-links.svg" download="external-links.svg" >}}
<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" fill="{{ .fill }}" width="{{ .size }}" height="{{ .size }}" viewBox="0 0 32 32" aria-label="External Link">
<path d="M25.152 16.576v5.696q0 2.144-1.504 3.648t-3.648 1.504h-14.848q-2.144 0-3.648-1.504t-1.504-3.648v-14.848q0-2.112 1.504-3.616t3.648-1.536h12.576q0.224 0 0.384 0.16t0.16 0.416v1.152q0 0.256-0.16 0.416t-0.384 0.16h-12.576q-1.184 0-2.016 0.832t-0.864 2.016v14.848q0 1.184 0.864 2.016t2.016 0.864h14.848q1.184 0 2.016-0.864t0.832-2.016v-5.696q0-0.256 0.16-0.416t0.416-0.16h1.152q0.256 0 0.416 0.16t0.16 0.416zM32 1.152v9.12q0 0.48-0.352 0.8t-0.8 0.352-0.8-0.352l-3.136-3.136-11.648 11.648q-0.16 0.192-0.416 0.192t-0.384-0.192l-2.048-2.048q-0.192-0.16-0.192-0.384t0.192-0.416l11.648-11.648-3.136-3.136q-0.352-0.352-0.352-0.8t0.352-0.8 0.8-0.352h9.12q0.48 0 0.8 0.352t0.352 0.8z"></path>
</svg>
```
{{% /code %}}
{{< /code >}}
These values can be stored in one object with `dict` and passed to the partial:
{{% code file="layouts/_default/list.html" %}}
```html
{{< code file="layouts/_default/list.html" >}}
{{ partial "svg/link-ext.svg" (dict "fill" "#01589B" "size" 10 "width" 20 ) }}
```
{{% /code %}}
{{< /code >}}

2
content/functions/findRe.md
View file

@ -29,7 +29,7 @@ The example below returns a list of all second level headers (`<h2>`) in the con
You can limit the number of matches in the list with a third parameter. The following example shows how to limit the returned value to just one match (or none, if there are no matched substrings):
```golang
```
{{ findRE "<h2.*?>(.|\n)*?</h2>" .Content 1 }}
<!-- returns ["<h2 id="#foo">Foo</h2>"] -->
```

2
content/functions/first.md
View file

@ -20,7 +20,7 @@ aliases: []
---
```golang
```
{{ range first 10 .Data.Pages }}
{{ .Render "summary" }}
{{ end }}

2
content/functions/format.md
View file

@ -27,7 +27,7 @@ toc: true
Assuming a key-value of `date: 2017-03-03` in a content file's front matter, your can run the date through `.Format` followed by a layout string for your desired output at build time:
```golang
```
{{ .PublishDate.Format "January 2, 2006" }} => March 3, 2017
```

2
content/functions/i18n.md
View file

@ -21,7 +21,7 @@ aliases: []
This translates a piece of content based on your `i18n/en-US.yaml` (and similar) files. You can use the [go-i18n](https://github.com/nicksnyder/go-i18n) tools to manage your translations. The translations can exist in both the theme and at the root of your repository.
```golang
```
{{ i18n "translation_id" }}
```

2
content/functions/imageConfig.md
View file

@ -17,7 +17,7 @@ relatedfuncs: []
deprecated: false
---
```golang
```
{{ with (imageConfig "favicon.ico") }}
favicon.ico: {{.Width}} x {{.Height}}
{{ end }}

8
content/functions/index-function.md
View file

@ -44,7 +44,7 @@ Assume you want to add a `location = ""` field to your front matter for every ar
Here is an example of the data inside `data/locations/oslo.toml`:
```toml
```
website = "https://www.oslo.kommune.no"
pop_city = 658390
pop_metro = 1717900
@ -52,7 +52,7 @@ pop_metro = 1717900
The example we will use will be an article on Oslo, which front matter should set to exactly the same name as the corresponding file name in `data/locations/`:
```toml
```
title = "My Norwegian Vacation"
location = "oslo"
```
@ -70,14 +70,14 @@ This is where the `index` function is needed. `index` takes 2 parameters in this
The variable for `.Params.location` is a string and can therefore replace `oslo` in the example above:
```golang
```
{{ index .Site.Data.authors .Params.author }}
=> map[website:https://www.oslo.kommune.no pop_city:658390 pop_metro:1717900]
```
Now the call will return the specific file according to the location specified in the content's front matter, but you will likely want to write specific properties to the template. You can do this by continuing down the node path via dot notation (`.`):
```golang
```
{{ (index .Site.Data.locations .Params.location).pop_city }}
=> 658390
```

8
content/functions/intersect.md
View file

@ -25,8 +25,7 @@ A useful example of `intersect` functionality is a "related posts" block. `isset
The following is an example of a "related posts" [partial template][partials] that could be added to a [single page template][single]:
{{% code file="layouts/partials/related-posts.html" download="related-posts.html" %}}
```html
{{< code file="layouts/partials/related-posts.html" download="related-posts.html" >}}
<ul>
{{ $page_link := .Permalink }}
{{ $tags := .Params.tags }}
@ -38,12 +37,11 @@ The following is an example of a "related posts" [partial template][partials] th
{{ end }}
{{ end }}
</ul>
```
{{% /code %}}
{{< /code >}}
This is also very useful to use as `AND` filters when combined with where:
```html
```
{{ $pages := where .Site.RegularPages "Type" "not in" (slice "page" "about") }}
{{ $pages := $pages | union (where .Site.RegularPages "Params.pinned" true) }}
{{ $pages := $pages | intersect (where .Site.RegularPages "Params.images" "!=" nil) }}

12
content/functions/len.md
View file

@ -35,24 +35,20 @@ aliases: []
You may want to append a class to a heading according to the length of the string therein. The following templating checks to see if the title's length is greater than 80 characters and, if so, adds a `long-title` class to the `<h1>`:
{{% code file="check-title-length.html" %}}
```html
{{< code file="check-title-length.html" >}}
<header>
<h1{{if gt (len .Title) 80}} class="long-title"{{end}}>{{.Title}}</h1>
</header>
```
{{% /code %}}
{{< /code >}}
## `len` Example 2: Counting Pages with `where`
The following templating uses [`where`][] in conjunction with `len` to figure out the total number of content pages in a `posts` [section][]:
{{% code file="how-many-posts.html" %}}
```html
{{< code file="how-many-posts.html" >}}
{{ $posts := (where .Site.RegularPages "Section" "==" "post") }}
{{ $postCount := len $posts }}
```
{{% /code %}}
{{< /code >}}
Note the use of `.RegularPages`, a [site variable][] that counts all regular content pages but not the `_index.md` pages used to add front matter and content to [list templates][].

12
content/functions/math.md
View file

@ -37,13 +37,13 @@ You can also use the `add` function with strings. You may like this functionalit
For example, social media sharing with [Twitter Cards][cards] requires the following `meta` link in your site's `<head>` to display Twitter's ["Summary Card with Large Image"][twtsummary]:
```html
<meta name="twitter:image" content="http://yoursite.com/images/my-twitter-image.jpg">
```
<meta name="twitter:image" content="http://example.com/images/my-twitter-image.jpg">
```
Let's assume you have an `image` field in the front matter of each of your content files:
```yaml
```
---
title: My Post
image: my-post-image.jpg
@ -52,12 +52,10 @@ image: my-post-image.jpg
You can then concatenate the `image` value (string) with the path to your `images` directory in `static` and leverage a URL-related templating function for increased flexibility:
{{% code file="partials/head/twitter-card.html" %}}
```html
{{< code file="partials/head/twitter-card.html" >}}
{{$socialimage := add "images/" .Params.image}}
<meta name="twitter:image" content="{{ $socialimage | absURL }}">
```
{{% /code %}}
{{< /code >}}
{{% note %}}
The `add` example above makes use of the [`absURL` function](/functions/absurl/). `absURL` and its relative companion `relURL` is the recommended way to construct URLs in Hugo.

4
content/functions/md5.md
View file

@ -21,13 +21,13 @@ aliases: []
```html
```
{{ md5 "Hello world, gophers!" }}
<!-- returns the string "b3029f756f98f79e7f1b7f1d1f0dd53b" -->
```
This can be useful if you want to use [Gravatar](https://en.gravatar.com/) for generating a unique avatar:
```html
```
<img src="https://www.gravatar.com/avatar/{{ md5 "your@email.com" }}?s=100&d=identicon">
```

4
content/functions/now.md
View file

@ -23,7 +23,7 @@ See [`time.Time`](https://godoc.org/time#Time).
For example, building your site on June 24, 2017 with the following templating:
```html
```
<div>
<small>&copy; {{ now.Format "2006"}}</small>
</div>
@ -31,7 +31,7 @@ For example, building your site on June 24, 2017 with the following templating:
Which will produce the following:
```html
```
<div>
<small>&copy; 2017</small>
</div>

8
content/functions/partialCached.md
View file

@ -21,17 +21,15 @@ aliases: []
The `partialCached` template function can offer significant performance gains for complex templates that don't need to be re-rendered on every invocation. Here is the simplest usage:
```golang
```
{{ partialCached "footer.html" . }}
```
You can also pass additional parameters to `partialCached` to create *variants* of the cached partial. For example, if you have a complex partial that should be identical when rendered for pages within the same section, you could use a variant based upon section so that the partial is only rendered once per section:
{{% code file="partial-cached-example.html" %}}
```
{{< code file="partial-cached-example.html" >}}
{{ partialCached "footer.html" . .Section }}
```
{{% /code %}}
{{< /code >}}
If you need to pass additional parameters to create unique variants, you can pass as many variant parameters as you need:

2
content/functions/printf.md
View file

@ -20,7 +20,7 @@ deprecated: false
See [the go doc](https://golang.org/pkg/fmt/) for additional information.
```golang
```
{{ i18n ( printf "combined_%s" $var ) }}
```

4
content/functions/querify.md
View file

@ -23,12 +23,12 @@ aliases: []
The following example creates a link to a search results page on Google.
```html
```
<a href="https://www.google.com?{{ (querify "q" "test" "page" 3) | safeURL }}">Search</a>
```
This example renders the following HTML:
```html
```
<a href="https://www.google.com?page=3&q=test">Search</a>
```

2
content/functions/readfile.md
View file

@ -22,7 +22,7 @@ Note that the filename must be relative to the current project working directory
So, if you have a file with the name `README.txt` in the root of your project with the content `Hugo Rocks!`:
```html
```
{{readFile "README.txt"}} → "Hugo Rocks!"
```

2
content/functions/ref.md
View file

@ -21,7 +21,7 @@ aliases: []
`ref` and `relRef` look up a content page by relative path (`relref`) or logical name (`ref`) to return the permalink. Both functions require a `Page` object (usually satisfied with a "`.`"):
```golang
```
{{ relref . "about.md" }}
```

6
content/functions/relLangURL.md
View file

@ -20,10 +20,10 @@ aliases: []
`absLangURL` and `relLangURL` functions are similar to their [`absURL`](/functions/absurl/) and [`relURL`](/functions/relurl/) relatives but will add the correct language prefix when the site is configured with more than one language. (See [Configuring Multilingual][multiliconfig].)
So for a site `baseURL` set to `http://yoursite.com/hugo/` and the current language is `en`:
So for a site `baseURL` set to `http://example.com/hugo/` and the current language is `en`:
```golang
{{ "blog/" | absLangURL }} → "http://yoursite.com/hugo/en/blog/"
```
{{ "blog/" | absLangURL }} → "http://example.com/hugo/en/blog/"
{{ "blog/" | relLangURL }} → "/hugo/en/blog/"
```

2
content/functions/relref.md
View file

@ -21,7 +21,7 @@ aliases: []
`ref` and `relRef` look up a content page by relative path (`relref`) or logical name (`ref`) to return the permalink. Both functions require a `Page` object (usually satisfied with a "`.`"):
```golang
```
{{ relref . "about.md" }}
```

12
content/functions/relurl.md
View file

@ -18,10 +18,10 @@ deprecated: false
aliases: []
---
Both `absURL` and `relURL` consider the configured value of `baseURL` in your site's [`config` file][configuration]. Given a `baseURL` set to `http://yoursite.com/hugo/`:
Both `absURL` and `relURL` consider the configured value of `baseURL` in your site's [`config` file][configuration]. Given a `baseURL` set to `http://example.com/hugo/`:
```golang
{{ "mystyle.css" | absURL }} → "http://yoursite.com/hugo/mystyle.css"
```
{{ "mystyle.css" | absURL }} → "http://example.com/hugo/mystyle.css"
{{ "mystyle.css" | relURL }} → "/hugo/mystyle.css"
{{ "http://gohugo.io/" | relURL }} → "http://gohugo.io/"
{{ "http://gohugo.io/" | absURL }} → "http://gohugo.io/"
@ -29,8 +29,7 @@ Both `absURL` and `relURL` consider the configured value of `baseURL` in your si
The last two examples may look strange but can be very useful. For example, the following shows how to use `absURL` in [JSON-LD structured data for SEO][jsonld] where some of your images for a piece of content may or may not be hosted locally:
{{% code file="layouts/partials/schemaorg-metadata.html" download="schemaorg-metadata.html" %}}
```html
{{< code file="layouts/partials/schemaorg-metadata.html" download="schemaorg-metadata.html" >}}
<script type="application/ld+json">
{
"@context" : "http://schema.org",
@ -38,8 +37,7 @@ The last two examples may look strange but can be very useful. For example, the
"image" : {{ apply .Params.images "absURL" "." }}
}
</script>
```
{{% /code %}}
{{< /code >}}
The above uses the [apply function][] and also exposes how the Go template parser JSON-encodes objects inside `<script>` tags. See [the safeJS template function][safejs] for examples of how to tell Hugo not to escape strings inside of such tags.

2
content/functions/render.md
View file

@ -25,7 +25,7 @@ This function is only available when applied to a single piece of content within
This example could render a piece of content using the content view located at `/layouts/_default/summary.html`:
```golang
```
{{ range .Data.Pages }}
{{ .Render "summary"}}
{{ end }}

2
content/functions/replacere.md
View file

@ -19,7 +19,7 @@ deprecated: false
aliases: []
---
```golang
```
{{ replaceRE "^https?://([^/]+).*" "$1" "http://gohugo.io/docs" }}` → "gohugo.io"
{{ "http://gohugo.io/docs" | replaceRE "^https?://([^/]+).*" "$1" }}` → "gohugo.io"
```

6
content/functions/safeHTML.md
View file

@ -22,19 +22,19 @@ It should not be used for HTML from a third-party, or HTML with unclosed tags or
Given a site-wide [`config.toml`][config] with the following `copyright` value:
```toml
```
copyright = "© 2015 Jane Doe. <a href=\"http://creativecommons.org/licenses/by/4.0/\">Some rights reserved</a>."
```
`{{ .Site.Copyright | safeHTML }}` in a template would then output:
```html
```
© 2015 Jane Doe. <a href="http://creativecommons.org/licenses/by/4.0/">Some rights reserved</a>.
```
However, without the `safeHTML` function, html/template assumes `.Site.Copyright` to be unsafe and therefore escapes all HTML tags and renders the whole string as plain text:
```html
```
<p>© 2015 Jane Doe. &lt;a href=&#34;http://creativecommons.org/licenses by/4.0/&#34;&gt;Some rights reserved&lt;/a&gt;.</p>
```

2
content/functions/safeHTMLAttr.md
View file

@ -21,7 +21,7 @@ aliases: []
Example: Given a site-wide `config.toml` that contains this menu entry:
```toml
```
[[menu.main]]
name = "IRC: #golang at freenode"
url = "irc://irc.freenode.net/#golang"

22
content/functions/safeURL.md
View file

@ -24,31 +24,27 @@ Without `safeURL`, only the URI schemes `http:`, `https:` and `mailto:` are cons
The following examples use a [site `config.toml`][configuration] with the following [menu entry][menus]:
{{% code file="config.toml" copy="false" %}}
```toml
{{< code file="config.toml" copy="false" >}}
[[menu.main]]
name = "IRC: #golang at freenode"
url = "irc://irc.freenode.net/#golang"
```
{{% /code %}}
{{< /code >}}
The following is an example of a sidebar partial that may be used in conjunction with the preceding front matter example:
{{% code file="layouts/partials/bad-url-sidebar-menu.html" copy="false" %}}
```html
{{< code file="layouts/partials/bad-url-sidebar-menu.html" copy="false" >}}
<!-- This unordered list may be part of a sidebar menu -->
<ul>
{{ range .Site.Menus.main }}
<li><a href="{{ .URL }}">{{ .Name }}</a></li>
{{ end }}
</ul>
```
{{% /code %}}
{{< /code >}}
This partial would produce the following HTML output:
{{% output file="bad-url-sidebar-menu-output.html" %}}
```html
```
<!-- This unordered list may be part of a sidebar menu -->
<ul>
<li><a href="#ZgotmplZ">IRC: #golang at freenode</a></li>
@ -58,19 +54,17 @@ This partial would produce the following HTML output:
The odd output can be remedied by adding ` | safeURL` to our `.Title` page variable:
{{% code file="layouts/partials/correct-url-sidebar-menu.html" copy="false" %}}
```html
{{< code file="layouts/partials/correct-url-sidebar-menu.html" copy="false" >}}
<!-- This unordered list may be part of a sidebar menu -->
<ul>
<li><a href="{{ .URL | safeURL }}">{{ .Name }}</a></li>
</ul>
```
{{% /code %}}
{{< /code >}}
With the `.URL` page variable piped through `safeURL`, we get the desired output:
{{% output file="correct-url-sidebar-menu-output.html" %}}
```html
```
<ul class="sidebar-menu">
<li><a href="irc://irc.freenode.net/#golang">IRC: #golang at freenode</a></li>
</ul>

4
content/functions/seq.md
View file

@ -34,14 +34,14 @@ It's named and used in the model of [GNU's seq][].
You can use `seq` in combination with `range` and `after`. The following will return 19 elements:
```golang
```
{{ range after 1 (seq 20)}}
{{ end }}
```
However, when ranging with an index, the following may be less confusing in that `$indexStartingAt1` and `$num` will return `1,2,3 ... 20`:
```golang
```
{{ range $index, $num := (seq 20) }}
$indexStartingAt1 := (add $index 1)
{{ end }}

4
content/functions/sha.md
View file

@ -21,14 +21,14 @@ aliases: []
`sha1` hashes the given input and returns its SHA1 checksum.
```html
```
{{ sha1 "Hello world, gophers!" }}
<!-- returns the string "c8b5b0e33d408246e30f53e32b8f7627a7a649d4" -->
```
`sha256` hashes the given input and returns its SHA256 checksum.
```html
```
{{ sha256 "Hello world, gophers!" }}
<!-- returns the string "6ec43b78da9669f50e4e422575c54bf87536954ccd58280219c393f2ce352b46" -->
```

8
content/functions/shuffle.md
View file

@ -20,19 +20,17 @@ draft: false
aliases: []
---
{{% code file="shuffle-input.html" %}}
```html
{{< code file="shuffle-input.html" >}}
<!-- Shuffled sequence = -->
<div>{{ shuffle (seq 1 5) }}</div>
<!-- Shuffled slice = -->
<div>{{ shuffle (slice "foo" "bar" "buzz") }}</div>
```
{{% /code %}}
{{< /code >}}
This example would return the following:
{{% output file="shuffle-output.html" %}}
```html
```
<!-- Shuffled sequence = -->
<div>2 5 3 1 4</div>
<!-- Shuffled slice = -->

6
content/functions/slice.md
View file

@ -23,12 +23,10 @@ toc: false
One use case is the concatenation of elements in combination with the [`delimit` function][]:
{{% code file="slice.html" %}}
```html
{{< code file="slice.html" >}}
{{ delimit (slice "foo" "bar" "buzz") ", " }}
<!-- returns the string "foo, bar, buzz" -->
```
{{% /code %}}
{{< /code >}}
[`delimit` function]: /functions/delimit/

2
content/functions/sort.md
View file

@ -21,7 +21,7 @@ aliases: []
A sorted array of map values will be returned with the keys eliminated. There are two optional arguments: `sortByField` and `sortAsc`. If left blank, sort will sort by keys (for maps) in ascending order as its default behavior.
```toml
```
+++
#tags: [ "tag3", "tag1", "tag2" ]
+++

6
content/functions/time.md
View file

@ -33,16 +33,14 @@ The following example takes a UNIX timestamp---set as `utimestamp: "1489276800"`
The following example may be useful when setting up [multilingual sites][multilingual]:
{{% code file="unix-to-month-integer.html" %}}
```html
{{< code file="unix-to-month-integer.html" >}}
{{$time := time (int .Params.addDate)}}
=> $time = 1489276800
{{$time.Month}}
=> "March"
{{$monthindex := printf "%d" $time.Month }}
=> $monthindex = 3
```
{{% /code %}}
{{< /code >}}
[int]: /functions/int/

4
content/functions/union.md
View file

@ -21,7 +21,7 @@ aliases: []
Given two arrays (or slices) A and B, this function will return a new array that contains the elements or objects that belong to either A or to B or to both. The elements supported are strings, integers, and floats (only float64).
```golang
```
{{ union (slice 1 2 3) (slice 3 4 5) }}
<!-- returns [1 2 3 4 5] -->
@ -38,7 +38,7 @@ Given two arrays (or slices) A and B, this function will return a new array that
This is also very useful to use as `OR` filters when combined with where:
```html
```
{{ $pages := where .Site.RegularPages "Type" "not in" (slice "page" "about") }}
{{ $pages := $pages | union (where .Site.RegularPages "Params.pinned" true) }}
{{ $pages := $pages | intersect (where .Site.RegularPages "Params.images" "!=" nil) }}

2
content/functions/uniq.md
View file

@ -20,7 +20,7 @@ aliases: []
needsexamples: false
---
```html
```
{{ uniq (slice 1 2 3 2) }}
{{ slice 1 2 3 2 | uniq }}
<!-- both return [1 2 3] -->

6
content/functions/unix.md
View file

@ -23,11 +23,9 @@ aliases: []
This very simple one-liner uses `now.Unix` to calculate the amount of time that has passed between the `.LastMod` for the current page and the last build of the current page.
{{% code file="time-passed.html" %}}
```golang
{{< code file="time-passed.html" >}}
{{ div (sub now.Unix .Lastmod.Unix) 86400 }}
```
{{% /code %}}
{{< /code >}}
Since both values are integers, they can be subtracted and then divided by the number of seconds in a day (i.e., `60 * 60 * 24 == 86400`).

14
content/functions/urlize.md
View file

@ -20,20 +20,17 @@ relatedfuncs: []
The following examples pull from a content file with the following front matter:
{{% code file="content/blog/greatest-city.md" copy="false"%}}
```toml
{{< code file="content/blog/greatest-city.md" copy="false">}}
+++
title = "The World's Greatest City"
location = "Chicago IL"
tags = ["pizza","beer","hot dogs"]
+++
```
{{% /code %}}
{{< /code >}}
The following might be used as a partial within a [single page template][singletemplate]:
{{% code file="layouts/partials/content-header.html" download="content-header.html" %}}
```html
{{< code file="layouts/partials/content-header.html" download="content-header.html" >}}
<header>
<h1>{{.Title}}</h1>
{{ with .Params.location }}
@ -50,13 +47,12 @@ The following might be used as a partial within a [single page template][singlet
</ul>
{{ end }}
</header>
```
{{% /code %}}
{{< /code >}}
The preceding partial would then output to the rendered page as follows, assuming the page is being built with Hugo's default pretty URLs.
{{% output file="/blog/greatest-city/index.html" %}}
```html
```
<header>
<h1>The World's Greatest City</h1>
<div><a href="/locations/chicago-il/">Chicago IL</a></div>

26
content/functions/where.md
View file

@ -22,7 +22,7 @@ needsexample: true
`where` filters an array to only the elements containing a matching value for a given field.
```html
```
{{ range where .Data.Pages "Section" "post" }}
{{ .Content }}
{{ end }}
@ -30,13 +30,13 @@ needsexample: true
It can be used by dot-chaining the second argument to refer to a nested element of a value.
```toml
```
+++
series: golang
+++
```
```html
```
{{ range where .Site.Pages "Params.series" "golang" }}
{{ .Content }}
{{ end }}
@ -44,7 +44,7 @@ series: golang
It can also be used with the logical operators `!=`, `>=`, `in`, etc. Without an operator, `where` compares a given field with a matching value equivalent to `=`.
```html
```
{{ range where .Data.Pages "Section" "!=" "post" }}
{{ .Content }}
{{ end }}
@ -81,7 +81,7 @@ The following logical operators are vailable with `where`:
## Use `where` with `intersect`
```html
```
{{ range where .Site.Pages ".Params.tags" "intersect" .Params.tags }}
{{ if ne .Permalink $.Permalink }}
{{ .Render "summary" }}
@ -91,33 +91,29 @@ The following logical operators are vailable with `where`:
You can also put the returned value of the `where` clauses into a variable:
{{% code file="where-intersect-variables.html" %}}
```html
{{< code file="where-intersect-variables.html" >}}
{{ $v1 := where .Site.Pages "Params.a" "v1" }}
{{ $v2 := where .Site.Pages "Params.b" "v2" }}
{{ $filtered := $v1 | intersect $v2 }}
{{ range $filtered }}
{{ end }}
```
{{% /code %}}
{{< /code >}}
## Use `where` with `first`
The following grabs the first five content files in `post` using the [default ordering](/templates/lists/) for lists (i.e., `weight => date`):
{{% code file="where-with-first.html" %}}
```html
{{< code file="where-with-first.html" >}}
{{ range first 5 (where .Data.Pages "Section" "post") }}
{{ .Content }}
{{ end }}
```
{{% /code %}}
{{< /code >}}
## Nest `where` Clauses
You can also nest `where` clauses to drill down on lists of content by more than one parameter. The following first grabs all pages in the "blog" section and then ranges through the result of the first `where` clause and finds all pages that are *not* featured:
```html
```
{{ range where (where .Data.Pages "Section" "blog" ) ".Params.featured" "!=" "true" }}
```
@ -132,7 +128,7 @@ Only the following operators are available for `nil`
* `=`, `==`, `eq`: True if the given field is not set.
* `!=`, `<>`, `ne`: True if the given field is set.
```html
```
{{ range where .Data.Pages ".Params.specialpost" "!=" nil }}
{{ .Content }}
{{ end }}

6
content/functions/with.md
View file

@ -22,12 +22,10 @@ An alternative way of writing an `if` statement and then referencing the same va
The following example checks for a [user-defined site variable](/variables/site/) called `twitteruser`. If the key-value is not set, the following will render nothing:
{{% code file="layouts/partials/twitter.html" %}}
```html
{{< code file="layouts/partials/twitter.html" >}}
{{with .Site.Params.twitteruser}}<span class="twitter">
<a href="https://twitter.com/{{.}}" rel="author">
<img src="/images/twitter.png" width="48" height="48" title="Twitter: {{.}}"
alt="Twitter"></a>
</span>{{end}}
```
{{% /code %}}
{{< /code >}}

4
content/getting-started/_index.md
View file

@ -1,6 +1,6 @@
---
title: Getting Started
linktitle: Getting Started Overview
title: Get Started
linktitle: Get Started Overview
description: Quick start and guides for installing Hugo on your preferred operating system.
date: 2017-02-01
publishdate: 2017-02-01

40
content/getting-started/configuration.md
View file

@ -1,5 +1,5 @@
---
title: Configuring Hugo
title: Configure Hugo
linktitle: Configuration
description: Often the default settings are good enough, but the config file can provide highly granular control over how your site is rendered.
date: 2013-07-01
@ -36,8 +36,7 @@ In your `config` file, you can direct Hugo as to how you want your website rende
The following is a typical example of a YAML configuration file. Note the document opens with 3 hyphens and closes with 3 periods. The values nested under `params:` will populate the [`.Site.Params`][] variable for use in [templates][]:
{{% code file="config.yml"%}}
```yaml
{{< code file="config.yml">}}
---
baseURL: "https://yoursite.example.com/"
title: "My Hugo Site"
@ -53,15 +52,13 @@ params:
- "foo2"
SidebarRecentLimit: 5
...
```
{{% /code %}}
{{< /code >}}
### All Variables, YAML
The following is the full list of Hugo-defined variables in an example YAML file. The values provided in this example represent the default values used by Hugo.
{{% code file="config.yml" download="config.yml" %}}
```yaml
{{< code file="config.yml" download="config.yml" >}}
---
archetypeDir: "archetypes"
# hostname (and path) to the root, e.g. http://spf13.com/
@ -170,14 +167,13 @@ taxonomies:
- category: "categories"
- tag: "tags"
---
```
{{% /code %}}
{{< /code >}}
## TOML Configuration
The following is an example of a TOML configuration file. The values under `[params]` will populate the `.Site.Params` variable for use in [templates][]:
```toml
```
contentDir = "content"
layoutDir = "layouts"
publishDir = "public"
@ -199,8 +195,7 @@ title = "My Hugo Site"
The following is the full list of Hugo-defined variables in an example TOML file. The values provided in this example represent the default values used by Hugo.
{{% code file="config.toml" download="config.toml"%}}
```toml
{{< code file="config.toml" download="config.toml">}}
+++
archetypeDir = "archetypes"
# hostname (and path) to the root, e.g. http://spf13.com/
@ -309,12 +304,11 @@ watch = true
category = "categories"
tag = "tags"
+++
```
{{% /code %}}
{{< /code >}}
{{% note %}}
If you are developing your site on a \*nix machine, here is a handy shortcut for finding a configuration option from the command line:
```bash
```
~/sites/yourhugosite
hugo config | grep emoji
enableemoji: true
@ -327,7 +321,7 @@ In addition to the 3 config options already mentioned, configuration key-values
For example, the following command will effectively set a website's title on Unix-like systems:
```bash
```
$ env HUGO_TITLE="Some Title" hugo
```
@ -339,7 +333,7 @@ Names must be prefixed with `HUGO_` and the configuration key must be set in upp
The following statement inside `./config.toml` will cause Hugo to ignore files ending with `.foo` and `.boo` when rendering:
```toml
```
ignoreFiles = [ "\\.foo$", "\\.boo$" ]
```
@ -360,26 +354,22 @@ However, if you have specific needs with respect to Markdown, Hugo exposes some
2. Blackfriday flags must be grouped under the `blackfriday` key and can be set on both the site level *and* the page level. Any setting on a page will override its respective site setting.
{{% /note %}}
{{% code file="bf-config.toml" %}}
```toml
{{< code file="bf-config.toml" >}}
[blackfriday]
angledQuotes = true
fractions = false
plainIDAnchors = true
extensions = ["hardLineBreak"]
```
{{% /code %}}
{{< /code >}}
{{% code file="bf-config.yml" %}}
```yaml
{{< code file="bf-config.yml" >}}
blackfriday:
angledQuotes: true
fractions: false
plainIDAnchors: true
extensions:
- hardLineBreak
```
{{% /code %}}
{{< /code >}}
## Configure Additional Output Formats

2
content/getting-started/directory-structure.md
View file

@ -22,7 +22,7 @@ toc: true
Running the `hugo new site` generator from the command line will create a directory structure with the following elements:
```bash
```
.
├── archetypes
├── config.toml

66
content/getting-started/installing.md
View file

@ -47,11 +47,9 @@ Ideally, you should install it somewhere in your `PATH` for easy use. `/usr/loca
If you are on macOS and using [Homebrew][brew], you can install Hugo with the following one-liner:
{{% code file="install-with-homebrew.sh" %}}
```bash
{{< code file="install-with-homebrew.sh" >}}
brew install hugo
```
{{% /code %}}
{{< /code >}}
For more detailed explanations, read the installation guides that follow for installing on macOS and Windows.
@ -59,11 +57,9 @@ For more detailed explanations, read the installation guides that follow for ins
If you are on a Windows machine and use [Chocolatey][] for package management, you can install Hugo with the following one-liner:
{{% code file="install-with-chocolatey.ps1" %}}
```powershell
{{< code file="install-with-chocolatey.ps1" >}}
choco install hugo -confirm
```
{{% /code %}}
{{< /code >}}
### Source
@ -79,13 +75,11 @@ Hugo uses [govendor][] to vendor dependencies, but we don't commit the vendored
#### Fetch from GitHub
{{% code file="from-gh.sh" %}}
```sh
{{< code file="from-gh.sh" >}}
go get github.com/kardianos/govendor
govendor get github.com/gohugoio/hugo
go install github.com/gohugoio/hugo
```
{{% /code %}}
{{< /code >}}
`govendor get` will fetch Hugo and all its dependent libraries to `$GOPATH/src/github.com/gohugoio/hugo`, and `go install` compiles everything into a final `hugo` (or `hugo.exe`) executable inside `$GOPATH/bin/`.
@ -131,25 +125,21 @@ Since building from source is appealing to more seasoned command line users, thi
Go to the `brew` website, <https://brew.sh/>, and follow the directions there. The most important step is the installation from the command line:
{{% code file="install-brew.sh" %}}
```bash
{{< code file="install-brew.sh" >}}
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```
{{% /code %}}
{{< /code >}}
#### Step 2: Run the `brew` Command to Install `hugo`
Installing Hugo using `brew` is as easy as the following:
{{% code file="install-brew.sh" %}}
```bash
{{< code file="install-brew.sh" >}}
brew install hugo
```
{{% /code %}}
{{< /code >}}
If Homebrew is working properly, you should see something similar to the following:
```sh
```
==> Downloading https://homebrew.bintray.com/bottles/hugo-0.21.sierra.bottle.tar.gz
######################################################################### 100.0%
==> Pouring hugo-0.21.sierra.bottle.tar.gz
@ -162,7 +152,7 @@ Replace `brew install hugo` with `brew install hugo --HEAD` if you want the abso
`brew` should have updated your path to include Hugo. You can confirm by opening a new terminal window and running a few commands:
```bash
```
$ # show the location of the hugo executable
which hugo
/usr/local/bin/hugo
@ -204,7 +194,7 @@ All three locations will work for you. In the interest of brevity, this guide fo
Verify that the tarball wasn't corrupted during the download:
```bash
```
tar tvf ~/Downloads/hugo_X.Y_osx-64bit.tgz
-rwxrwxrwx 0 0 0 0 Feb 22 04:02 hugo_X.Y_osx-64bit/hugo_X.Y_osx-64bit.tgz
-rwxrwxrwx 0 0 0 0 Feb 22 03:24 hugo_X.Y_osx-64bit/README.md
@ -215,7 +205,7 @@ The `.md` files are documentation for Hugo. The other file is the executable.
#### Step 4: Install Into Your `bin` Directory
```bash
```
# create the directory if needed
mkdir -p ~/bin
@ -237,7 +227,7 @@ Hugo Static Site Generator v0.13 BuildDate: 2015-02-22T04:02:30-06:00
You may need to add your bin directory to your `PATH` variable. The `which` command will check for us. If it can find `hugo`, it will print the full path to it. Otherwise, it will not print anything.
```bash
```
# check if hugo is in the path
which hugo
/Users/USERNAME/bin/hugo
@ -245,13 +235,13 @@ which hugo
If `hugo` is not in your `PATH`, add it by updating your `~/.bash_profile` file. First, start up an editor:
```bash
```
nano ~/.bash_profile
```
Add a line to update your `PATH` variable:
```bash
```
export PATH=$PATH:$HOME/bin
```
@ -265,7 +255,7 @@ You've successfully installed Hugo.
If you want to compile Hugo yourself, you'll need to install Go (aka Golang). You can [install Go directly from the Go website](https://golang.org/dl/) or via Homebrew using the following command:
```bash
```
brew install go
```
@ -273,7 +263,7 @@ brew install go
If you want to compile a specific version of Hugo, go to <https://github.com/gohugoio/hugo/releases> and download the source code for the version of your choice. If you want to compile Hugo with all the latest changes (which might include bugs), clone the Hugo repository:
```bash
```
git clone https://github.com/gohugoio/hugo
```
@ -285,7 +275,7 @@ Cloning the Hugo repository directly means taking the good with the bad. By usin
Make the directory containing the source your working directory and then fetch Hugo's dependencies:
```bash
```
mkdir -p src/github.com/gohugoio
ln -sf $(pwd) src/github.com/gohugoio/hugo
@ -299,7 +289,7 @@ This will fetch the absolute latest version of the dependencies. If Hugo fails t
Once you have properly configured your directory, you can compile Hugo using the following command:
```bash
```
go build -o hugo main.go
```
@ -369,7 +359,7 @@ Run a few commands to verify that the executable is ready to run, and then build
At the prompt, type `hugo help` and press the <kbd>Enter</kbd> key. You should see output that starts with:
```powershell
```
hugo is the main command, used to build your Hugo site.
Hugo is a Fast and Flexible Static Site Generator
@ -382,7 +372,7 @@ If you do, then the installation is complete. If you don't, double-check the pat
At the prompt, change your directory to the `Sites` directory.
```powershell
```
C:\Program Files> cd C:\Hugo\Sites
C:\Hugo\Sites>
```
@ -391,13 +381,13 @@ C:\Hugo\Sites>
Run the command to generate a new site. I'm using `example.com` as the name of the site.
```powershell
```
C:\Hugo\Sites> hugo new site example.com
```
You should now have a directory at `C:\Hugo\Sites\example.com`. Change into that directory and list the contents. You should get output similar to the following:
```powershell
```
C:\Hugo\Sites&gt;cd example.com
C:\Hugo\Sites\example.com&gt;dir
&nbsp;Directory of C:\hugo\sites\example.com
@ -426,7 +416,7 @@ C:\Hugo\Sites\example.com&gt;dir
In any of the [Linux distributions that support snaps](https://snapcraft.io/docs/core/install):
```sh
```
sudo apt install hugo
```
@ -445,7 +435,7 @@ You can also install Hugo from the [Arch user repository](https://aur.archlinux.
Be aware that Hugo is built from source. This means that additional tools like [Git](https://git-scm.com) and [Go](https://golang.org/doc/install) will be installed as well.
```bash
```
sudo pacman -S yaourt
yaourt -S hugo
```
@ -461,7 +451,7 @@ See the [related discussion in the Hugo forums][redhatforum].
In any of the [Linux distributions that support snaps][snaps]:
```bash
```
snap install hugo
```

124
content/getting-started/quick-start.md
View file

@ -36,7 +36,7 @@ If you're on Windows, this Quick Start will assume you're using [Git Bash](https
Once `hugo` is installed, make sure to run the `help` command to verify `hugo` installation. The following is an abridged version of what will write to the console when entering the command:
```bash
```
hugo help
hugo is the main command, used to build your Hugo site.
@ -49,11 +49,11 @@ Complete documentation is available at http://gohugo.io/.
You can check the version of Hugo you're currently using with the `hugo version` command:
```bash
```
hugo version
```
```bash
```
Hugo Static Site Generator v0.18.1 BuildDate: 2016-12-30T05:02:43-05:00
```
@ -61,13 +61,13 @@ Hugo Static Site Generator v0.18.1 BuildDate: 2016-12-30T05:02:43-05:00
Hugo's CLI has commands that allow you to quickly scaffold a new website. Navigate to your preferred location on your file system and create a new Hugo site `bookshelf` by executing the `hugo new` command:
```bash
```
hugo new site bookshelf
```
Change into the newly created `bookshelf` directory. Listing the new directory's content will show the following:
```bash
```
.
├── archetypes
├── config.toml
@ -94,21 +94,19 @@ You'll see the `bookshelf` directory has 6 subdirectories and 1 file. Let's look
Let's now add a post to our "bookshelf." We will use the `hugo new` command to add a post. This first post will be on the book [*Good To Great*][bookurl]. Make sure you are inside the `bookshelf` directory.
{{% code file="create-new-book-review-post.sh" %}}
```bash
{{< code file="create-new-book-review-post.sh" >}}
hugo new post/good-to-great.md
```
{{% /code %}}
{{< /code >}}
You should then see the following output:
```bash
```
/Users/yourusername/bookshelf/content/post/good-to-great.md created
```
The above command will create a new directory `post` inside the `content` directory and create `content/post/good-to-great.md`. The directory for your Hugo project will now look like the following:
```bash
```
.
├── archetypes
├── config.toml
@ -123,7 +121,7 @@ The above command will create a new directory `post` inside the `content` direct
Open `good-to-great.md` in your preferred text editor:
```toml
```
+++
date = "2017-02-19T21:09:05-06:00"
title = "good to great"
@ -140,8 +138,7 @@ The text bracketed by `+++` is the TOML [front matter][fm] for the content. Fron
Let's update `good-to-great.md` with a short review of *Good to Great*:
{{% code file="good-to-great-start.md" %}}
```markdown
{{< code file="good-to-great-start.md" >}}
+++
date = "2016-02-14T16:11:58+05:30"
draft = true
@ -149,20 +146,19 @@ title = "Good to Great Book Review"
+++
I read **Good to Great in January 2016**. An awesome read sharing detailed analysis on how good companies became great. Although this book is about how companies became great but we could apply a lot of the learnings on ourselves. Concepts like level 5 leader, hedgehog concept, the stockdale paradox are equally applicable to individuals.
```
{{% /code %}}
{{< /code >}}
## Step 4. Serve Content
Hugo has a built-in server that can serve your website locally for easy previewing and development. To serve content, execute the following command inside the `bookshelf` directory:
```bash
```
hugo server
```
You should see something similar to the following output:
```bash
```
Built site for language en:
0 of 1 draft rendered
0 future content
@ -187,13 +183,13 @@ This will start the server on port `1313`. You can view your blog at <http://loc
Kill the server using <kbd>Ctrl</kbd> + <kbd>C</kbd> and then rerun the server with the `--buildDrafts` flag appended to the command:
```bash
```
hugo server --buildDrafts
```
You should now see something similar to the following:
```bash
```
Built site for language en:
1 of 1 draft rendered
0 future content
@ -225,7 +221,7 @@ Hugo currently doesn’t ship with a default theme, thus allowing end users to p
Themes should be added in the `themes` directory, one of the directories scaffolded with the `hugo new site` command we used to start our Hugo project. To install our themes, first change into the `themes` directory:
```bash
```
cd themes
```
@ -233,23 +229,19 @@ You can clone one or more themes from within the `themes` directory. We will use
Once inside the `themes` directory, you can use the following one-liner to clone Robust, check out the specific commit, and then return to your project's root directory:
{{% code file="clone-robust-theme" %}}
```bash
{{< code file="clone-robust-theme" >}}
git clone https://github.com/dim0627/hugo_theme_robust.git && cd hugo_theme_robust && git checkout 3baae29 && cd ../..
```
{{% /code %}}
{{< /code >}}
Now let's start Hugo's server again but with the addition of the `-theme` flag for Robust:
{{% code file="hugo-server-with-theme.sh" %}}
```bash
{{< code file="hugo-server-with-theme.sh" >}}
hugo server --theme=hugo_theme_robust --buildDrafts
```
{{% /code %}}
{{< /code >}}
You should see an output to the console similar to the following:
```bash
```
Built site for language en:
1 of 1 draft rendered
0 future content
@ -270,7 +262,7 @@ Press Ctrl+C to stop
If Hugo doesn't find the specified theme in the `themes` directory,
it will throw an exception:
```bash
```
FATAL: 2016/02/14 Unable to find theme Directory: /Users/yourusername/bookshelf/themes/robust
```
@ -280,7 +272,7 @@ To view your website, you can go to <http://localhost:1313/>. You should see som
Similar to the way we looked at the scaffolding for our new Hugo website, let's take a look at what comprises a typical Hugo theme. The following is only a selection of what you would see if you were to list out the contents of the Robust theme directory. These are also some of the default files created by Hugo as of v0.23. (See [Creating a Theme][createtheme])
```bash
```
.
├── LICENSE.md
├── archetypes
@ -310,19 +302,15 @@ You can very easily switch between different themes in Hugo. Let's suppose we wa
From your project root, you can use this one-liner to change into `themes`, clone Bleak, and go back to your project's root directory:
{{% code file="clone-bleak-theme.sh" %}}
```bash
{{< code file="clone-bleak-theme.sh" >}}
cd themes && git clone https://github.com/Zenithar/hugo-theme-bleak.git && cd ..
```
{{% /code %}}
{{< /code >}}
Now restart the server with our new theme flag:
{{% code file="run-server-with-bleak.sh" %}}
```bash
{{< code file="run-server-with-bleak.sh" >}}
hugo server --theme=hugo-theme-bleak --buildDrafts
```
{{% /code %}}
{{< /code >}}
Our website is now using the `bleak` theme at <http://localhost:1313>, which should look similar to the following screenshot:
@ -332,26 +320,22 @@ Our website is now using the `bleak` theme at <http://localhost:1313>, which sho
Kill the Hugo server if you are still running it with the Bleak theme, and then restart the server with the `robust` theme. We will use Robust for the duration of this Quick Start:
{{% code file="restart-with-robust-sh" %}}
```bash
{{< code file="restart-with-robust-sh" >}}
hugo server --theme=hugo_theme_robust --buildDrafts
```
{{% /code %}}
{{< /code >}}
### Update Our `config.toml`
Our website is currently using the dummy values specified in `bookshelf/config.toml`, which were auto-generated with `hugo new site bookshelf`. Let's update the configuration:
{{% code file="updated-config.toml" %}}
```toml
{{< code file="updated-config.toml" >}}
baseURL = "http://example.org/"
languageCode = "en-us"
title = "Shekhar Gulati Book Reviews"
[Params]
Author = "Shekhar Gulati"
```
{{% /code %}}
{{< /code >}}
### Watch Your Site Reload Instantly
@ -393,7 +377,7 @@ Hugo will sync the changes and reload the website to use the new image:
Now we need to change the layout of the index page so that only images are shown instead of the text. The file at `themes/hugo_theme_robust/layouts/index.html` refers to a partial `li.html` template that renders the following list view:
```html
```
<article class="li">
<a href="{{ .Permalink }}" class="clearfix">
<div class="image" style="background-image: url({{ $.Site.BaseURL }}images/{{ with .Params.image }}{{ . }}{{ else }}default.jpg{{ end }});"></div>
@ -408,23 +392,19 @@ Now we need to change the layout of the index page so that only images are shown
Create a new file for `li.html` inside the `bookshelf/layouts/_default` directory. If you are in your project root, you can use the following one-liner to both create the file and return to the project root:
{{% code file="create-new-li-html.sh" %}}
```bash
{{< code file="create-new-li-html.sh" >}}
cd layouts && mkdir _default && cd _default && touch li.html && cd ../..
```
{{% /code %}}
{{< /code >}}
Copy the content shown below into the new `li.html`. When contrasting this with the `li.html` that ships with the Robust theme, you'll notice we have removed details of the book so that only the image is shown:
{{% code file="layouts/_default/li.html" %}}
```html
{{< code file="layouts/_default/li.html" >}}
<article class="li">
<a href="{{ .Permalink }}" class="clearfix">
<div class="image" style="background-image: url({{ $.Site.BaseURL }}images/{{ with .Params.image }}{{ . }}{{ else }}default.jpg{{ end }});"></div>
</a>
</article>
```
{{% /code %}}
{{< /code >}}
Now, the website should render similar to the following screenshot:
@ -434,27 +414,22 @@ Next, we want to remove information related to the theme from the footer. Let's
This is a new [partial template][partials]. If you are still in the project's root directory, you can use the following one-liner to create the partial before returning to the project root:
{{% code file="create-new-default-foot.sh" %}}
```bash
{{< code file="create-new-default-foot.sh" >}}
cd layouts && mkdir partials && cd partials && touch default_foot.html && cd ../..
```
{{% /code %}}
{{< /code >}}
Now add the following to our new `default_foot.html` partial template:
{{% code file="layouts/partials/default_foot.html" %}}
```html
{{< code file="layouts/partials/default_foot.html" >}}
<footer class="site">
<p>{{ with .Site.Copyright | safeHTML }}{{ . }}{{ else }}&copy; {{ $.Site.LastChange.Year }} {{ if isset $.Site.Params "Author" }}{{ $.Site.Params.Author }}{{ else }}{{ .Site.Title }}{{ end }}{{ end }}</p>
<p>Powered by <a href="http://gohugo.io" target="_blank">Hugo</a>,</p>
</footer>
```
{{% /code %}}
{{< /code >}}
So far we are using the default image, but we would like to use the book image so that we can relate to the book. Every book review will define a configuration setting in its front matter. Update the content and front matter of `good-to-great.md` as shown below.
{{% code file="content/post/good-to-great.md" %}}
```markdown
{{< code file="content/post/good-to-great.md" >}}
+++
date = "2017-02-19T21:09:05-06:00"
draft = true
@ -463,8 +438,7 @@ image = "good-to-great.jpg"
+++
I read **Good to Great in January 2016**. An awesome read sharing detailed analysis on how good companies became great. Although this book is about how companies became great but we could apply a lot of the learnings on ourselves. Concepts like level 5 leader, hedgehog concept, the stockdale paradox are equally applicable to individuals.
```
{{% /code %}}
{{< /code >}}
Grab a (legal) image from somewhere, name it `good-to-great.jpg`, and place it in the `bookshelf/static/images` directory.
@ -477,13 +451,13 @@ After adding a few more books to our shelf, the shelf appears as shown below.
So far, all the posts that we have written are in draft status (i.e., `draft = true`). To make a draft public, you can run a Hugo CLI command or manually change the draft status in the post's front matter to `false`. Hugo provides a handy command line argument called `undraft` to do this for us:
```bash
```
hugo undraft content/post/good-to-great.md
```
If we check the front matter of `good-to-great.md` after running this command, we'll notice that Hugo has written the change of draft status to the file:
```toml
```
+++
date = "2017-02-19T22:42:53-06:00"
draft = false
@ -494,7 +468,7 @@ image = "good-to-great.jpg"
Now, we can start the server *without* the `buildDrafts` option.
```bash
```
hugo server --theme=hugo_theme_robust
```
@ -506,7 +480,7 @@ To implement Disqus comments as part of the Quick Start, you'll need to set up a
To enable Disqus on our new site, we only need to update the `disqusShortname` in the config.toml as shown below.
```toml
```
[Params]
Author = "Shekhar Gulati"
disqusShortname = <your disqus shortname>
@ -520,13 +494,13 @@ Now, commenting will be enabled in your blog.
To generate a website that can be deployed to GitHub pages, we first need to change the `baseURL` in our configuration as follows:
```toml
```
baseURL = "https://<yourgithubusername>.github.io/bookshelf/"
```
Then type the following command while in the root directory of your Hugo project:
```bash
```
hugo --theme=hugo_theme_robust
0 draft content
0 future content

20
content/getting-started/usage.md
View file

@ -24,13 +24,13 @@ The following is a description of the most command commands you will use while d
Once you have [installed Hugo][install], make sure it is in your `PATH`. You can test that Hugo has been installed correctly via the `help` command:
```bash
```
hugo help
```
The output you see in your console should be similar to the following:
```bash
```
hugo is the main command, used to build your Hugo site.
Hugo is a Fast and Flexible Static Site Generator
@ -104,7 +104,7 @@ This generates your website to the `public/` directory by default, although you
The site Hugo renders into `public/` is ready to be deployed to your web server:
```bash
```
hugo
0 draft content
0 future content
@ -133,7 +133,7 @@ All three of these can be overridden during both local development *and* deploym
Hugo comes with [LiveReload](https://github.com/livereload/livereload-js) built in. There are no additional packages to install. A common way to use Hugo while developing a site is to have Hugo run a server with the `hugo server` command and watch for changes:
```bash
```
hugo server
0 draft content
0 future content
@ -172,23 +172,23 @@ LiveReload works by injecting JavaScript into the pages Hugo generates. The scri
LiveReload is awesome for development. However, some Hugo users may use `hugo server` in production to instantly display updated content. The following methods make it easy to disable LiveReload:
```bash
```
hugo server --watch=false
```
Or...
```bash
```
hugo server --disableLiveReload
```
The latter flag can be omitted by adding the following key-value to your `config.toml` or `config.yml` file, respectively:
```toml
```
disableLiveReload = true
```
```yaml
```
disableLiveReload: true
```
@ -208,13 +208,13 @@ Hugo does not remove generated files before building. An easy workaround is to u
To start a server that builds draft content (helpful for editing), you can specify a different destination; e.g., a `dev/` directory:
```bash
```
hugo server -wDs ~/Code/hugo/docs -d dev
```
When the content is ready for publishing, use the default `public/` dir:
```bash
```
hugo -s ~/Code/hugo/docs
```

16
content/hosting-and-deployment/deployment-with-rsync.md
View file

@ -27,7 +27,7 @@ notesforauthors:
The spoiler is that you can deploy your entire website with a command that looks like the following:
```bash
```
hugo && rsync -avz --delete public/ www-data@ftp.topologix.fr:~/www/
```
@ -39,15 +39,13 @@ If it is not done yet, we will make an automated way to SSH to your server. If y
First, install the ssh client. On Debian/Ubuntu/derivates, use the following command:
{{% code file="install-openssh.sh" %}}
```bash
{{< code file="install-openssh.sh" >}}
sudo apt-get install openssh-client
```
{{% /code %}}
{{< /code >}}
Then generate your ssh key by entering the following commands:
```bash
```
~$ cd && mkdir .ssh & cd .ssh
~/.ssh/$ ssh-keygen -t rsa -q -C "For SSH" -f rsa_id
~/.ssh/$ cat >> config <<EOF
@ -61,7 +59,7 @@ EOF
Don't forget to replace the `HOST` and `USER` values with your own ones. Then copy your ssh public key to the remote server:
```bash
```
~/.ssh/$ ssh-copy-id -i rsa_id.pub USER@HOST.com
```
@ -78,13 +76,13 @@ And you've done it!
We will put the first command in a script at the root of your Hugo tree:
```bash
```
~/websites/topologix.fr$ editor deploy
```
Here you put the following content. Replace the `USER`, `HOST`, and `DIR` values with your own:
```bash
```
#!/bin/sh
USER=my-user
HOST=my-server.com

68
content/hosting-and-deployment/deployment-with-wercker.md
View file

@ -47,33 +47,27 @@ All the work for setting up a Hugo project and using this guide is done via the
First, create your new Hugo website using the [`hugo new site` command][basicusage] and change into the newly created directory for the project. In this guide, we are calling our new project `hugo-wercker-example`:
{{% code file="hugo-new-site.sh" %}}
```bash
{{< code file="hugo-new-site.sh" >}}
hugo new site hugo-wercker-example
cd hugo-wercker-example
```
{{% /code %}}
{{< /code >}}
We will use the [Herring Cove theme][] by first cloning the theme into the `themes` directory.
{{% code file="clone-herring-cove-theme.sh" %}}
```bash
{{< code file="clone-herring-cove-theme.sh" >}}
cd themes
git clone https://github.com/spf13/herring-cove.git
```
{{% /code %}}
{{< /code >}}
Cloning the project from the command line will conflict with our own version control. So, we need to remove the external git configuration that came with the clone of Herring Cove:
{{% code file="remove-herring-cove-git.sh" %}}
```bash
{{< code file="remove-herring-cove-git.sh" >}}
rm -rf herring-cove/.git
```
{{% /code %}}
{{< /code >}}
We need content for Hugo to build. Let's add a quick `/about` page:
```bash
```
hugo new about.md
```
@ -83,15 +77,13 @@ The preceding example for the about page leverages archetypes to scaffold a new
Now you can edit `contents/about.md` in your text editor of choice, but this is not necessary for the purposes of this guide. Running the following command will build your Hugo site into the `public` directory. We have added `undraft` to ensure that the example page is no longer in draft mode:
{{% code file="hugo-build-undraft.sh" %}}
```bash
{{< code file="hugo-build-undraft.sh" >}}
hugo undraft content/about.md
```
{{% /code %}}
{{< /code >}}
Once the website is build, t's a good idea to run the following command to start a local server and ensure you're changes have been implemented:
```bash
```
hugo server --theme=herring-cove
```
@ -103,29 +95,25 @@ If everything is fine, you should see something similar to the image below when
Adding Git to your project is done by running the `git init` command from the root directory of your project.
```bash
```
git init
```
Running `git status` at this point will show you the following entries: the `config.toml` file, the `themes` directory, the `contents` directory, and the `public` directory. However, we don't want the `public` directory version controlled because Wercker is responsible for generating the finished website later on. Therefore, we'll add a `.gitignore` file to our project that will exclude the `/public` directory from being tracked by Git:
{{% code file="gitignore.sh" %}}
```bash
{{< code file="gitignore.sh" >}}
echo "/public" >> .gitignore
```
{{% /code %}}
{{< /code >}}
Wercker might complain when we try to build the site later on because we currently do not have any static files outside of the `themes` directory. We simply have to add *any* file to the static folder to prevent Wercker from complaining. To keep this guide simple, let's add a `robots.txt`. The following command creates the file in `/static`. The contents of the `robots.txt` lets search engines know they have full access to crawl the published website:
{{% code file="addrobotstxt.sh" %}}
```bash
{{< code file="addrobotstxt.sh" >}}
echo "User-agent: *\nDisallow:" > static/robots.txt
```
{{% /code %}}
{{< /code >}}
Now we need to add (i.e., [stage [see Git documentation]][gitbasics]) and commit all of our changes in the repository into Git:
```bash
```
git commit -a -m "Initial commit"
```
@ -135,12 +123,10 @@ Now we need to create a new repository on GitHub. Once you are signed in to GitH
We then choose a name for the project (`hugo-wercker-example`). When clicking on create repository GitHub displays the commands for adding an existing project to the site. The commands shown below are the ones used for this site, if you're following along you will need to use the ones shown by GitHub. Once we've run those commands the project is in GitHub and we can move on to setting up the Wercker configuration. Be sure to replace `YourUserName` with your GitHub account/username:
{{% code file="setup-gh-repo.sh" %}}
```bash
{{< code file="setup-gh-repo.sh" >}}
git remote add origin git@github.com:YourUsername/hugo-wercker-example.git
git push -u origin master
```
{{% /code %}}
{{< /code >}}
![][2]
@ -230,8 +216,7 @@ We're not going to use any of the advanced features of Hugo-Build in this guide.
The docs are a work in progress. As such, the `version` represented in this guide may not represent the version you've been using for local development. Be sure to use the appropriate Hugo version for your build step.
{{% /warning %}}
{{% code file="wercker-build-step.yml" %}}
```yaml
{{< code file="wercker-build-step.yml" >}}
box: debian
build:
steps:
@ -239,17 +224,14 @@ build:
version: "0.17"
theme: herring-cove
flags: --buildDrafts=true
```
{{% /code %}}
{{< /code >}}
We can conclude this first step by pushing our `wercker.yml` to our GitHub repository and then seeing the magic at work within Wercker's interface.
{{% code file="push-wecker-to-gh.sh" %}}
```bash
{{< code file="push-wecker-to-gh.sh" >}}
git commit -a -m "Add wercker.yml"
git push origin master
```
{{% /code %}}
{{< /code >}}
If completed and successful, a green check mark should appear in the commit column of your first build. However, this is only the build step. We still need to deploy the website to our free hosting on GitHub Pages. If you would like more details about the build, you can click the commit hash.
@ -259,8 +241,7 @@ If completed and successful, a green check mark should appear in the commit colu
In order to deploy to GitHub Pages, we need to add a deploy step to our `wercker.yml`. We are going to add `lukevevier/gh-pages`, the most popular GitHub Pages step in the Wercker Steps repository. Additionally, we need to ensure the box Wercker uses for our deployments has git and ssh installed. We can do this using the `install-packages` command. Here is our *final* `wercker.yml` file:
{{% code file="wercker.yml" %}}
```yaml
{{< code file="wercker.yml" >}}
box: debian
build:
steps:
@ -276,8 +257,7 @@ deploy:
token: $GIT_TOKEN
domain: hugo-wercker.ig.nore.me
basedir: public
```
{{% /code %}}
{{< /code >}}
### How does the GitHub Pages Configuration Work?

16
content/hosting-and-deployment/hosting-on-bitbucket.md
View file

@ -1,6 +1,6 @@
---
title: Hosting on Bitbucket
linktitle: Hosting on Bitbucket
title: Host on Bitbucket
linktitle: Host on Bitbucket
description: You can use Bitbucket in conjunction with Aerobatic to build, deploy, and host a Hugo website.
date: 2017-02-04
publishdate: 2017-02-04
@ -30,14 +30,14 @@ You can use [Bitbucket](https://bitbucket.org/) and [Aerobatic](https://www.aero
If you haven't previously used Aerobatic, you'll first need to install the Command Line Interface (CLI) and create an account. For a list of all commands available, see the [Aerobatic CLI](https://www.aerobatic.com/docs/cli/) docs.
```bash
```
npm install aerobatic-cli -g
aero register
```
## Create and Deploy Site
```bash
```
hugo new site my-new-hugo-site
cd my-new-hugo-site
cd themes; git clone https://github.com/eliasson/liquorice
@ -61,7 +61,7 @@ We will now create a git repository and then push our code to Bitbucket. In Bitb
[1]: /images/hosting-and-deployment/hosting-on-bitbucket/bitbucket-create-repo.png
```bash
```
# initialize new git repository
git init
@ -88,7 +88,7 @@ In your Hugo website's Bitbucket repo;
3. On the next screen, leave the default template and click Next.
4. In the editor, paste in the yaml contents below and click Commit.
```bash
```
image: beevelop/nodejs-python
pipelines:
branches:
@ -109,7 +109,7 @@ pipelines:
This step only needs to be done once per account. From the command line;
```bash
```
aero apikey
```
@ -119,7 +119,7 @@ aero apikey
### Step 3: Edit and Commit Code
```bash
```
hugo new post/good-to-great.md
hugo server --buildDrafts -t liquorice #Check that all looks good

16
content/hosting-and-deployment/hosting-on-firebase.md
View file

@ -1,6 +1,6 @@
---
title: Hosting on Firebase
linktitle: Hosting on Firebase
title: Host on Firebase
linktitle: Host on Firebase
description: You can use Firebase's free tier to host your static website; this also gives you access to Firebase's NOSQL API.
date: 2017-03-12
publishdate: 2017-03-12
@ -29,19 +29,19 @@ aliases: []
Go to the [Firebase console][console] and create a new project (unless you already have a project). You will need to globally install `firebase-tools` (node.js):
```sh
```
npm install -g firebase-tools
```
Log in to Firebase (setup on your local machine) using `firebase login`, which opens a browser where you can select your account. Use `firebase logout` in case you are already logged in but to the wrong account.
```sh
```
firebase login
```
In the root of your Hugo project, initialize the Firebase project with the `firebase init` command:
```sh
```
firebase init
```
From here:
@ -56,7 +56,7 @@ From here:
To deploy your Hugo site, execute the `firebase deploy` command, and your site will be up in no time:
```sh
```
hugo && firebase deploy
```
@ -65,7 +65,7 @@ hugo && firebase deploy
You can generate a deploy token using
```sh
```
firebase login:ci
```
@ -77,7 +77,7 @@ This is a private secret and it should not appear in a public repository. Make s
You can then add a step in your build to do the deployment using the token:
```sh
```
firebase deploy --token $FIREBASE_DEPLOY_TOKEN
```

30
content/hosting-and-deployment/hosting-on-github.md
View file

@ -1,6 +1,6 @@
---
title: Hosting on GitHub
linktitle: Hosting on GitHub
title: Host on GitHub
linktitle: Host on GitHub
description: Deploy Hugo as a GitHub Pages project or personal/organizational site and automate the whole process with a simple shell script.
date: 2014-03-21
publishdate: 2014-03-21
@ -37,11 +37,11 @@ Make sure your `baseURL` key-value in your [site configuration](/getting-started
[As described in the GitHub Pages documentation][ghpfromdocs], you can deploy from a folder called `docs/` on your master branch. To effectively use this feature with Hugo, you need to change the Hugo publish directory in your [site's][config] `config.toml` and `config.yaml`, respectively:
```yaml
```
publishDir: docs
```
```toml
```
publishDir = "docs"
```
@ -69,7 +69,7 @@ These steps only need to be done once. Replace `upstream` with the name of your
First, add the `public` folder to your `.gitignore` file at the project root so that the directory is ignored on the master branch:
```bash
```
echo "public" >> .gitignore
```
@ -77,7 +77,7 @@ echo "public" >> .gitignore
You can now initialize your `gh-pages` branch as an empty [orphan branch][]:
```bash
```
git checkout --orphan gh-pages
git reset --hard
git commit --allow-empty -m "Initializing gh-pages branch"
@ -89,23 +89,21 @@ git checkout master
Now check out the `gh-pages` branch into your `public` folder using git's [worktree feature][]. Essentially, the worktree allows you to have multiple branches of the same local repository to be checked out in different directories:
```sh
```
rm -rf public
git worktree add -B gh-pages public upstream/gh-pages
```
Regenerate the site using the `hugo` command and commit the generated files on the `gh-pages` branch:
{{% code file="commit-gh-pages-files.sh"%}}
```bash
{{< code file="commit-gh-pages-files.sh">}}
hugo
cd public && git add --all && git commit -m "Publishing to gh-pages" && cd ..
```
{{% /code %}}
{{< /code >}}
If the changes in your local `gh-pages` branch look alright, push them to the remote repo:
```bash
```
git push upstream gh-pages
```
@ -122,8 +120,7 @@ After a short while, you'll see the updated contents on your GitHub Pages site.
To automate these steps, you can create a script with the following contents:
{{% code file="publish_to_ghpages.sh" %}}
```sh
{{< code file="publish_to_ghpages.sh" >}}
#!/bin/sh
DIR=$(dirname "$0")
@ -153,8 +150,7 @@ hugo
echo "Updating gh-pages branch"
cd public && git add --all && git commit -m "Publishing to gh-pages (publish.sh)"
```
{{% /code %}}
{{< /code >}}
This will abort if there are pending changes in the working directory and also makes sure that all previously existing output files are removed. Adjust the script to taste, e.g. to include the final push to the remote repository if you don't need to take a look at the gh-pages branch before pushing. Or adding `echo yourdomainname.com >> CNAME` if you set up for your gh-pages to use customize domain.
@ -193,7 +189,7 @@ You're almost done. You can also add a `deploy.sh` script to automate the preced
The following are the contents of the `deploy.sh` script:
```sh
```
#!/bin/bash
echo -e "\033[0;32mDeploying updates to GitHub...\033[0m"

14
content/hosting-and-deployment/hosting-on-gitlab.md
View file

@ -1,6 +1,6 @@
---
title: Hosting on GitLab
linktitle: Hosting on GitLab
title: Host on GitLab
linktitle: Host on GitLab
description: GitLab makes it incredibly easy to build, deploy, and host your Hugo website via their free GitLab Pages service, which provides native support for Hugo.
date: 2016-06-23
publishdate: 2016-06-23
@ -31,14 +31,13 @@ aliases: [/tutorials/hosting-on-gitlab/]
## Create .gitlab-ci.yml
```bash
```
cd your-hugo-site
```
In the root directory of your Hugo site, create a `.gitlab-ci.yml` file. The `.gitlab-ci.yml` configures the GitLab CI on how to build your page. Simply add the content below.
{{% code file="gitlab-ci.yml" %}}
```yml
{{< code file="gitlab-ci.yml" >}}
image: publysher/hugo
pages:
@ -49,14 +48,13 @@ pages:
- public
only:
- master
```
{{% /code %}}
{{< /code >}}
## Push Your Hugo Website to GitLab
Next, create a new repository on GitLab. It is *not* necessary to make the repository public. In addition, you might want to add `/public` to your .gitignore file, as there is no need to push compiled assets to GitLab or keep your output website in version control.
```bash
```
# initialize new git repository
git init

8
content/hosting-and-deployment/hosting-on-netlify.md
View file

@ -1,6 +1,6 @@
---
title: Hosting on Netlify
linktitle: Hosting on Netlify
title: Host on Netlify
linktitle: Host on Netlify
description: Netlify can host your Hugo site with CDN, continuous deployment, 1-click HTTPS, an admin GUI, and its own CLI.
date: 2017-02-01
publishdate: 2017-02-01
@ -65,7 +65,7 @@ Setting the build command to `hugo` will build your site according to the curren
If you want to tell Netlify to build with a specific version, you can append an underscore followed by the version number to the build command:
```bash
```
hugo_0.19
```
@ -93,7 +93,7 @@ The [`git clone` method for installing themes][installthemes] is not supported b
A *better* approach is to install a theme as a proper git submodule. You can [read the GitHub documentation for submodules][ghsm] or those found on [Git's website][gitsm] for more information, but the command is similar to that of `git clone`:
```bash
```
cd themes
git submodule add https://github.com/<THEMECREATOR>/<THEMENAME>
```

2
content/news/0-16.md
View file

@ -1,7 +1,7 @@
---
date: 2016-06-06T13:54:06-04:00
description: "Hugo 0.16 is our best and biggest release ever. The Hugo community has outdone itself with continued performance improvements, beautiful themes and increased stability."
title: "June Release"
title: "Hugo 0.16"
categories: ["Releases"]
---

2
content/news/0-17.md
View file

@ -4,7 +4,7 @@ categories: ["Releases"]
date: 2016-10-07T13:54:06-04:00
description: "Hugo now supports multilingual sites with the most simple and elegant experience."
link: ""
title: "October Release: Hugo is going global"
title: "0.17: Hugo is going global"
draft: false
---
Hugo is going global with our 0.17 release. We put a lot of thought into how we could extend Hugo

2
content/news/0-18.md
View file

@ -3,7 +3,7 @@ date: 2016-12-30T13:54:02-04:00
categories: ["Releases"]
description: "The primary new feature in Hugo 0.18 is that every piece of content is now a Page."
link: ""
title: "December Hugo Release"
title: "Hugo 0.18"
draft: false
author: bep
---

2
content/news/0-19.md
View file

@ -3,7 +3,7 @@ date: 2017-02-27T13:53:58-04:00
categories: ["Releases"]
description: "Hugo 0.19 brings native Emacs Org-mode content support, and Hugo has its own Twitter account"
link: ""
title: "February Release"
title: "Hugo 0.19"
draft: false
author: budparr
---

2
content/news/0-20-1.md
View file

@ -3,7 +3,7 @@ date: 2017-04-13T13:53:58-04:00
categories: ["Releases"]
description: "Hugo 0.20.1 is a bug fix release, fixing some important regressions introduced in 0.20"
link: ""
title: "April Release"
title: "Hugo 0.20.1"
draft: false
author: bep
---

2
content/news/0-20-2.md
View file

@ -3,7 +3,7 @@ date: 2017-04-16T13:53:58-04:00
categories: ["Releases"]
description: "Hugo 0.20.2 adds support for plain text partials included into HTML templates"
link: ""
title: "April Release"
title: "Hugo 0.20.2"
draft: false
author: bep
---

2
content/news/0-20-3.md
View file

@ -3,7 +3,7 @@ date: 2017-04-24T13:53:58-04:00
categories: ["Releases"]
description: "This is a bug-fix release with one important fix. But it also adds some harness around GoReleaser"
link: ""
title: "April Release"
title: "Hugo 0.20.3"
draft: false
author: bep
---

2
content/news/0-20-4.md
View file

@ -3,7 +3,7 @@ date: 2017-04-24T17:53:58-04:00
categories: ["Releases"]
description: "This is the second bug-fix release of the day, fixing a couple of issues related to the new release scripts"
link: ""
title: "April Release"
title: "Hugo 0.20.4"
draft: false
author: bep
---

2
content/news/0-20-5.md
View file

@ -3,7 +3,7 @@ date: 2017-04-25T17:53:58-04:00
categories: ["Releases"]
description: ""
link: ""
title: "April Release"
title: "Hugo 0.20.5"
draft: false
author: bep
---

2
content/news/0-20-6.md
View file

@ -3,7 +3,7 @@ date: 2017-04-27T17:53:58-04:00
categories: ["Releases"]
description: ""
link: ""
title: "April Release"
title: "Hugo 0.20.6"
draft: false
author: bep
---

2
content/news/0-20-7.md
View file

@ -3,7 +3,7 @@ date: 2017-05-03T17:53:58-04:00
categories: ["Releases"]
description: "This just fixes an issue with the release scripts, no change in the binaries"
link: ""
title: "May Release"
title: "Hugo 0.20.7"
draft: false
author: bep
---

2
content/news/0-20.md
View file

@ -3,7 +3,7 @@ date: 2017-04-10T13:53:58-04:00
categories: ["Releases"]
description: "Hugo 0.20 introduces the powerful and long sought after feature Custom Output Formats"
link: ""
title: "April Release"
title: "Hugo 0.20"
draft: false
author: bep
---

2
content/news/0-21.md
View file

@ -3,7 +3,7 @@ date: 2017-05-22T17:53:58-04:00
categories: ["Releases"]
description: "Hugo 0.21 brings full support for shortcodes per Output Format, the last vital piece of that puzzle"
link: ""
title: "May Release"
title: "Hugo 0.21"
draft: false
author: bep
---

6
content/news/0-22-1.md
View file

@ -3,7 +3,7 @@ date: 2017-06-13T17:53:58-04:00
categories: ["Releases"]
description: "Hugo 0.22.1 fixes a couple of issues reported after the 0.22 release"
link: ""
title: "June Release"
title: "Hugo 0.22.1"
draft: false
author: bep
---
@ -16,14 +16,14 @@ With this release you can configure **permalinks with sections** like this:
**First level only:**
```toml
```
[permalinks]
blog = ":section/:title"
```
**Nested (all levels):**
```toml
```
[permalinks]
blog = ":sections/:title"
```

Some files were not shown because too many files have changed in this diff Show more