diff options
Diffstat (limited to 'docs/content/templates/overview.md')
-rw-r--r-- | docs/content/templates/overview.md | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/docs/content/templates/overview.md b/docs/content/templates/overview.md new file mode 100644 index 000000000..3b41a6641 --- /dev/null +++ b/docs/content/templates/overview.md @@ -0,0 +1,76 @@ +--- +aliases: +- /doc/templates/ +- /layout/templates/ +- /layout/overview/ +lastmod: 2015-05-22 +date: 2013-07-01 +linktitle: Overview +menu: + main: + parent: layout +next: /templates/go-templates +prev: /themes/creation +title: Hugo Templates +weight: 10 +toc: true +--- + +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 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 don’t be afraid of the variety of different template roles. They +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 Go’s 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, e.g. 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 + +### [Alias](/extras/aliases/#customizing) +This template will override the default page used to create aliases of pages. + |