All configurations on blog content type. The blog and docs content types share most of their page and section fields, so the documented below are separate into unique fields and common fields.
These are theme parameters so the fields should goes under params key, e.g,
content/blog/my-post.md
---
# top level: Hugo config
title: "My Post"
type: blog
# params: theme config
params:
breadcrumb: true
pageShowMeta: true
---Page configuration
Unique fields
Accepted fields for individual pages of type blog. If the Front Matter column shows ❌, the field cannot be overridden via front matter.
| Name | Type | Front Matter | Description |
|---|---|---|---|
pageSeriesStyle | string | Show series navigation on the page. Accepts top, bottom, or both. See Series for how series are defined. | |
pageShowRelated | boolean | Show a list of related posts below the content. See Related Article for how related posts are determined. | |
pageRelatedLimit | int | ❌ | Maximum number of related articles to show. |
Common fields
| Name | Type | Front Matter | Description |
|---|---|---|---|
link | boolean | URL link to any internal or external page. | |
breadcrumb | boolean | Show breadcrumb navigation above the page title. | |
pageHeroStyle | string | Render a hero section above the page. Set to disable to turn it off for a specific page. | |
pageTOCStyle | string | Where the table of contents is rendered. Accepts top, sidebar, or disable. On docs pages, top is treated the same as sidebar. | |
pageKgStyle | string | Where the knowledge graph widget is rendered. See Knowledge Graph for what this widget does. | |
pageShowActions | boolean | Show action buttons (e.g. share, copy link) next to the page title. | |
pageShowMeta | boolean | Show publish date, last-updated date, and author info below the title. | |
pageShowAuthors | boolean | Show author information. Only takes effect when pageShowMeta is enabled. | |
pageShowCategories | boolean | Show the page's categories below the content. | |
pageShowTags | boolean | Show the page's tags below the content. | |
pageShowNext | boolean | Show previous/next page links at the bottom of the page. | |
pageShowBacklinks | boolean | Show a list of pages that link back to this one. | |
pageShowStaleWarning | boolean | Show a warning when an article has not been updated in pageStaleDays. | |
pageStaleDays | int | Number of days before an article is considered stale. | |
pageNoList | boolean | Exclude this page from search indexing and from list views. | |
Section configuration
Unique fields
The section fields of blog type is exactly the same as docs type.
Common fields
| Name | Type | Front Matter | Description |
|---|---|---|---|
breadcrumb | boolean | Show breadcrumb navigation above the page title. | |
listScope | string | Which pages to list. Set to site to list every regular page on the site, or leave unset to list only pages within the current section. | |
sectionGroupBy | string | Group listed pages under headings. Accepts Date, ExpiryDate, Lastmod, PublishDate, or a page parameter prefixed with Param. (e.g. Param.category). Leave unset to disable grouping. | |
sectionGroupLayout | string | Date format used for group headings when sectionGroupBy is a date field. See layout strings. | |
sectionGroupOrder | string | Order of groups. Accepts asc or desc. | |
sectionSortBy | string | Sort key for listed pages within each group. Accepts Date, ExpiryDate, Lastmod, Length, LinkTitle, PublishDate, Title, Weight, or a page parameter prefixed with Param.. | |
sectionSortOrder | string | Sort order. Accepts asc or desc. | |