docs: Merge docs commit '37c69054e294bf554be03cf7e4c01e1f586e6943'

This commit is contained in:
Bjørn Erik Pedersen 2017-07-06 10:25:46 +02:00
commit e00f5c9c07
39 changed files with 117 additions and 72 deletions

View file

@ -1,3 +1,13 @@
# Hugo Docs
Documentation site for [Hugo](https://github.com/gohugoio/hugo), the very fast and flexible static site generator built with love in GoLang.
## Branches
* 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
To summarize, we have two branches in this repository: `master` (current Hugo) and `dev` (next Hugo).

View file

@ -26,7 +26,7 @@ notAlternative = true
[params]
description = "Documentation of Hugo, a fast and flexible static site generator built with love by spf13, bep and friends in Go"
author = "Steve Francia (spf13) and friends"
release = "0.25-DEV"
release = "0.24.1"
[taxonomies]
tag = "tags"

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo"
slug: hugo
url: /commands/hugo/
@ -77,4 +77,4 @@ hugo [flags]
* [hugo undraft](/commands/hugo_undraft/) - Undraft changes the content's draft status from 'True' to 'False'
* [hugo version](/commands/hugo_version/) - Print the version number of Hugo
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo benchmark"
slug: hugo_benchmark
url: /commands/hugo_benchmark/
@ -69,4 +69,4 @@ hugo benchmark [flags]
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo check"
slug: hugo_check
url: /commands/hugo_check/
@ -34,4 +34,4 @@ Contains some verification checks
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo check ulimit](/commands/hugo_check_ulimit/) - Check system ulimit settings
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo check ulimit"
slug: hugo_check_ulimit
url: /commands/hugo_check_ulimit/
@ -38,4 +38,4 @@ hugo check ulimit [flags]
### SEE ALSO
* [hugo check](/commands/hugo_check/) - Contains some verification checks
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo config"
slug: hugo_config
url: /commands/hugo_config/
@ -37,4 +37,4 @@ hugo config [flags]
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo convert"
slug: hugo_convert
url: /commands/hugo_convert/
@ -41,4 +41,4 @@ See convert's subcommands toJSON, toTOML and toYAML for more information.
* [hugo convert toTOML](/commands/hugo_convert_totoml/) - Convert front matter to TOML
* [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo convert toJSON"
slug: hugo_convert_toJSON
url: /commands/hugo_convert_tojson/
@ -41,4 +41,4 @@ hugo convert toJSON [flags]
### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo convert toTOML"
slug: hugo_convert_toTOML
url: /commands/hugo_convert_totoml/
@ -41,4 +41,4 @@ hugo convert toTOML [flags]
### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo convert toYAML"
slug: hugo_convert_toYAML
url: /commands/hugo_convert_toyaml/
@ -41,4 +41,4 @@ hugo convert toYAML [flags]
### SEE ALSO
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo env"
slug: hugo_env
url: /commands/hugo_env/
@ -37,4 +37,4 @@ hugo env [flags]
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo gen"
slug: hugo_gen
url: /commands/hugo_gen/
@ -36,4 +36,4 @@ A collection of several useful generators.
* [hugo gen doc](/commands/hugo_gen_doc/) - Generate Markdown documentation for the Hugo CLI.
* [hugo gen man](/commands/hugo_gen_man/) - Generate man pages for the Hugo CLI
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo gen autocomplete"
slug: hugo_gen_autocomplete
url: /commands/hugo_gen_autocomplete/
@ -55,4 +55,4 @@ hugo gen autocomplete [flags]
### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo gen doc"
slug: hugo_gen_doc
url: /commands/hugo_gen_doc/
@ -44,4 +44,4 @@ hugo gen doc [flags]
### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo gen man"
slug: hugo_gen_man
url: /commands/hugo_gen_man/
@ -40,4 +40,4 @@ hugo gen man [flags]
### SEE ALSO
* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators.
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo import"
slug: hugo_import
url: /commands/hugo_import/
@ -36,4 +36,4 @@ Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_p
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo import jekyll"
slug: hugo_import_jekyll
url: /commands/hugo_import_jekyll/
@ -40,4 +40,4 @@ hugo import jekyll [flags]
### SEE ALSO
* [hugo import](/commands/hugo_import/) - Import your site from others.
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo list"
slug: hugo_list
url: /commands/hugo_list/
@ -39,4 +39,4 @@ List requires a subcommand, e.g. `hugo list drafts`.
* [hugo list expired](/commands/hugo_list_expired/) - List all posts already expired
* [hugo list future](/commands/hugo_list_future/) - List all posts dated in the future
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo list drafts"
slug: hugo_list_drafts
url: /commands/hugo_list_drafts/
@ -38,4 +38,4 @@ hugo list drafts [flags]
### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo list expired"
slug: hugo_list_expired
url: /commands/hugo_list_expired/
@ -39,4 +39,4 @@ hugo list expired [flags]
### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo list future"
slug: hugo_list_future
url: /commands/hugo_list_future/
@ -39,4 +39,4 @@ hugo list future [flags]
### SEE ALSO
* [hugo list](/commands/hugo_list/) - Listing out various types of content
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo new"
slug: hugo_new
url: /commands/hugo_new/
@ -47,4 +47,4 @@ hugo new [path] [flags]
* [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton)
* [hugo new theme](/commands/hugo_new_theme/) - Create a new theme
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo new site"
slug: hugo_new_site
url: /commands/hugo_new_site/
@ -42,4 +42,4 @@ hugo new site [path] [flags]
### SEE ALSO
* [hugo new](/commands/hugo_new/) - Create new content for your site
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo new theme"
slug: hugo_new_theme
url: /commands/hugo_new_theme/
@ -41,4 +41,4 @@ hugo new theme [name] [flags]
### SEE ALSO
* [hugo new](/commands/hugo_new/) - Create new content for your site
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo server"
slug: hugo_server
url: /commands/hugo_server/
@ -83,4 +83,4 @@ hugo server [flags]
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo undraft"
slug: hugo_undraft
url: /commands/hugo_undraft/
@ -39,4 +39,4 @@ hugo undraft path/to/content [flags]
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -1,5 +1,5 @@
---
date: 2017-06-22T21:51:29+02:00
date: 2017-06-29T08:42:09+02:00
title: "hugo version"
slug: hugo_version
url: /commands/hugo_version/
@ -37,4 +37,4 @@ hugo version [flags]
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
###### Auto generated by spf13/cobra on 22-Jun-2017
###### Auto generated by spf13/cobra on 29-Jun-2017

View file

@ -60,7 +60,7 @@ You **must use govendor** to fetch Hugo's dependencies.
You got your new website running and it's powered by Hugo? Great. You can add your website with a few steps to the [showcase](/showcase/).
First, make sure that you created a [fork](https://help.github.com/articles/fork-a-repo/) of Hugo on GitHub and cloned your fork on your local computer. Next, create a separate branch for your additions:
First, make sure that you created a [fork](https://help.github.com/articles/fork-a-repo/) of the [`hugoDocs`](https://github.com/gohugoio/hugodocs) repository on GitHub and cloned your fork on your local computer. **Next, create a separate branch for your additions**:
```
# You can choose a different descriptive branch name if you like
@ -94,7 +94,7 @@ title: example
Add at least values for `sitelink`, `title`, `description` and a path for `thumbnail`.
Furthermore, we need to create the thumbnail of your website. **It's important that the thumbnail has the required dimensions of 600px by 400px.** Give your thumbnail a name like `example-tn.png`. Save it under `docs/static/img/`.
Furthermore, we need to create the thumbnail of your website. **It's important that the thumbnail has the required dimensions of 600px by 400px.** Give your thumbnail a name like `example-tn.png`. Save it under `static/img/`.
Check a last time that everything works as expected. Start Hugo's built-in server in order to inspect your local copy of the showcase in the browser:
@ -102,9 +102,9 @@ Check a last time that everything works as expected. Start Hugo's built-in serve
If everything looks fine, we are ready to commit your additions. For the sake of best practices, please make sure that your commit follows our [code contribution guideline](https://github.com/gohugoio/hugo#code-contribution-guideline).
git commit -m"docs: Add example.com to the showcase"
git commit -m"Add example.com to the showcase"
Last but not least, we're ready to create a [pull request](https://github.com/gohugoio/hugo/compare).
Last but not least, we're ready to create a [pull request](https://github.com/gohugoio/hugoDocs/compare).
Don't forget to accept the contributor license agreement. Click on the yellow badge in the automatically added comment in the pull request.

View file

@ -44,7 +44,11 @@ Subject
: commit message subject, e.g. `tpl: Add custom index function`
## Performance Considerations
## Other Considerations
The Git integrations should be fairly performant, but it does add some time to the build, which depends somewhat on the Git history size.
The accuracy of data depends on the underlying local git respository. If the local repository is a *shallow clone*, then any file that hasn't been modified in the truncated history will default to data in the oldest commit. In particular, if the respository has been cloned using `--depth=1` then every file will the exact same `GitInfo` data -- that of the only commit in the repository.
In particular, many CI/CD systems such as [travis-ci.org](https://travis-ci.org) default to a clone depth of 50 which is unlikely to be deep enough. You can explicitly add back the missing history using using `git fetch --unshallow` or [make the initial checkout deeper](https://docs.travis-ci.com/user/customizing-the-build#Git-Clone-Depth).

View file

@ -123,14 +123,16 @@ Therefore, a simple `go get` is not supported since `go get` is not vendor-aware
You **must use govendor** to fetch Hugo's dependencies.
### Fetch from GitHub
The commands below assume that you have [Go](https://golang.org/dl/) installed with your `$GOPATH` set.
go get github.com/kardianos/govendor
govendor get github.com/gohugoio/hugo
`govendor get` will fetch Hugo and all its dependent libraries to
`$HOME/go/src/github.com/gohugoio/hugo`, and compile everything into a final `hugo`
`$GOPATH/src/github.com/gohugoio/hugo`, and compile everything into a final `hugo`
(or `hugo.exe`) executable, which you will find sitting inside
`$HOME/go/bin/`, all ready to go!
`$GOPATH/go/bin/`, all ready to go!
*Windows users: where you see the `$HOME` environment variable above, replace it with `%USERPROFILE%`.*

View file

@ -6,7 +6,7 @@ title: 0.24.1
This release fixes some important **archetype-related regressions** from the recent Hugo 0.24-relase.
This release fixes some important **archetype-related regressions** from the recent Hugo 0.24-release.
## Fixes

View file

@ -1,10 +1,10 @@
---
lastmod: 2017-06-30
date: 2016-10-16T13:30:47-04:00
date: 2016-12-20T17:21:00-05:00
description: "Personal site"
license: ""
licenseLink: ""
sitelink: https://christianmendoza.me/
sitelink: https://www.christianmendoza.me/
sourceLink: https://github.com/christianmendoza/christianmendoza.me
tags:
- personal

View file

@ -0,0 +1,15 @@
---
date: 2017-07-01T01:11:00Z
description: "The Invincible: The tale of a disillusioned prince"
license: "Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License"
licenseLink: "https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode"
sitelink: https://invincible.site/
sourceLink: https://github.com/shazic/the_invincible
tags:
- personal
- blog
- graphic novel
thumbnail: /img/invincible-tn.jpg
title: Invincible
---

View file

@ -13,14 +13,28 @@ title: Taxonomy Templates
weight: 30
---
There are two different templates that the use of taxonomies will require you to provide.
Taxonomy templates should be placed in the folder `layouts/taxonomy`.
When Taxonomy term template is provided for a Taxonomy, a section is rendered for it at `/SINGULAR/`. (eg. `/tag/` or `/category/`)
Both templates are covered in detail in the templates section.
There are two different templates that the use of taxonomies will require you to provide:
A [list template](/templates/list/) is any template that will be used to render multiple pieces of
content in a single html page. This template will be used to generate
all the automatically created taxonomy pages.
### All content attached to taxonomy
A [taxonomy terms template](/templates/terms/) is a template used to
generate the list of terms for a given template.
A [taxonomy terms template](/templates/terms/) is a template which has access to all the full Taxonomy structure.
This Template is commonly used to generate the list of terms for a given template.
#### layouts/taxonomy/SINGULAR.terms.html
For example: `tag.terms.html`, `category.terms.html`, or your custom Taxonomy: `actor.terms.html`
### All content attached to term
A [list template](/templates/list/) is used to automatically generate pages for each unique term found.
#### layouts/taxonomy/SINGULAR.html
For example: `tag.html`, `category.html`, or your custom Taxonomy: `actor.html`
Terms are rendered at `SINGULAR/TERM/`. (eg. `/tag/book/` or `/category/news/`)

View file

@ -1,6 +1,6 @@
<div class="row">
<div class="footer-panel">
<p>Last revision: {{ .Lastmod.Format "January 2, 2006" }}{{ if .IsPage }}{{ with .GitInfo }} | <a href="https://github.com/gohugoio/hugo/commit/{{ .Hash }}">{{ .Subject }} ({{ .AbbreviatedHash }})</a>{{end }}{{ end }}
<p>Last revision: {{ .Lastmod.Format "January 2, 2006" }}{{ if .IsPage }}{{ with .GitInfo }} | <a href="https://github.com/gohugoio/hugoDocs/commit/{{ .Hash }}">{{ .Subject }} ({{ .AbbreviatedHash }})</a>{{end }}{{ end }}
<span style="float: right;">Hugo v{{ .Site.Params.release }} documentation</span>
</p>
{{ with getenv "REPOSITORY_URL" -}}

View file

@ -11,7 +11,7 @@
<hr>
<blockquote>
If you want to be added to this page, please send a <a href="https://github.com/gohugoio/hugo/pulls">pull request</a>. Check out the <a href="{{ relref . "community/contributing.md#showcase-additions" }}">how-to guide</a>.
If you want to be added to this page, please send a <a href="https://github.com/gohugoio/hugoDocs/pulls">pull request</a>. Check out the <a href="{{ relref . "community/contributing.md#showcase-additions" }}">how-to guide</a>.
</blockquote>
{{ partial "footer.html" . }}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

After

Width:  |  Height:  |  Size: 41 KiB

BIN
docs/static/img/invincible-tn.jpg vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB