mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
ba45da9d03
32356e4e Fix typo in header of shortcode-templates.md c8f1a2d2 Correct code example for index template function bfa6a55d Escape code fencing ff8b2f99 Fix typos in deployment with wercker tutorial 557c36e8 theme: Merge commit '7fbb4bed25001182bfeb91f79db0f0c1936582ee' 7fbb4bed Squashed 'themes/gohugoioTheme/' changes from 7dd8a302..ca53082d ce31cee0 Add "See Also" config 158cee1b Make the tags into keywords 61600be6 Add a note to the related section 49edb5a2 Relase 0.27.1 c9bbc001 releaser: Add release notes to /docs for release of 0.27.1 213c6c3b Add bugs poster 8b4590cd Add KeyCDN integration tutorial 2b277859 Add tutorial videos to several docs pages 950fef1f Update roadmap to link to the correct milestones page 496f5bf6 Rename relnotes d6f9378d Bump Netlify versions to 0.27 087fde7f Update 0.27 release notes 603f94ae docs: Document Related Content 3790f6a3 releaser: Bump versions for release of 0.27 0948868c releaser: Add release notes to /docs for release of 0.27 git-subtree-dir: docs git-subtree-split: 32356e4eabe357ae914f4d1d59e8ae31ce936723
81 lines
3 KiB
Markdown
81 lines
3 KiB
Markdown
---
|
|
title: Homepage Template
|
|
linktitle: Homepage Template
|
|
description: 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.
|
|
date: 2017-02-01
|
|
publishdate: 2017-02-01
|
|
lastmod: 2017-02-01
|
|
categories: [templates]
|
|
keywords: [homepage]
|
|
menu:
|
|
docs:
|
|
parent: "templates"
|
|
weight: 30
|
|
weight: 30
|
|
sections_weight: 30
|
|
draft: false
|
|
aliases: [/layout/homepage/,/templates/homepage-template/]
|
|
toc: true
|
|
---
|
|
|
|
Homepage is a `Page` and therefore has all the [page variables][pagevars] and [site variables][sitevars] 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][lookup] 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][lists], 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][contentorg] 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][pagevars], 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][partials], [base][] templates, and a content file at `content/_index.md` to populate the `{{.Title}}` and `{{Content}}` [page variables][pagevars].
|
|
|
|
{{< code file="layouts/index.html" download="index.html" >}}
|
|
{{ define "main" }}
|
|
<main aria-role="main">
|
|
<header class="homepage-header">
|
|
<h1>{{.Title}}</h1>
|
|
{{ with .Params.subtitle }}
|
|
<span class="subtitle">{{.}}</span>
|
|
{{ end }}
|
|
</header>
|
|
<div class="homepage-content">
|
|
<!-- Note that the content for index.html, as a sort of list page, will pull from content/_index.md -->
|
|
{{.Content}}
|
|
</div>
|
|
<div>
|
|
<!-- Note that .Data.Pages is the equivalent of .Site.Pages on the homepage template. -->
|
|
{{ range first 10 .Data.Pages }}
|
|
{{ .Render "summary"}}
|
|
{{ end }}
|
|
</div>
|
|
</main>
|
|
{{ end }}
|
|
{{< /code >}}
|
|
|
|
[base]: /templates/base/
|
|
[contentorg]: /content-management/organization/
|
|
[lists]: /templates/lists/
|
|
[lookup]: /templates/lookup-order/
|
|
[pagevars]: /variables/page/
|
|
[partials]: /templates/partials/
|
|
[sitevars]: /variables/site/
|