hugo/docs/content/templates/homepage.md
Anthony Fok 5505ac0d72 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 12:00:08 -06:00

2.4 KiB
Raw Blame History

aliases date menu next notoc prev title weight
/layout/homepage/
2013-07-01
main
parent
layout
/templates/terms true /templates/list Homepage 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 of the type "node" and have all the node variables and site 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 node 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.

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 isnt 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.

It makes use of partial templates and uses a similar approach as a 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" . }}