Skip to main content

Archive

View Source Edit this page (external link)
Published:

Yore provides a dedicated archive feature to aggregate all posts into a single list.

Setup Link to this heading

Create _index.md in your archive section and set listScope: site in its front matter. The file must be named _index.md. Using index.md prevents Hugo from treating it as a list page.

Sorting and grouping are not automatically chronological. Set sectionSortBy, sectionGroupBy, and related params explicitly to get the expected behavior.

content/archive/_index.md
---
title: Archive
params:
  listScope: site
  sectionSortBy: Date
  sectionSortOrder: desc
  sectionGroupBy: Date
  sectionGroupLayout: "January 2006"
  sectionGroupOrder: desc
---

Sorting and grouping options Link to this heading

The options of sectionSortBy, sectionGroupBy and related params uses Hugo's method (external link).

ParamTypeDescription
sectionSortBystringField used to sort pages. Accepts any Pages method (external link): Date, ExpiryDate, Lastmod, Length, LinkTitle, PublishDate, Title, Weight, or Param.[FRONT_MATTER_KEY].
sectionSortOrder'asc' | 'desc'Sort direction.
sectionGroupBystringField used to group pages. Accepts Date, ExpiryDate, Lastmod, PublishDate, or Param.[FRONT_MATTER_KEY].
sectionGroupLayoutstringGo time format string for group headings. Example: "January 2006" or "2006年1月". See layout strings (external link).
sectionGroupOrder'asc' | 'desc'Group sort direction.

Excluding pages Link to this heading

pageNoList: true excludes a page from list pages (including the archive) and search results.

It does not remove the page from the sitemap. To exclude the page from the sitemap as well, customize Hugo's built-in sitemap template (external link). See the official documentation (external link).

Article Connections

Accessibility settings

Font size