hugo/content/templates/section-templates.md
Bjørn Erik Pedersen ba45da9d03 Squashed 'docs/' changes from 44fe0285..32356e4e
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
2017-09-21 19:03:00 +02:00

3.8 KiB

title linktitle description date publishdate lastmod categories keywords menu weight sections_weight draft aliases toc
Section Page Templates Section Templates Templates used for section pages are **lists** and therefore have all the variables and methods available to list pages. 2017-02-01 2017-02-01 2017-02-01
templates
lists
sections
docs
parent weight
templates 40
40 40 false
/templates/sections/
true

Add Content and Front Matter to Section Templates

To effectively leverage section page templates, you should first understand Hugo's content organization and, specifically, the purpose of _index.md for adding content and front matter to section and other list pages.

Section Template Lookup Order

The lookup order for section templates is as follows:

  1. /layouts/section/<SECTION>.html
  2. /layouts/<SECTION>/list.html
  3. /layouts/_default/section.html
  4. /layouts/_default/list.html
  5. /themes/<THEME>/layouts/section/<SECTION>.html
  6. /themes/<THEME>/layouts/<SECTION>/list.html
  7. /themes/<THEME>/layouts/_default/section.html
  8. /themes/<THEME>/layouts/_default/list.html

{{< youtube jrMClsB3VsY >}}

.Site.GetPage with Sections

Every Page in Hugo has a .Kind attribute. Kind can easily be combined with the where function in your templates to create kind-specific lists of content. This method is ideal for creating lists, but there are times where you may want to fetch just the index page of a single section via the section's path.

The .GetPage function looks up an index page of a given Kind and path.

{{% note %}} .GetPage is not currently supported to grab single content files but may be supported in the future. {{% /note %}}

You can call .Site.GetPage with two arguments: kind and kind value.

These are the valid values for 'kind':

  1. home
  2. section
  3. taxonomy
  4. taxonomyTerm

Example: Creating a Default Section Template

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

{{ .Content }}
    {{ range .Paginator.Pages }}
  • {{.Title}}
    {{ partial "summary.html" . }}
  • {{ end }}
{{ partial "pagination.html" . }} {{ end }} {{< /code >}}

Example: Using .Site.GetPage

The .Site.GetPage example that follows assumes the following project directory structure:

.
└── content
    ├── blog
    │   ├── _index.md # "title: My Hugo Blog" in the front matter
    │   ├── post-1.md
    │   ├── post-2.md
    │   └── post-3.md
    └── events #Note there is no _index.md file in "events"
        ├── event-1.md
        └── event-2.md

.Site.GetPage will return nil if no _index.md page is found. Therefore, if content/blog/_index.md does not exist, the template will output the section name:

<h1>{{ with .Site.GetPage "section" "blog" }}{{ .Title }}{{ end }}</h1>

Since blog has a section index page with front matter at content/blog/_index.md, the above code will return the following result:

<h1>My Hugo Blog</h1>

If we try the same code with the events section, however, Hugo will default to the section title because there is no content/events/_index.md from which to pull content and front matter:

<h1>{{ with .Site.GetPage "section" "events" }}{{ .Title }}{{ end }}</h1>

Which then returns the following:

<h1>Events</h1>