hugo/content/templates/homepage.md
Bjørn Erik Pedersen 7a89dce53b Squashed 'docs/' changes from 32356e4e..5be6fef0
5be6fef0 Fix typo, {{Content} should be {{.Content}}

git-subtree-dir: docs
git-subtree-split: 5be6fef0b00d06a0c780397c4f4ac8db31b56456
2017-09-23 10:08:55 +02:00

3 KiB

title linktitle description date publishdate lastmod categories keywords menu weight sections_weight draft aliases toc
Homepage Template Homepage Template The homepage of a website is often formatted differently than the other pages. For this reason, Hugo makes it easy for you to define your new site's homepage as a unique template. 2017-02-01 2017-02-01 2017-02-01
templates
homepage
docs
parent weight
templates 30
30 30 false
/layout/homepage/
/templates/homepage-template/
true

Homepage is a Page and therefore has all the page variables and site variables available for use.

{{% note "The Only Required Template" %}} The homepage template is the only required template for building a site and therefore useful when bootstrapping a new site and template. It is also the only required template if you are developing a single-page website. {{% /note %}}

{{< youtube ut1xtRZ1QOA >}}

Homepage Template Lookup Order

The lookup order for the homepage template is as follows:

  1. /layouts/index.html
  2. /layouts/_default/list.html
  3. /themes/<THEME>/layouts/index.html
  4. /themes/<THEME>/layouts/_default/list.html

Add Content and Front Matter to the Homepage

The homepage, similar to other list pages in Hugo, accepts content and front matter from an _index.md file. This file should live at the root of your content folder (i.e., content/_index.md). You can then add body copy and metadata to your homepage the way you would any other content file.

See the homepage template below or Content Organization for more information on the role of _index.md in adding content and front matter to list pages.

.Data.Pages on the Homepage

In addition to the standard page variables, the homepage template has access to all site content via .Data.Pages.

Example Homepage Template

The following is an example of a homepage template that uses partial, base templates, and a content file at content/_index.md to populate the {{.Title}} and {{.Content}} page variables.

{{< code file="layouts/index.html" download="index.html" >}} {{ define "main" }}

{{.Title}}

{{ with .Params.subtitle }} {{.}} {{ end }}
{{.Content}}
{{ range first 10 .Data.Pages }} {{ .Render "summary"}} {{ end }}
{{ end }} {{< /code >}}