shithub: hugo

ref: bdf7cd9f9d8c393e9850375d1b4d45c3096561f8
dir: /docs/content/indexes/category.md/

---
title: "Example Index - Category"
date: "2013-07-01"
linktitle: "Example - Categories"
aliases: ["/extras/indexes/category"]
groups: ["indexes"]
groups_weight: 60
---

This page demonstrates what would be required to add a new index called "categories" to your site.

## config.yaml
First step is to define the index in your config file.
*Because we use both the singular and plural name of the index in our rendering it's
important to provide both here. We require this, rather than using inflection in
effort to support as many languages as possible.*

{{% highlight yaml %}}
---
indexes:
category: "categories"
baseurl: "http://spf13.com/"
title: "Steve Francia is spf13.com"
---
{{% /highlight %}}

## /layouts/indexes/category.html

For each index type a template needs to be provided to render the index page.
In the case of categories, this will render the content for /categories/`CATEGORYNAME`/.

{{% highlight html %}}
{{ template "chrome/header.html" . }}
{{ template "chrome/subheader.html" . }}

<section id="main">
<div>
<h1 id="title">{{ .Title }}</h1>
{{ range .Data.Pages }}
{{ .Render "summary"}}
{{ end }}
</div>
</section>

{{ template "chrome/footer.html" }}
{{% /highlight %}}


## Assigning indexes to content

Make sure that the index is set in the front matter:

{{% highlight json %}}
{
    "title": "Hugo: A fast and flexible static site generator",
    "categories": [
        "Development",
        "Go",
        "Blogging"
    ],
    "slug": "hugo"
}
{{% /highlight %}}