Reference - Front matter
Published:
These parameters extend standard Hugo functionality and are categorized into global site parameters and page-level front matter.
Blog Config
Article Pages
Configurations of index.md.
| Variable | Type | Description |
|---|---|---|
| layout | String | Sets the article layout. Support values: 2-col, 3-col. |
| imagePosition | String | Sets the CSS object-position for the featured image to keep the subject properly framed. Supported values are as specified in the MDN documentation. |
| breadcrumb | Bool | Controls whether hierarchical breadcrumb navigation is shown at the top of the article. |
| pageHeroStyle | String | Defines the visual style of the page hero section. Supported values: background, big, disable. |
| pageFeatureImage | String | Defines the featured image of a single page. |
| pageShowSeries | String | Controls the visibility and placement of the series taxonomy navigation. Supported values: top, bottom, both, disable. |
| pageShowNext | Bool | Controls whether a pagination link to the next chronological article is displayed. |
| pageShowRelated | Bool | Controls whether the Related Articles section is displayed at the end of the content. |
| pageShowTags | Bool | Controls whether taxonomy tags assigned to the article are displayed. |
| pageShowCategories | Bool | Controls whether taxonomy categories assigned to the article are displayed. |
| pageNoList | Bool | Exclude the page from list pages and search. |
Section Pages
Configurations of _index.md.
| Variable | Type | Description |
|---|---|---|
| sectionQuickReference | Bool | Generates a simplified index for the section to support quick content discovery. |
Docs Config
Article Pages
Configurations of index.md.
| Variable | Type | Description |
|---|---|---|
| docsIcon | String | Defines the icon for the specific entry in the documentation list. |
| docsIconClass | String | Specifies CSS classes applied to the docsIcon wrapper for custom styling. |
Section Pages
Configurations of _index.md.
| Variable | Type | Description |
|---|---|---|
| docsIcon | String | Defines the icon for the specific entry in the documentation list. |
| docsIconClass | String | Specifies CSS classes applied to the docsIcon wrapper for custom styling. |
| docsNavCollapsed | Bool | Determines whether the navigation list for the current section is collapsed by default. |