{{.Title}}
{{.Title}}
{{.Description}}
type.md in the `/archetypes` directory. *E.g. `/archetypes/post.md`*.
+Create an archetype file for your type at `yourtype.md` in the `/archetypes` directory; e.g., `/archetypes/post.md`.
-More details about archetypes can be found at the [archetypes docs](/content/archetypes/).
+More details about archetypes can be found in the [archetypes][] documentation.
[archetypes]: /content-management/archetypes/
[sections]: /content-sections/
diff --git a/content/content-management/cross-references.md b/content/content-management/cross-references.md
index eca193365..632e73b36 100644
--- a/content/content-management/cross-references.md
+++ b/content/content-management/cross-references.md
@@ -11,5 +11,6 @@ weight: 80
draft: false
slug:
aliases: []
+toc:
notes:
---
\ No newline at end of file
diff --git a/content/content-management/front-matter.md b/content/content-management/front-matter.md
index 9def27f97..028977cb0 100644
--- a/content/content-management/front-matter.md
+++ b/content/content-management/front-matter.md
@@ -11,6 +11,7 @@ weight: 20
draft: false
slug:
aliases: [/content/front-matter/]
+toc:
notes:
---
diff --git a/content/content-management/markdown-and-supported-formats.md b/content/content-management/markdown-and-supported-formats.md
index ce6349bc4..8d6672ae9 100644
--- a/content/content-management/markdown-and-supported-formats.md
+++ b/content/content-management/markdown-and-supported-formats.md
@@ -11,6 +11,7 @@ weight: 10
draft: false
slug:
aliases: [/content/markdown-extras/,/content/supported-formats/,/content/markdown/]
+toc:
notes:
---
diff --git a/content/content-management/multilingual-mode.md b/content/content-management/multilingual-mode.md
index 3fb6a5d70..3d71fbbac 100644
--- a/content/content-management/multilingual-mode.md
+++ b/content/content-management/multilingual-mode.md
@@ -11,5 +11,6 @@ weight: 120
draft: false
slug:
aliases: []
+toc:
notes:
---
\ No newline at end of file
diff --git a/content/content-management/table-of-contents.md b/content/content-management/table-of-contents.md
index 70988189c..603ab457b 100644
--- a/content/content-management/table-of-contents.md
+++ b/content/content-management/table-of-contents.md
@@ -11,5 +11,6 @@ weight: 100
draft: false
slug:
aliases: [/extras/toc/]
+toc:
notes:
---
\ No newline at end of file
diff --git a/content/content-management/taxonomies.md b/content/content-management/taxonomies.md
index 108b1cab0..b9bdb401b 100644
--- a/content/content-management/taxonomies.md
+++ b/content/content-management/taxonomies.md
@@ -10,8 +10,193 @@ categories: [content management]
weight: 60
draft: false
slug:
-aliases: [/taxonomies/overview/,/taxonomies/usage/]
+aliases: [/taxonomies/overview/,/taxonomies/usage/,/indexes/overview/,/doc/indexes/,/extras/indexes]
+toc: true
notes:
---
-## Configuring Taxonomies
\ No newline at end of file
+## What is a Taxonomy?
+
+Hugo includes support for user-defined groupings of content called **taxonomies**. Taxonomies are classifications that demonstrate logical relationships between content.
+
+{{% note %}}
+Taxonomies were previously known as *indexes* in Hugo before v0.11.
+{{% /note %}}
+
+### Taxonomy Definitions
+
+In order to effectively work with taxonomies in Hugo, it's important to first understand the language used to described different facets of usage.
+
+* **Taxonomy:** A categorization that can be used to classify content
+* **Term:** A key within that taxonomy
+* **Value:** A piece of content assigned to that Term
+
+## Hugo's Default Taxonomies
+
+Hugo ships with *tags* and *categories* as default taxonomies. These taxonomies are common to many website systems (e.g., WordPress, Drupal, Jekyll). Unlike these systems, Hugo makes it trivial to customize the taxonomies you will be using for your website. In addition to *tags* and *categories*, a *series* of posts for a blog is another common example of taxonomies.
+
+## Pages Generated
+
+When taxonomies are used---and [taxonomy templates][] are provided---Hugo will automatically create a taxonomy page listing all of the taxonomy's terms and individual pages for all content associated with the term. For example, a `categories` taxonomy will create the following pages:
+
+* A single page at `yoursite.com/categories/` that lists all the [terms within the taxonomy][]
+* [Individual taxonomy list pages][] (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][]
+
+## Configuring Taxonomies
+
+Taxonomies must be defined in your [website configuration][] before they can be
+used throughout the site. You need to provide both the plural and
+singular labels for each taxonomy.
+
+Here is an example configuration in TOML and YAML
+that specifies three taxonomies (the default two, plus `series`).
+
+Notice the format is `singular key = "plural value"` for TOML and `singular key: "plural value"` for YAML:
+
+### TOML Configuration
+
+```toml
+[taxonomies]
+ tag = "tags"
+ category = "categories"
+ series = "series"
+```
+
+### YAML Configuration
+
+```yaml
+taxonomies:
+ tag: "tags"
+ category: "categories"
+ series: "series"
+```
+
+### Preserving Taxonomy Values
+
+By default, taxonomy names are hyphenated, lower-cased, normalized, and then fixed and title-ized on the archive page.
+
+However, if you want to have a taxonomy value with special characters such as `Gérard Depardieu` instead of `Gerard Depardieu`, you need to set the value for `preserveTaxonomyNames` in your [site configuration](/overview/configuration/) to `true`. Hugo will then preserve special characters in taxonomy values but will still titleize the values for titles and normalize them in URLs.
+
+Note that if you use `preserveTaxonomyNames` and intend to manually construct URLs to the archive pages, you will need to pass the taxonomy values through the [`urlize` template function][].
+
+## Adding Taxonomies to Content
+
+Once a taxonomy is defined at the site level, any piece of content can be assigned to it, regardless of [content type][] or [content section][].
+
+Assigning content to a taxonomy is done in the [front matter][]. Simply create a variable with the *plural* name of the taxonomy and assign all terms you want to apply to the instance of the content type.
+
+{{% note %}}
+If you would like the ability to quickly generate content files with preconfigured taxonomies or terms, read the docs on [Hugo archetypes](/content-management/archetypes/).
+{{% /note %}}
+
+### TOML Front Matter Example
+
+```toml
++++
+title = "Hugo: A fast and flexible static site generator"
+tags = [ "Development", "Go", "fast", "Blogging" ]
+categories = [ "Development" ]
+series = [ "Go Web Dev" ]
+slug = "hugo"
+project_url = "https://github.com/spf13/hugo"
++++
+```
+
+### YAML Front Matter Example
+
+```yaml
++++
+title: "Hugo: A fast and flexible static site generator"
+tags: ["Development", "Go", "fast", "Blogging"]
+categories: ["Development"]
+categories: ["Go Web Dev"]
+slug: "hugo"
+project_url: "https://github.com/spf13/hugo"
++++
+```
+
+### JSON Front Matter Example
+
+```json
+{
+ "title": "Hugo: A fast and flexible static site generator",
+ "tags": [
+ "Development",
+ "Go",
+ "fast",
+ "Blogging"
+ ],
+ "categories" : [
+ "Development"
+ ],
+ "series" : [
+ "Go Web Dev"
+ ],
+ "slug": "hugo",
+ "project_url": "https://github.com/spf13/hugo"
+}
+```
+
+## Add Content File with Front Matter
+
+See [project organization][].
+
+## Example Taxonomy
+
+For example, if I was writing about movies, I may want the following
+taxonomies:
+
+* Actors
+* Directors
+* Studios
+* Genre
+* Year
+* Awards
+
+I would then specify in each movie’s front matter the specific terms for each of those taxonomies. Hugo would then automatically create pages for each Actor, Director, Studio, Genre, Year and Award listing all of the Movies that matched that specific Actor, Director, etc.
+
+### Taxonomy Organization
+
+Let’s use an example to demonstrate the different labels in action.
+From the perspective of the taxonomy, it could be visualized as:
+
+```
+Actor <- Taxonomy
+ Bruce Willis <- Term
+ The Six Sense <- Content
+ Unbreakable <- Content
+ Moonrise Kingdom <- Content
+ Samuel L. Jackson <- Term
+ Unbreakable <- Content
+ The Avengers <- Content
+ xXx <- Content
+```
+
+From the perspective of the content, it would appear differently, although the data and labels used are the same:
+
+```
+Unbreakable <- Content
+ Actors <- Taxonomy
+ Bruce Willis <- Term
+ Samuel L. Jackson <- Term
+ Director <- Taxonomy
+ M. Night Shyamalan <- Term
+ ...
+Moonrise Kingdom <- Content
+ Actors <- Taxonomy
+ Bruce Willis <- Term
+ Bill Murray <- Term
+ Director <- Taxonomy
+ Wes Anderson <- Term
+ ...
+```
+
+[`urlize` template function]: /functions/urlize/
+[content section]: /content-section/
+[content type]: /content-type/
+[front matter]: /content-management/front-matter/
+[Individual taxonomy list pages]: /templates/taxonomy-templates/#taxonomy-templates
+[project organization]: /project-organization/
+[taxonomy templates]: /templates/taxonomy-templates/
+[terms within the taxonomy]: /templates/taxonomy-templates/#terms-templates
+[website configuration]: /project-organization/configuration/
\ No newline at end of file
diff --git a/content/content-management/url-management.md b/content/content-management/url-management.md
index abed64578..d46240341 100644
--- a/content/content-management/url-management.md
+++ b/content/content-management/url-management.md
@@ -11,6 +11,7 @@ weight: 90
draft: false
slug:
aliases: [/extras/permalinks/,/extras/aliases/,/content-management/permalinks-and-redirects/,/extras/urls/]
+toc: true
notes:
---
diff --git a/content/contribute-to-hugo/_index.md b/content/contribute-to-hugo/_index.md
index e412b3aa9..6f9d94610 100644
--- a/content/contribute-to-hugo/_index.md
+++ b/content/contribute-to-hugo/_index.md
@@ -12,5 +12,6 @@ weight: 01
draft: false
slug:
aliases: [/tutorials/how-to-contribute-to-hugo/]
+toc: false
notes:
---
\ No newline at end of file
diff --git a/content/contribute-to-hugo/add-your-site-to-the-showcase.md b/content/contribute-to-hugo/add-your-site-to-the-showcase.md
index 806c98ceb..42545611d 100644
--- a/content/contribute-to-hugo/add-your-site-to-the-showcase.md
+++ b/content/contribute-to-hugo/add-your-site-to-the-showcase.md
@@ -5,12 +5,13 @@ description: Proud of a site you built with Hugo? Add it to the Official Hugo Si
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
-categories: [contribute]
+categories: [contribute to hugo]
tags: [dev,showcase]
weight:
draft: false
slug:
-aliases:
+aliases: []
+toc: false
notes:
---
@@ -70,5 +71,4 @@ Last but not least, we're ready to create a [pull request](https://github.com/sp
Don't forget to accept the contributor license agreement. Click on the yellow badge in the automatically added comment in the pull request.
-
[code contribution guideline]: https://github.com/spf13/hugo#code-contribution-guideline
\ No newline at end of file
diff --git a/content/contribute-to-hugo/contribute-to-hugo-development.md b/content/contribute-to-hugo/contribute-to-hugo-development.md
index 2713d7a9b..c43e93767 100644
--- a/content/contribute-to-hugo/contribute-to-hugo-development.md
+++ b/content/contribute-to-hugo/contribute-to-hugo-development.md
@@ -5,7 +5,7 @@ description: Hugo relies heavily on the contributions of the open source communi
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
-categories: [contribute]
+categories: [contribute to hugo]
tags: [dev,open source]
weight:
draft: false
diff --git a/content/contribute-to-hugo/contribute-to-the-hugo-docs.md b/content/contribute-to-hugo/contribute-to-the-hugo-docs.md
index a60802681..ca15170e9 100644
--- a/content/contribute-to-hugo/contribute-to-the-hugo-docs.md
+++ b/content/contribute-to-hugo/contribute-to-the-hugo-docs.md
@@ -5,7 +5,7 @@ description: Documentation is an integral part of any open source project. The H
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
-categories: [contribute]
+categories: [contribute to hugo]
tags: [docs,documentation]
weight:
draft: false
diff --git a/content/developer-tools/hugo-command-line-reference.md b/content/developer-tools/hugo-command-line-reference.md
index b0671932b..097571543 100644
--- a/content/developer-tools/hugo-command-line-reference.md
+++ b/content/developer-tools/hugo-command-line-reference.md
@@ -10,6 +10,7 @@ weight: 40
draft: false
slug:
aliases: []
+toc:
notes:
---
diff --git a/content/developer-tools/migrate-to-hugo.md b/content/developer-tools/migrate-to-hugo.md
index 613c06da0..620d360ff 100644
--- a/content/developer-tools/migrate-to-hugo.md
+++ b/content/developer-tools/migrate-to-hugo.md
@@ -10,6 +10,7 @@ weight: 40
draft: false
slug:
aliases: [/developer-tools/migrations/,/developer-tools/migrated/]
+toc:
notes:
---
diff --git a/content/developer-tools/syntax-highlighting.md b/content/developer-tools/syntax-highlighting.md
index b0d86f0e8..5b1002d34 100644
--- a/content/developer-tools/syntax-highlighting.md
+++ b/content/developer-tools/syntax-highlighting.md
@@ -11,5 +11,6 @@ weight: 110
draft: false
slug:
aliases: []
+toc:
notes:
---
\ No newline at end of file
diff --git a/content/getting-started/download-hugo.md b/content/getting-started/download-hugo.md
index 01b564cd8..6eed92555 100644
--- a/content/getting-started/download-hugo.md
+++ b/content/getting-started/download-hugo.md
@@ -9,6 +9,7 @@ weight:
draft: false
slug:
aliases: []
+toc:
notes:
---
diff --git a/content/getting-started/quick-start.md b/content/getting-started/quick-start.md
new file mode 100644
index 000000000..ed9a97cb4
--- /dev/null
+++ b/content/getting-started/quick-start.md
@@ -0,0 +1,15 @@
+---
+title: Quick Start
+linktitle: Quick Start
+description:
+date: 2017-02-01
+publishdate: 2017-02-01
+lastmod: 2017-02-01
+weight:
+draft: false
+slug:
+aliases: []
+toc:
+notes:
+---
+
diff --git a/content/hosting-and-deployment/deployment-with-rsync.md b/content/hosting-and-deployment/deployment-with-rsync.md
index a8a6bdc0b..59360c7f1 100644
--- a/content/hosting-and-deployment/deployment-with-rsync.md
+++ b/content/hosting-and-deployment/deployment-with-rsync.md
@@ -5,11 +5,11 @@ description:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
+tags: []
+categories: []
+toc: false
weight:
draft: false
-type:
-layout:
-slug:
aliases: []
notes:
---
\ No newline at end of file
diff --git a/content/hosting-and-deployment/deployment-with-wercker.md b/content/hosting-and-deployment/deployment-with-wercker.md
index 733752d84..2c5d5c6bd 100644
--- a/content/hosting-and-deployment/deployment-with-wercker.md
+++ b/content/hosting-and-deployment/deployment-with-wercker.md
@@ -5,8 +5,9 @@ description:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
-tags: [wercker]
-weight:
+tags: []
+categories: []
+toc: false
draft: false
slug:
aliases: []
diff --git a/content/hosting-and-deployment/hosting-on-bitbucket.md b/content/hosting-and-deployment/hosting-on-bitbucket.md
index 644f07ead..c67dab519 100644
--- a/content/hosting-and-deployment/hosting-on-bitbucket.md
+++ b/content/hosting-and-deployment/hosting-on-bitbucket.md
@@ -7,9 +7,9 @@ publishdate: 2017-02-01
lastmod: 2017-02-01
weight:
draft: false
-type:
-layout:
-slug:
+tags: []
+categories: []
+toc: false
aliases: []
notes:
---
\ No newline at end of file
diff --git a/content/hosting-and-deployment/hosting-on-github.md b/content/hosting-and-deployment/hosting-on-github.md
index e86e59023..2bff1aaee 100644
--- a/content/hosting-and-deployment/hosting-on-github.md
+++ b/content/hosting-and-deployment/hosting-on-github.md
@@ -7,9 +7,9 @@ publishdate: 2017-02-01
lastmod: 2017-02-01
weight:
draft: false
-type:
-layout:
-slug:
+tags: []
+categories: []
+toc: false
aliases: []
notes:
---
\ No newline at end of file
diff --git a/content/hosting-and-deployment/hosting-on-gitlab.md b/content/hosting-and-deployment/hosting-on-gitlab.md
index b1bbe1f62..9d4905783 100644
--- a/content/hosting-and-deployment/hosting-on-gitlab.md
+++ b/content/hosting-and-deployment/hosting-on-gitlab.md
@@ -7,9 +7,9 @@ publishdate: 2017-02-01
lastmod: 2017-02-01
weight:
draft: false
-type:
-layout:
-slug:
+tags: []
+categories: []
+toc: false
aliases: []
notes:
---
\ No newline at end of file
diff --git a/content/project-organization/configuration.md b/content/project-organization/configuration.md
index f211451e9..905aadd03 100644
--- a/content/project-organization/configuration.md
+++ b/content/project-organization/configuration.md
@@ -3,7 +3,7 @@ title: Configuration
linktitle:
description: Scaffolding new projects, configuration, and source organization.
date: 2017-01-02
-tags: [configuration,fundamentals]
+tags: [configuration,fundamentals,toml,yaml,json]
publishdate: 2017-01-02
lastmod: 2017-01-02
weight: 10
@@ -15,7 +15,9 @@ notes:
The [directory structure][] of a Hugo website—or more precisely, the source organization of files containing the website's content and templates—provides most of the configuration information that Hugo needs in order to statically generate a finished website.
-Therefore, many websites wouldn't actually need a configuration file. This is because Hugo is designed to recognize certain typical usage patterns (and expects them, by default).
+Therefore, many websites may not need a configuration file. Hugo is designed to recognize certain typical usage patterns (and expects them, by default).
+
+## Configuration Lookup Order
Nevertheless, Hugo searches for a configuration file in the root of your website's source directory as a default behavior. First, it looks for a `./config.toml` file. If that's not present, it will seek a `./config.yaml` file,
followed by a `./config.json` file.
@@ -46,29 +48,7 @@ params:
```
{{% /input %}}
-## 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"
-buildDrafts = false
-baseURL = "https://yoursite.example.com/"
-canonifyURLs = true
-title = "My Hugo Site"
-
-[taxonomies]
- category = "categories"
- tag = "tags"
-
-[params]
- subtitle = "Hugo is Absurdly Fast!"
- author = "John Doe"
-```
-
-## All Variables, YAML
+### 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.
@@ -181,7 +161,29 @@ taxonomies:
```
{{% /input %}}
-## All Variables, TOML
+## 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"
+buildDrafts = false
+baseURL = "https://yoursite.example.com/"
+canonifyURLs = true
+title = "My Hugo Site"
+
+[taxonomies]
+ category = "categories"
+ tag = "tags"
+
+[params]
+ subtitle = "Hugo is Absurdly Fast!"
+ author = "John Doe"
+```
+
+### All Variables, TOML
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.
@@ -305,7 +307,7 @@ $ env HUGO_TITLE="Some Title" hugo
```
{{% note "Setting Environment Variables" %}}
-names must be prefixed with `HUGO_` when setting environment variables through operating system environment variables.
+Names must be prefixed with `HUGO_` when setting environment variables through operating system environment variables.
{{% /note %}}
## Ignoring Files When Rendering
@@ -318,7 +320,7 @@ ignoreFiles = [ "\\.foo$", "\\.boo$" ]
```
The above is a list of regular expressions. Note that the backslash (`\`) character is escaped in this example to keep TOML happy.
-## Additional Resources
+## Configuration Format Specs
* [TOML Spec][]
* [YAML Spec][]
diff --git a/content/project-organization/directory-structure.md b/content/project-organization/directory-structure.md
index 929b55257..63d98c61a 100644
--- a/content/project-organization/directory-structure.md
+++ b/content/project-organization/directory-structure.md
@@ -6,7 +6,7 @@ date: 2017-01-02
publishdate: 2017-01-02
lastmod: 2017-01-02
categories: [project organization]
-tags: [source, organization, directories]
+tags: [source, organization, directories,fundamentals]
weight: 10
draft: false
slug:
diff --git a/content/templates/taxonomy-templates.md b/content/templates/taxonomy-templates.md
index 2f5779f43..48d187723 100644
--- a/content/templates/taxonomy-templates.md
+++ b/content/templates/taxonomy-templates.md
@@ -14,4 +14,9 @@ aliases: []
notes:
---
-## Configuring Taxonomies
\ No newline at end of file
+## Configuring Taxonomies
+
+## Taxonomy Templates
+
+## Terms Templates
+
diff --git a/themes/hugodocs/archetypes/default.md b/themes/hugodocs/archetypes/default.md
index a49ba4844..3039858df 100644
--- a/themes/hugodocs/archetypes/default.md
+++ b/themes/hugodocs/archetypes/default.md
@@ -1,2 +1,14 @@
---
+linktitle:
+description: ""
+publishdate: ""
+lastmod: ""
+categories: []
+tags: []
+weight: 00
+draft: true
+slug: ""
+aliases: []
+toc: false
+notes: Categories are not required metadata as of February 2017.
---
\ No newline at end of file
diff --git a/themes/hugodocs/archetypes/functions.md b/themes/hugodocs/archetypes/functions.md
index 1093010a6..f8bcebd74 100644
--- a/themes/hugodocs/archetypes/functions.md
+++ b/themes/hugodocs/archetypes/functions.md
@@ -1,8 +1,13 @@
-+++
-subtitle = ""
-author = ""
-publishdate = ""
-description = ""
-tags = ""
-categories = ""
-+++
\ No newline at end of file
+---
+linktitle: ""
+expirydate: ""
+publishdate: ""
+lastmod: ""
+description: ""
+draft: false
+tags: []
+categories: ["functions"]
+aliases: []
+toc: false
+notes: Some notes on this function.
+---
\ No newline at end of file
diff --git a/themes/hugodocs/archetypes/showcase.md b/themes/hugodocs/archetypes/showcase.md
index 147803867..57caf19c0 100644
--- a/themes/hugodocs/archetypes/showcase.md
+++ b/themes/hugodocs/archetypes/showcase.md
@@ -1,11 +1,11 @@
---
-date:
description: ""
+lastmod: ""
license: ""
licenseLink: ""
sitelink: ""
sourceLink: ""
tags: []
-thumbnail: ""
-title:
----
+thumbnail: "/images/yourthumb-tn.jpg"
+toc: false
+---
\ No newline at end of file
diff --git a/themes/hugodocs/layouts/partials/contents-list.html b/themes/hugodocs/layouts/partials/contents-list.html
index 3694a5764..1023002cb 100644
--- a/themes/hugodocs/layouts/partials/contents-list.html
+++ b/themes/hugodocs/layouts/partials/contents-list.html
@@ -1,14 +1,14 @@
{{$kind := .Kind}}
{{if eq $kind "section"}}
-
{{.Description}}