mirror of https://github.com/jpanther/congo.git
3.0 KiB
3.0 KiB
title | date | draft | description | slug | tags | |||
---|---|---|---|---|---|---|---|---|
Front Matter | 2020-08-12 | false | All the front matter variables available in Congo. | front-matter |
|
In addition to the default Hugo front matter parameters, Congo 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]({{< ref "configuration" >}}), so you only need to specify these parameters in your front matter when you want to override the default.
Name | Type | Default | Description |
---|---|---|---|
description |
string | Not set | The text description for the article. It is used in the HTML metadata. |
externalUrl |
string | 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 |
string | article.editURL |
When showEdit is active, the URL for the edit link. |
editAppendPath |
boolean | article.editAppendPath |
When showEdit is active, whether or not the path to the current article should be appended to the URL set at editURL . |
menu |
string or array | 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 |
string | 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. |
showAuthor |
boolean | article.showAuthor |
Whether or not the author box is displayed in the article footer. |
showDate |
boolean | article.showDate |
Whether or not article dates are displayed. |
showEdit |
boolean | article.showEdit |
Whether or not the link to edit the article content should be displayed. |
showHeadingAnchors |
boolean | article.showHeadingAnchors |
Whether or not heading anchor links are displayed alongside headings within this article. |
showPagination |
boolean | article.showPagination |
Whether or not the next/previous article links are displayed in the article footer. |
showReadingTime |
boolean | article.showReadingTime |
Whether or not article reading times are displayed. |
showSummary |
boolean | list.showSummary |
Whether or not the article summary should be displayed on list pages. |
summary |
string | Auto generated using summaryLength (see [site configuration]({{< ref "configuration#site-configuration" >}})) |
When showSummary is enabled, this is the Markdown string to be used as the summary for this article. |
xml |
boolean | true unless excluded by sitemap.excludedKinds |
Whether or not this article is included in the generated /sitemap.xml file. |