hugo/docs/content/templates/overview.md

72 lines
2.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
aliases:
- /doc/templates/
- /layout/templates/
- /layout/overview/
date: 2013-07-01
linktitle: Overview
menu:
main:
parent: layout
next: /templates/go-templates
prev: /themes/creation
title: Hugo Templates
weight: 10
---
Hugo uses the excellent go html/template library for its template engine.
It is an extremely lightweight engine that provides a very small amount of
logic. In our experience that it is just the right amount of logic to be able
to create a good static website.
While Hugo has a number of different template roles, most complete
websites can be built using just a small number of template files.
Please dont be afraid of the variety of different template roles. They
are enable Hugo to build very complicated sites. Most sites will only
need to create a [/layouts/\_default/single.html](/templates/content) & [/layouts/\_default/list.html](/templates/list)
If you are new to go's templates the [go template primer](/layout/go-templates)
is a great place to start.
If you are familiar with gos templates, Hugo provides some [additional
template functions](/templates/functions) and [variables](/templates/variables) you will want to be familiar
with.
## Primary Template roles
There are 3 primary kinds of templates that Hugo works with.
### [Single](/templates/content)
Render a single piece of content
### [List](/templates/list)
Page that list multiple pieces of content
### [Homepage](/templates/homepage/)
The homepage of your site
## Supporting Template Roles (optional)
Hugo also has additional kinds of templates all of which are optional
### [Partial Templates](/templates/partials)
Common page parts to be included in the above mentioned templates
### [Content Views](/templates/views)
Different ways of rendering a (single) content type
### [Taxonomy Terms](/templates/terms)
A list of the terms used for a specific taxonomy eg. a Tag cloud
## Other Templates (generally unnecessary)
### [RSS](/templates/rss/)
Used to render all rss documents
### [Sitemap](/templates/sitemap/)
Used to render the XML sitemap
### [404](/templates/404)
This template will create a 404.html page used when hosting on github pages