hugo/docs/content/templates/homepage.md

---
aliases:
- /layout/homepage/
lastmod: 2015-08-04
date: 2013-07-01
menu:
  main:
    parent: layout
next: /templates/terms
notoc: true
prev: /templates/list
title: Homepage
weight: 50
---

The home page of a website is often formatted differently than the other
pages. In Hugo you can define your own homepage template.

Homepage is a `Page` and have all the [page
variables](/templates/variables/) and [site
variables](/templates/variables/) available to use in the templates.

*This is the only required template for building a site and useful when
bootstrapping a new site and template. It is also the only required
template when using a single page site.*

In addition to the standard page variables, the homepage has access to
all site content accessible from `.Data.Pages`. Details on how to use the
list of pages can be found in the [Lists Template](/templates/list/).

Note that a home page can also have a content file with frontmatter,  see [Source Organization]({{< relref "overview/source-directory.md#content-for-home-page-and-other-list-pages" >}}).

## Which Template will be rendered?
Hugo uses a set of rules to figure out which template to use when
rendering a specific page.

Hugo will use the following prioritized list. If a file isn’t present,
then the next one in the list will be used. This enables you to craft
specific layouts when you want to without creating more templates
than necessary. For most sites, only the \_default file at the end of
the list will be needed.

* /layouts/index.html
* /layouts/\_default/list.html
* /layouts/\_default/single.html
* /themes/`THEME`/layouts/index.html
* /themes/`THEME`/layouts/\_default/list.html
* /themes/`THEME`/layouts/\_default/single.html

## Example index.html
This content template is used for [spf13.com](http://spf13.com/).

It makes use of [partial templates](/templates/partials/) and uses a similar approach as a [List](/templates/list/).

    <!DOCTYPE html>
    <html class="no-js" lang="en-US" prefix="og: http://ogp.me/ns# fb: http://ogp.me/ns/fb#">
    <head>
        <meta charset="utf-8">

        {{ partial "meta.html" . }}

        <base href="{{ .Site.BaseURL }}">
        <title>{{ .Site.Title }}</title>
        <link rel="canonical" href="{{ .Permalink }}">
        <link href="{{ .RSSLink }}" rel="alternate" type="application/rss+xml" title="{{ .Site.Title }}" />

        {{ partial "head_includes.html" . }}
    </head>
    <body lang="en">

    {{ partial "subheader.html" . }}

    <section id="main">
      <div>
        {{ range first 10 .Data.Pages }}
            {{ .Render "summary"}}
        {{ end }}
      </div>
    </section>

    {{ partial "footer.html" . }}
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 18:32:57 -04:00
+								---
-												Converting front matter to YAML

											
										
										
											2014-05-29 18:42:05 -04:00
+								aliases:
 								- /layout/homepage/
-												docs: Add lastmod to content files

Based on last commit in Git.

											
										
										
											2016-01-06 17:45:19 -05:00
+								lastmod: 2015-08-04
-												Converting front matter to YAML

											
										
										
											2014-05-29 18:42:05 -04:00
+								date: 2013-07-01
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 18:32:57 -04:00
+								menu:
 								  main:
-												Converting front matter to YAML

											
										
										
											2014-05-29 18:42:05 -04:00
+								    parent: layout
 								next: /templates/terms
 								notoc: true
 								prev: /templates/list
 								title: Homepage
 								weight: 50
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 18:32:57 -04:00
+								---
 								The home page of a website is often formatted differently than the other
-												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
+								pages. In Hugo you can define your own homepage template.
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 18:32:57 -04:00
-												docs: Revise docs to reflect that Node is gone

Updates #2297

											
										
										
											2016-11-20 17:00:57 -05:00
+								Homepage is a `Page` and have all the [page
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 18:32:57 -04:00
+								variables](/templates/variables/) and [site
 								variables](/templates/variables/) available to use in the templates.
 								*This is the only required template for building a site and useful when
 								bootstrapping a new site and template. It is also the only required
 								template when using a single page site.*
-												docs: Revise docs to reflect that Node is gone

Updates #2297

											
										
										
											2016-11-20 17:00:57 -05:00
+								In addition to the standard page variables, the homepage has access to
-												More proofreading and minor revisions to Hugo docs

Among the various changes, most instances of

    {{ template "partials/FILE.html" . }}

were changed to

    {{ partial "FILE.html" . }}

Also, in main.go, change "2013" to "2013-14".

											
										
										
											2014-09-03 00:12:26 -04:00
+								all site content accessible from `.Data.Pages`. Details on how to use the
 								list of pages can be found in the [Lists Template](/templates/list/).
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 18:32:57 -04:00
-												docs: Add sections on node now being a page

Updates #2297

											
										
										
											2016-11-21 07:02:02 -05:00
+								Note that a home page can also have a content file with frontmatter,  see [Source Organization]({{< relref "overview/source-directory.md#content-for-home-page-and-other-list-pages" >}}).
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 18:32:57 -04:00
+								## Which Template will be rendered?
 								Hugo uses a set of rules to figure out which template to use when
 								rendering a specific page.
-												More proofreading and minor revisions to Hugo docs

Among the various changes, most instances of

    {{ template "partials/FILE.html" . }}

were changed to

    {{ partial "FILE.html" . }}

Also, in main.go, change "2013" to "2013-14".

											
										
										
											2014-09-03 00:12:26 -04:00
+								Hugo will use the following prioritized list. If a file isn’t present,
 								then the next one in the list will be used. This enables you to craft
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 18:32:57 -04:00
+								specific layouts when you want to without creating more templates
-												More proofreading and minor revisions to Hugo docs

Among the various changes, most instances of

    {{ template "partials/FILE.html" . }}

were changed to

    {{ partial "FILE.html" . }}

Also, in main.go, change "2013" to "2013-14".

											
										
										
											2014-09-03 00:12:26 -04:00
+								than necessary. For most sites, only the \_default file at the end of
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 18:32:57 -04:00
+								the list will be needed.
 								* /layouts/index.html
 								* /layouts/\_default/list.html
 								* /layouts/\_default/single.html
 								* /themes/`THEME`/layouts/index.html
 								* /themes/`THEME`/layouts/\_default/list.html
 								* /themes/`THEME`/layouts/\_default/single.html
-												More proofreading and minor revisions to Hugo docs

Among the various changes, most instances of

    {{ template "partials/FILE.html" . }}

were changed to

    {{ partial "FILE.html" . }}

Also, in main.go, change "2013" to "2013-14".

											
										
										
											2014-09-03 00:12:26 -04:00
+								## Example index.html
-												[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
+								This content template is used for [spf13.com](http://spf13.com/).
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 18:32:57 -04:00
-												[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
+								It makes use of [partial templates](/templates/partials/) and uses a similar approach as a [List](/templates/list/).
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 18:32:57 -04:00
 								    <!DOCTYPE html>
 								    <html class="no-js" lang="en-US" prefix="og: http://ogp.me/ns# fb: http://ogp.me/ns/fb#">
 								    <head>
 								        <meta charset="utf-8">
-												Adding 'partial' template function to add theme / local awareness to the partials directory.

											
										
										
											2014-06-06 16:15:19 -04:00
+								        {{ partial "meta.html" . }}
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 18:32:57 -04:00
-												Update Hugo docs with the initialisms suggested by golint

In particular:

 * .Url → .URL (for node, menu and paginator)
 * .Site.BaseUrl → .Site.BaseURL
 * getJson → getJSON
 * getCsv → getCSV
 * safeHtml → safeHTML
 * safeCss → safeCSS
 * safeUrl → safeURL

Continued effort in fixing #959.

											
										
										
											2015-03-18 02:44:12 -04:00
+								        <base href="{{ .Site.BaseURL }}">
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 18:32:57 -04:00
+								        <title>{{ .Site.Title }}</title>
 								        <link rel="canonical" href="{{ .Permalink }}">
-												docs: Rename RSSlink to RSSLink

The former will be deprecated.

											
										
										
											2016-11-17 02:18:55 -05:00
+								        <link href="{{ .RSSLink }}" rel="alternate" type="application/rss+xml" title="{{ .Site.Title }}" />
-												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 "head_includes.html" . }}
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 18:32:57 -04:00
+								    </head>
 								    <body lang="en">
-												Adding 'partial' template function to add theme / local awareness to the partials directory.

											
										
										
											2014-06-06 16:15:19 -04:00
+								    {{ partial "subheader.html" . }}
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 18:32:57 -04:00
 								    <section id="main">
 								      <div>
 								        {{ range first 10 .Data.Pages }}
 								            {{ .Render "summary"}}
 								        {{ end }}
 								      </div>
 								    </section>
-												[Docs] Fix more missing `.` in example `partial` calls

											
										
										
											2015-01-31 09:27:42 -05:00
+								    {{ partial "footer.html" . }}