hugo/docs/content/themes/creation.md

---
date: 2014-05-12T10:09:17Z
menu:
  main:
    parent: themes
next: /templates/overview
prev: /themes/customizing
title: Creating a Theme
weight: 50
---

Hugo has the ability to create a new theme in your themes directory for you
using the `hugo new` command.

`hugo new theme [name]`

This command will initialize all of the files and directories a basic theme
would need. Hugo themes are written in the Go template language. If you are new
to Go, the [Go template primer](/layout/go-templates/) will help you get started.

## Theme Components

A theme consists of templates and static assets such as javascript and css
files. Themes can also optionally provide [archetypes](/content/archetypes/)
which are archetypal content types used by the `hugo new` command.

### Layouts

Hugo is built around the concept that things should be as simple as possible.
Fundamentally website content is displayed in two different ways, a single
piece of content and a list of content items. With Hugo a theme layout starts
with the defaults. As additional layouts are defined they are used for the
content type or section they apply to. This keeps layouts simple, but permits
a large amount of flexibility.

### Single Content

The default single file layout is located at `layouts/_default/single.html`.

### List of Contents

The default list file layout is located at `layouts/_default/list.html`.

### Partial Templates

Theme creators should liberally use [partial templates](/templates/partials/)
throughout their theme files. Not only is a good DRY practice to include shared
code, but partials are a special template type that enables the themes end user
to be able to overwrite just a small piece of a file or inject code into the
theme from their local /layouts. These partial templates are perfect for easy
injection into the theme with minimal maintenance to ensure future
compatibility.

### Static

Everything in the static directory will be copied directly into the final site
when rendered. No structure is provided here to enable complete freedom. It is
common to organize the static content into:

    /css
    /js
    /img

The actual structure is entirely up to you, the theme creator, on how you would like to organize your files.


### Archetypes

If your theme makes use of specific keys in the front matter, it is a good idea
to provide an archetype for each content type you have. Archetypes follow the
[guidelines provided](/content/archetypes/).


### Generator meta tag

With a growing community around Hugo we recommend theme creators to include the [Generator meta tag]({{< relref "templates/variables.md#hugo-variables" >}}) with `.Hugo.Generator` in the `<head>` of your HTML code. The output  might looks like `<meta name="generator" content="Hugo 0.13" />` and helps us to analyse the usage and popularity of Hugo.
Converting front matter to YAML 2014-05-29 18:42:05 -04:00			`---`
			`date: 2014-05-12T10:09:17Z`
			`menu:`
			`main:`
			`parent: themes`
			`next: /templates/overview`
			`prev: /themes/customizing`
			`title: Creating a Theme`
			`weight: 50`
			`---`
Updating / Rewriting / Adding all of the documentation in preparation for the next release 2014-05-27 18:32:57 -04:00
			`Hugo has the ability to create a new theme in your themes directory for you`
			using the `hugo new` command.

			`hugo new theme [name]`

			`This command will initialize all of the files and directories a basic theme`
Minor proofreading corrections to Hugo docs 2014-08-31 07:08:36 -04:00			`would need. Hugo themes are written in the Go template language. If you are new`
			`to Go, the [Go template primer](/layout/go-templates/) will help you get started.`
Updating / Rewriting / Adding all of the documentation in preparation for the next release 2014-05-27 18:32:57 -04:00
			`## Theme Components`

			`A theme consists of templates and static assets such as javascript and css`
[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly 2015-01-27 21:17:09 -05:00			`files. Themes can also optionally provide [archetypes](/content/archetypes/)`
Updating / Rewriting / Adding all of the documentation in preparation for the next release 2014-05-27 18:32:57 -04:00			which are archetypal content types used by the `hugo new` command.

			`### Layouts`

			`Hugo is built around the concept that things should be as simple as possible.`
			`Fundamentally website content is displayed in two different ways, a single`
			`piece of content and a list of content items. With Hugo a theme layout starts`
			`with the defaults. As additional layouts are defined they are used for the`
			`content type or section they apply to. This keeps layouts simple, but permits`
			`a large amount of flexibility.`

			`### Single Content`

			The default single file layout is located at `layouts/_default/single.html`.

			`### List of Contents`

Docs: Minor copyediting/proofreading - Correct some typos - Add backticks and commas where necessary - Use fenced code blocks specifying "bash" as the language to avoid weird highlighting - Place commas outside of quotation marks surroundingn codes to avoid possible confusion - Suggest users to use the discussion forum rather than the mailing list 2014-12-04 11:26:12 -05:00			The default list file layout is located at `layouts/_default/list.html`.
Updating / Rewriting / Adding all of the documentation in preparation for the next release 2014-05-27 18:32:57 -04:00
Adding 'partial' template function to add theme / local awareness to the partials directory. 2014-06-06 16:15:19 -04:00			`### Partial Templates`

[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly 2015-01-27 21:17:09 -05:00			`Theme creators should liberally use [partial templates](/templates/partials/)`
Adding 'partial' template function to add theme / local awareness to the partials directory. 2014-06-06 16:15:19 -04:00			`throughout their theme files. Not only is a good DRY practice to include shared`
			`code, but partials are a special template type that enables the themes end user`
			`to be able to overwrite just a small piece of a file or inject code into the`
			`theme from their local /layouts. These partial templates are perfect for easy`
			`injection into the theme with minimal maintenance to ensure future`
			`compatibility.`
Updating / Rewriting / Adding all of the documentation in preparation for the next release 2014-05-27 18:32:57 -04:00
			`### Static`

			`Everything in the static directory will be copied directly into the final site`
			`when rendered. No structure is provided here to enable complete freedom. It is`
doc: Strip trailing whitespace; other revisions Make some random and non-comprehensive changes to the template functions documentation to make them more consistent. 2015-08-04 14:00:08 -04:00			`common to organize the static content into:`
Updating / Rewriting / Adding all of the documentation in preparation for the next release 2014-05-27 18:32:57 -04:00
			`/css`
			`/js`
			`/img`

			`The actual structure is entirely up to you, the theme creator, on how you would like to organize your files.`


			`### Archetypes`

[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly 2015-01-27 21:17:09 -05:00			`If your theme makes use of specific keys in the front matter, it is a good idea`
Updating / Rewriting / Adding all of the documentation in preparation for the next release 2014-05-27 18:32:57 -04:00			`to provide an archetype for each content type you have. Archetypes follow the`
[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly 2015-01-27 21:17:09 -05:00			`[guidelines provided](/content/archetypes/).`
Updating / Rewriting / Adding all of the documentation in preparation for the next release 2014-05-27 18:32:57 -04:00
Add mention about .Hugo.Generator in 'Creating a theme' section 2015-07-18 06:23:52 -04:00
			`### Generator meta tag`

			With a growing community around Hugo we recommend theme creators to include the [Generator meta tag]({{< relref "templates/variables.md#hugo-variables" >}}) with `.Hugo.Generator` in the `<head>` of your HTML code. The output might looks like `<meta name="generator" content="Hugo 0.13" />` and helps us to analyse the usage and popularity of Hugo.