Back to Hugo

Configure taxonomies

docs/content/en/configuration/taxonomies.md

0.161.11.7 KB
Original Source

The default configuration defines two taxonomies, categories and tags.

{{< code-toggle config=taxonomies />}}

When creating a taxonomy:

  • Use the singular form for the key (e.g., category).
  • Use the plural form for the value (e.g., categories).

Then use the value as the key in front matter:

<!-- markdownlint-disable MD007 MD032 -->

{{< code-toggle file=content/example.md fm=true >}} title: Example categories:

  • vegetarian
  • gluten-free tags:
  • appetizer
  • main course {{< /code-toggle >}}
<!-- markdownlint-enable MD007 MD032 -->

If you do not expect to assign more than one term from a given taxonomy to a content page, you may use the singular form for both key and value:

{{< code-toggle file=hugo >}} taxonomies: author: author {{< /code-toggle >}}

Then in front matter:

<!-- markdownlint-disable MD007 MD032 -->

{{< code-toggle file=content/example.md fm=true >}} title: Example author:

  • Robert Smith {{< /code-toggle >}}
<!-- markdownlint-enable MD007 MD032 -->

The example above illustrates that even with a single term, the value is still provided as an array.

You must explicitly define the default taxonomies to maintain them when adding a new one:

{{< code-toggle file=hugo >}} taxonomies: author: author category: categories tag: tags {{< /code-toggle >}}

To disable the taxonomy system, use the disableKinds setting in the root of your project configuration to disable the taxonomy and term page kinds.

{{< code-toggle file=hugo >}} disableKinds = ['taxonomy','term'] {{< /code-toggle >}}

See the taxonomies section for more information.