Skip to content

Commit

Permalink
docs: Merge docs commit '37c69054e294bf554be03cf7e4c01e1f586e6943'
Browse files Browse the repository at this point in the history
  • Loading branch information
bep committed Jul 6, 2017
2 parents 4776840 + 37c6905 commit e00f5c9
Show file tree
Hide file tree
Showing 39 changed files with 117 additions and 72 deletions.
10 changes: 10 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion docs/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions docs/content/commands/hugo.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_benchmark.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_check.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_check_ulimit.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_config.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_convert.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_convert_toJSON.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_convert_toTOML.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_convert_toYAML.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_env.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_gen.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_gen_autocomplete.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_gen_doc.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_gen_man.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_import.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_import_jekyll.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_list.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_list_drafts.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_list_expired.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_list_future.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_new.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_new_site.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_new_theme.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_server.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_undraft.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/content/commands/hugo_version.md
Original file line number Diff line number Diff line change
@@ -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/
Expand Down Expand Up @@ -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
8 changes: 4 additions & 4 deletions docs/content/community/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -94,17 +94,17 @@ 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:

hugo server

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.

Expand Down
Loading

0 comments on commit e00f5c9

Please sign in to comment.