Skip to main content

Front Matter

<span>1494 words</span><span class="px-2 text-primary-500">&middot;</span><span title="Reading time">8 mins</span>
Documentation - This article is part of a series.
Part 7: This Article

In addition to the default Hugo front matter parameters, Blowfish adds a number of additional options to customise the presentation of individual articles. All the available theme front matter parameters are listed below.

Front matter parameter default values are inherited from the theme’s base configuration, so you only need to specify these parameters in your front matter when you want to override the default.

Name Default Description
title Not set The name of the article.
description Not set The text description for the article. It is used in the HTML metadata.
externalUrl Not set If this article is published on a third-party website, the URL to this article. Providing a URL will prevent a content page being generated and any references to this article will link directly to the third-party website.
editURL article.editURL When showEdit is active, the URL for the edit link.
editAppendPath article.editAppendPath When showEdit is active, whether or not the path to the current article should be appended to the URL set at editURL.
groupByYear list.groupByYear Whether or not articles are grouped by year on list pages.
menu Not set When a value is provided, a link to this article will appear in the named menus. Valid values are main or footer.
robots Not set String that indicates how robots should handle this article. If set, it will be output in the page head. Refer to Google’s docs for valid values.
sharingLinks article.sharingLinks Which sharing links to display at the end of this article. When not provided, or set to false no links will be displayed.
showAuthor article.showAuthor Whether or not the author box for the deafult author is displayed in the article footer.
authors Not set Array of values for authors, if set it overrides showAuthor settings for page or site. Used on the multiple authors feature, check this page for more details on how to configure that feature.
showAuthorsBadges article.showAuthorsBadges Whether the authors taxonomies are are displayed in the article or list header. This requires the setup of multiple authors and the authors taxonomy. Check this page for more details on how to configure that feature.
showHero article.showHero Whether the thumbnail image will be shown as a hero image within the article page.
heroStyle article.heroStyle Style to display the hero image, valid options are: basic, big, background, thumbAndBackground.
showBreadcrumbs article.showBreadcrumbs or list.showBreadcrumbs Whether the breadcrumbs are displayed in the article or list header.
showDate article.showDate Whether or not the article date is displayed. The date is set using the date parameter.
showDateUpdated article.showDateUpdated Whether or not the date the article was updated is displayed. The date is set using the lastmod parameter.
showEdit article.showEdit Whether or not the link to edit the article content should be displayed.
showHeadingAnchors article.showHeadingAnchors Whether or not heading anchor links are displayed alongside headings within this article.
showPagination article.showPagination Whether or not the next/previous article links are displayed in the article footer.
invertPagination article.invertPagination Whether or not to flip the direction of the next/previous article links.
showReadingTime article.showReadingTime Whether or not the article reading time is displayed.
showTaxonomies article.showTaxonomies Whether or not the taxonomies that relate to this article are displayed.
showTableOfContents article.showTableOfContents Whether or not the table of contents is displayed on this article.
showWordCount article.showWordCount Whether or not the article word count is displayed.
showComments article.showComments Whether or not the comments partial is included after the article footer.
showSummary list.showSummary Whether or not the article summary should be displayed on list pages.
showViews article.showViews Whether or not the article views should be displayed in lists and detailed view. This requires a firebase integration. Check this page for a guide on how to integrate Firebase into Blowfish
showLikes article.showLikes Whether or not the article likes should be displayed in lists and detailed view. This requires a firebase integration. Check this page for a guide on how to integrate Firebase into Blowfish
seriesOpened article.seriesOpened Whether or not the series module will be displayed open by default or not.
series Not set Array of series the article belongs to, we recommend using only one series per article.
series_order Not set Number of the article within the series.
summary Auto generated using summaryLength (see site configuration) When showSummary is enabled, this is the Markdown string to be used as the summary for this article.
xml true unless excluded by sitemap.excludedKinds Whether or not this article is included in the generated /sitemap.xml file.
layoutBackgroundBlur true Makes the background image in the background heroStyle blur with the scroll
layoutBackgroundHeaderSpace true Add space between the header and the body.
  • authors Not set : Array of values for authors, if set it overrides showAuthor settings for page or site. Used on the multiple authors feature, check this page for more details on how to configure that feature.

  • description : “place a description here my friend.”

  • editURL article.editURL : When showEdit is active, the URL for the edit link.

  • editAppendPath article.editAppendPath : When showEdit is active, whether or not the path to the current article should be appended to the URL set at editURL.

  • externalUrl : If this article is published on a third-party website, the URL to this article. Providing a URL will prevent a content page being generated and any references to this article will link directly to the third-party website. If Not set If this article is published on a third-party website, the URL to this article. Providing a URL will prevent a content page being generated and any references to this article will link directly to the third-party website.

  • groupByYear list.groupByYear : Whether or not articles are grouped by year on list pages.

  • heroStyle article.heroStyle : Style to display the hero image, valid options are: basic, big, background, thumbAndBackground.

  • invertPagination article.invertPagination : Whether or not to flip the direction of the next/previous article links.

  • layoutBackgroundBlur true : Makes the background image in the background heroStyle blur with the scroll

  • layoutBackgroundHeaderSpace true

  • menu Not set : When a value is provided, a link to this article will appear in the named menus. Valid values are main or footer

  • robots Not set : String that indicates how robots should handle this article. If set, it will be output in the page head. Refer to Google’s docs for valid values.

  • seriesOpened article.seriesOpened : Whether or not the series module will be displayed open by default or not.

  • series Not set : Array of series the article belongs to, we recommend using only one series per article.

  • series_order Not set : Number of the article within the series.

  • sharingLinks article.sharingLinks : Which sharing links to display at the end of this article. When not provided, or set to false no links will be displayed.

  • showAuthor article.showAuthor : Whether or not the author box for the deafult author is displayed in the article footer.

  • showAuthorsBadges article.showAuthorsBadges : Whether the authors taxonomies are are displayed in the article or list header. This requires the setup of multiple authors and the authors taxonomy. Check for more details on how to configure that feature

  • showBreadcrumbs article.showBreadcrumbs or list.showBreadcrumbs : Whether the breadcrumbs are displayed in the article or list header.

  • showComments article.showComments : Whether or not the comments partial is included after the article footer.

  • showDate article.showDate : Whether or not the article date is displayed. The date is set using the date parameter.

  • showDateUpdated article.showDateUpdated : Whether or not the date the article was updated is displayed. The date is set using the lastmod parameter.

  • showEdit article.showEdit : Whether or not the link to edit the article content should be displayed.

  • showHeadingAnchors article.showHeadingAnchors : Whether or not heading anchor links are displayed alongside headings within this article.

  • showHero article.showHero : Whether the thumbnail image will be shown as a hero image within the article page.

  • showPagination article.showPagination : Whether or not the next/previous article links are displayed in the article footer.

  • showLikes article.showLikes : Whether or not the article likes should be displayed in lists and detailed view. This requires a firebase integration. Check this page for a guide on how to integrate Firebase into Blowfish

  • showReadingTime article.showReadingTime : Whether or not the article reading time is displayed.

  • showSummary list.showSummary : Whether or not the article summary should be displayed on list pages.

  • showTableOfContents article.showTableOfContents : Whether or not the table of contents is displayed on this article.

  • showTaxonomies article.showTaxonomies : Whether or not the taxonomies that relate to this article are displayed.

  • showViews article.showViews : Whether or not the article views should be displayed in lists and detailed view. This requires a firebase integration. Check this page for a guide on how to integrate Firebase into Blowfish

  • showWordCount article.showWordCount : Whether or not the article word count is displayed.

  • summary : Auto generated using summaryLength (see site configuration) | When showSummary is enabled, this is the Markdown string to be used as the summary for this article.

  • title Not Set : the page title

  • xml true : unless excluded by sitemap.excludedKinds Whether or not this article is included in the generated /sitemap.xml file.

Documentation - This article is part of a series.
Part 7: This Article