What's on this Page Show
TEMPLATES Lists of Content in HugoLists have a specific meaning and usage in Hugo when it comes to rendering your site homepage, section page, taxonomy list, or taxonomy terms list. What is a List Page Template?A list page template is a template used to render multiple pieces of content in a single HTML page. The exception to this rule is the homepage, which is still a list but has its own dedicated template. Hugo uses the term list in its truest sense; i.e. a sequential arrangement of material, especially in alphabetical or numerical order. Hugo uses list templates on any output HTML page where content is traditionally listed:
For template lookup order, see Template Lookup. The idea of a list page comes from the hierarchical mental model of the web and is best demonstrated visually:  List DefaultsDefault TemplatesSince section lists and taxonomy lists (N.B., not taxonomy terms lists) are both lists with regards to their templates, both have the same terminating default of _default/list.html or themes/<THEME>/layouts/_default/list.html in their lookup order. In addition, both section lists and taxonomy lists have their own default list templates in _default. See Template Lookup Order for the complete reference. Add Content and Front Matter to List PagesSince v0.18, everything in Hugo is a Page. This means list pages and the homepage can have associated content files (i.e. _index.md) that contain page metadata (i.e., front matter) and content. This new model allows you to include list-specific front matter via .Params and also means that list templates (e.g., layouts/_default/list.html) have access to all page variables. It is important to note that all _index.md content files will render according to a list template and not according to a single page template. Example Project DirectoryThe following is an example of a typical Hugo project directorys content: . ... content | posts | | _index.md | | post-01.md | | post-02.md | quote | | quote-01.md | | quote-02.md ...Using the above example, lets assume you have the following in content/posts/_index.md: content/posts/_index.md ---
title: My Go Journey
date: 2017-03-23
publishdate: 2017-03-24
---
I decided to start learning Go in March 2017.
Follow my journey through this new blog. You can now access this _index.mds' content in your list template: layouts/_default/list.html {{ define "main" }}
<main>
<article>
<header>
<h2>{{.Title}}</h2>
</header>
<!-- "{{.Content}}" pulls from the markdown content of the corresponding _index.md -->
{{.Content}}
</article>
<ul>
<!-- Ranges through content/posts/*.md -->
{{ range .Pages }}
<li>
<a href="{{.Permalink}}">{{.Date.Format "2006-01-02"}} | {{.Title}}</a>
</li>
{{ end }}
</ul>
</main>
{{ end }} This above will output the following HTML: example.com/posts/index.html <!--top of your baseof code-->
<main>
<article>
<header>
<h2>My Go Journey</h2>
</header>
<p>I decided to start learning Go in March 2017.</p>
<p>Follow my journey through this new blog.</p>
</article>
<ul>
<li><a href="/posts/post-01/">Post 1</a></li>
<li><a href="/posts/post-02/">Post 2</a></li>
</ul>
</main>
<!--bottom of your baseof--> List Pages Without _index.mdYou do not have to create an _index.md file for every list page (i.e. section, taxonomy, taxonomy terms, etc) or the homepage. If Hugo does not find an _index.md within the respective content section when rendering a list template, the page will be created but with no {{.Content}} and only the default values for .Title etc. Using this same layouts/_default/list.html template and applying it to the quotes section above will render the following output. Note that quotes does not have an _index.md file to pull from: example.com/quote/index.html <!--baseof-->
<main>
<article>
<header>
<!-- Hugo assumes that .Title is the name of the section since there is no _index.md content file from which to pull a "title:" field -->
<h2>Quotes</h2>
</header>
</article>
<ul>
<li><a href="https://example.com/quote/quotes-01/">Quote 1</a></li>
<li><a href="https://example.com/quote/quotes-02/">Quote 2</a></li>
</ul>
</main>
<!--baseof--> The default behavior of Hugo is to pluralize list titles; hence the inflection of the quote section to Quotes when called with the .Title page variable. You can change this via the pluralizeListTitles directive in your site configuration. Example List TemplatesSection TemplateThis list template has been modified slightly from a template originally used in spf13.com. It makes use of partial templates for the chrome of the rendered page rather than using a base template. The examples that follow also use the content view templates li.html or summary.html. layouts/section/posts.html {{ partial "header.html" . }}
{{ partial "subheader.html" . }}
<main>
<div>
<h2>{{ .Title }}</h2>
<ul>
<!-- Renders the li.html content view for each content/posts/*.md -->
{{ range .Pages }}
{{ .Render "li"}}
{{ end }}
</ul>
</div>
</main>
{{ partial "footer.html" . }} Taxonomy Templatelayouts/_default/taxonomy.html {{ define "main" }}
<main>
<div>
<h2>{{ .Title }}</h2>
<!-- ranges through each of the content files associated with a particular taxonomy term and renders the summary.html content view -->
{{ range .Pages }}
{{ .Render "summary"}}
{{ end }}
</div>
</main>
{{ end }} Order ContentHugo lists render the content based on metadata you provide in front matter. In addition to sane defaults, Hugo also ships with multiple methods to make quick work of ordering content inside list templates: Default: Weight > Date > LinkTitle > FilePathlayouts/partials/default-order.html <ul>
{{ range .Pages }}
<li>
<h2><a href="{{ .Permalink }}">{{ .Title }}</a></h2>
<time>{{ .Date.Format "Mon, Jan 2, 2006" }}</time>
</li>
{{ end }}
</ul> By WeightLower weight gets higher precedence. So content with lower weight will come first. layouts/partials/by-weight.html <ul>
{{ range .Pages.ByWeight }}
<li>
<h2><a href="{{ .Permalink }}">{{ .Title }}</a></h2>
<time>{{ .Date.Format "Mon, Jan 2, 2006" }}</time>
</li>
{{ end }}
</ul> By Datelayouts/partials/by-date.html <ul>
<!-- orders content according to the "date" field in front matter -->
{{ range .Pages.ByDate }}
<li>
<h2><a href="{{ .Permalink }}">{{ .Title }}</a></h2>
<time>{{ .Date.Format "Mon, Jan 2, 2006" }}</time>
</li>
{{ end }}
</ul> By Publish Datelayouts/partials/by-publish-date.html <ul>
<!-- orders content according to the "publishdate" field in front matter -->
{{ range .Pages.ByPublishDate }}
<li>
<h2><a href="{{ .Permalink }}">{{ .Title }}</a></h2>
<time>{{ .Date.Format "Mon, Jan 2, 2006" }}</time>
</li>
{{ end }}
</ul> By Expiration Datelayouts/partials/by-expiry-date.html <ul>
{{ range .Pages.ByExpiryDate }}
<li>
<h2><a href="{{ .Permalink }}">{{ .Title }}</a></h2>
<time>{{ .Date.Format "Mon, Jan 2, 2006" }}</time>
</li>
{{ end }}
</ul> By Last Modified Datelayouts/partials/by-last-mod.html <ul>
<!-- orders content according to the "lastmod" field in front matter -->
{{ range .Pages.ByLastmod }}
<li>
<h2><a href="{{ .Permalink }}">{{ .Title }}</a></h2>
<time>{{ .Date.Format "Mon, Jan 2, 2006" }}</time>
</li>
{{ end }}
</ul> By Lengthlayouts/partials/by-length.html <ul>
<!-- orders content according to content length in ascending order (i.e., the shortest content will be listed first) -->
{{ range .Pages.ByLength }}
<li>
<h2><a href="{{ .Permalink }}">{{ .Title }}</a></h2>
<time>{{ .Date.Format "Mon, Jan 2, 2006" }}</time>
</li>
{{ end }}
</ul> By Titlelayouts/partials/by-title.html <ul>
<!-- ranges through content in ascending order according to the "title" field set in front matter -->
{{ range .Pages.ByTitle }}
<li>
<h2><a href="{{ .Permalink }}">{{ .Title }}</a></h2>
<time>{{ .Date.Format "Mon, Jan 2, 2006" }}</time>
</li>
{{ end }}
</ul> By Link Titlelayouts/partials/by-link-title.html <ul>
<!-- ranges through content in ascending order according to the "linktitle" field in front matter. If a "linktitle" field is not set, the range will start with content that only has a "title" field and use that value for .LinkTitle -->
{{ range .Pages.ByLinkTitle }}
<li>
<h2><a href="{{ .Permalink }}">{{ .LinkTitle }}</a></h2>
<time>{{ .Date.Format "Mon, Jan 2, 2006" }}</time>
</li>
{{ end }}
</ul> By ParameterOrder based on the specified front matter parameter. Content that does not have the specified front matter field will use the sites .Site.Params default. If the parameter is not found at all in some entries, those entries will appear together at the end of the ordering. layouts/partials/by-rating.html <!-- Ranges through content according to the "rating" field set in front matter -->
{{ range (.Pages.ByParam "rating") }}
<!-- ... -->
{{ end }} If the targeted front matter field is nested beneath another field, you can access the field using dot notation. layouts/partials/by-nested-param.html {{ range (.Pages.ByParam "author.last_name") }}
<!-- ... -->
{{ end }} Reverse OrderReversing order can be applied to any of the above methods. The following uses ByDate as an example: layouts/partials/by-date-reverse.html <ul>
{{ range .Pages.ByDate.Reverse }}
<li>
<h2><a href="{{ .Permalink }}">{{ .Title }}</a></h2>
<time>{{ .Date.Format "Mon, Jan 2, 2006" }}</time>
</li>
{{ end }}
</ul> Group ContentHugo provides some functions for grouping pages by Section, Type, Date, etc. By Page Fieldlayouts/partials/by-page-field.html <!-- Groups content according to content section. The ".Key" in this instance will be the section's title. -->
{{ range .Pages.GroupBy "Section" }}
<h3>{{ .Key }}</h3>
<ul>
{{ range .Pages }}
<li>
<a href="{{ .Permalink }}">{{ .Title }}</a>
<div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div>
</li>
{{ end }}
</ul>
{{ end }} In the above example, you may want {{.Title}} to point the title field you have added to your _index.md file instead. You can access this value using the .GetPage function: layouts/partials/by-page-field.html <!-- Groups content according to content section.-->
{{ range .Pages.GroupBy "Section" }}
<!-- Checks for existence of _index.md for a section; if available, pulls from "title" in front matter -->
{{ with $.Site.GetPage "section" .Key }}
<h3>{{.Title}}</h3>
{{ else }}
<!-- If no _index.md is available, ".Key" defaults to the section title and filters to title casing -->
<h3>{{ .Key | title }}</h3>
{{ end }}
<ul>
{{ range .Pages }}
<li>
<a href="{{ .Permalink }}">{{ .Title }}</a>
<div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div>
</li>
{{ end }}
</ul>
{{ end }} By Datelayouts/partials/by-page-date.html <!-- Groups content by month according to the "date" field in front matter -->
{{ range .Pages.GroupByDate "2006-01" }}
<h3>{{ .Key }}</h3>
<ul>
{{ range .Pages }}
<li>
<a href="{{ .Permalink }}">{{ .Title }}</a>
<div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div>
</li>
{{ end }}
</ul>
{{ end }} By Publish Datelayouts/partials/by-page-publish-date.html <!-- Groups content by month according to the "publishDate" field in front matter -->
{{ range .Pages.GroupByPublishDate "2006-01" }}
<h3>{{ .Key }}</h3>
<ul>
{{ range .Pages }}
<li>
<a href="{{ .Permalink }}">{{ .Title }}</a>
<div class="meta">{{ .PublishDate.Format "Mon, Jan 2, 2006" }}</div>
</li>
{{ end }}
</ul>
{{ end }} By Lastmodlayouts/partials/by-page-lastmod.html <!-- Groups content by month according to the "lastMod" field in front matter -->
{{ range .Pages.GroupByLastmod "2006-01" }}
<h3>{{ .Key }}</h3>
<ul>
{{ range .Pages }}
<li>
<a href="{{ .Permalink }}">{{ .Title }}</a>
<div class="meta">{{ .Lastmod.Format "Mon, Jan 2, 2006" }}</div>
</li>
{{ end }}
</ul>
{{ end }} By Expiry Datelayouts/partials/by-page-expiry-date.html <!-- Groups content by month according to the "expiryDate" field in front matter -->
{{ range .Pages.GroupByExpiryDate "2006-01" }}
<h3>{{ .Key }}</h3>
<ul>
{{ range .Pages }}
<li>
<a href="{{ .Permalink }}">{{ .Title }}</a>
<div class="meta">{{ .ExpiryDate.Format "Mon, Jan 2, 2006" }}</div>
</li>
{{ end }}
</ul>
{{ end }} By Page Parameterlayouts/partials/by-page-param.html <!-- Groups content according to the "param_key" field in front matter -->
{{ range .Pages.GroupByParam "param_key" }}
<h3>{{ .Key }}</h3>
<ul>
{{ range .Pages }}
<li>
<a href="{{ .Permalink }}">{{ .Title }}</a>
<div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div>
</li>
{{ end }}
</ul>
{{ end }} By Page Parameter in Date FormatThe following template takes grouping by date a step further and uses Gos layout string. See the Format function for more examples of how to use Gos layout string to format dates in Hugo. layouts/partials/by-page-param-as-date.html <!-- Groups content by month according to the "param_key" field in front matter -->
{{ range .Pages.GroupByParamDate "param_key" "2006-01" }}
<h3>{{ .Key }}</h3>
<ul>
{{ range .Pages }}
<li>
<a href="{{ .Permalink }}">{{ .Title }}</a>
<div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div>
</li>
{{ end }}
</ul>
{{ end }} Reverse Key OrderOrdering of groups is performed by keys in alphanumeric order (AZ, 1100) and in reverse chronological order (i.e., with the newest first) for dates. While these are logical defaults, they are not always the desired order. There are two different syntaxes to change Hugos default ordering for groups, both of which work the same way. 1. Adding the Reverse Method{{ range (.Pages.GroupBy "Section").Reverse }} {{ range (.Pages.GroupByDate "2006-01").Reverse }}2. Providing the Alternate Direction{{ range .Pages.GroupByDate "2006-01" "asc" }} {{ range .Pages.GroupBy "Section" "desc" }}Order Within GroupsBecause Grouping returns a {{.Key}} and a slice of pages, all of the ordering methods listed above are available. Here is the ordering for the example that follows:
layouts/partials/by-group-by-page.html {{ range .Pages.GroupByDate "2006-01" "asc" }}
<h3>{{ .Key }}</h3>
<ul>
{{ range .Pages.ByTitle }}
<li>
<a href="{{ .Permalink }}">{{ .Title }}</a>
<div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div>
</li>
{{ end }}
</ul>
{{ end }} Filtering and Limiting ListsSometimes you only want to list a subset of the available content. A common is to only display posts from main sections on the blogs homepage. See the documentation on where function and first function for further details. See Also
|
