<!doctype html><htmllang=en-audir=ltrclass=scroll-smoothdata-default-appearance=lightdata-auto-appearance=true><head><metacharset=utf-8><metahttp-equiv=content-languagecontent="en-au"><metaname=viewportcontent="width=device-width,initial-scale=1"><metaname=theme-colorcontent="rgb(255,255,255)"><metahttp-equiv=x-ua-compatiblecontent="ie=edge"><title>Front Matter · Congo</title><metaname=titlecontent="Front Matter · Congo"><metaname=descriptioncontent="All the front matter variables available in Congo."><linkrel=canonicalhref=https://jpanther.github.io/congo/docs/front-matter/><linktype=text/cssrel=stylesheethref=/congo/css/main.bundle.min.001c0d1efdb688490593281d28088c05f329dba8795ad1d0908855388581c32d591279cc3cef35e1fa6a2d34617ac0acd30cae7cefc0823bc53648d159eb782f.cssintegrity="sha512-ABwNHv22iEkFkygdKAiMBfMp26h5WtHQkIhVOIWBwy1ZEnnMPO814fpqLTRhesCs0wyufO/AgjvFNkjRWet4Lw=="><scripttype=text/javascriptsrc=/congo/js/appearance.min.c6198a5ecbc6c7b35a8568d29315f50cf5d775d4461c515a476359767f1a745c245aa83fa96b0c7d83da976cf77481e1fc29537a2391a53ffe69a991638802e6.jsintegrity="sha512-xhmKXsvGx7NahWjSkxX1DPXXddRGHFFaR2NZdn8adFwkWqg/qWsMfYPal2z3dIHh/ClTeiORpT/+aamRY4gC5g=="></script>
, Congo adds a number of additional options to customise the presentation of individual articles. All the available theme front matter parameters are listed below.</p><p>Front matter parameter default values are inherited from the theme’s <ahref=https://jpanther.github.io/congo/docs/configuration/>base configuration</a>
, so you only need to specify these parameters in your front matter when you want to override the default.</p><table><thead><tr><th>Name</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>title</code></td><td><em>Not set</em></td><td>The name of the article.</td></tr><tr><td><code>description</code></td><td><em>Not set</em></td><td>The text description for the article. It is used in the HTML metadata.</td></tr><tr><td><code>feature</code></td><td><code>"*feature*"</code></td><td>The text pattern to match the feature image filename for this article.</td></tr><tr><td><code>featureAlt</code></td><td><code>""</code></td><td>The alternative text description for the feature image.</td></tr><tr><td><code>cover</code></td><td><code>"*cover*"</code></td><td>The text pattern to match the cover image filename for this article.</td></tr><tr><td><code>coverAlt</code></td><td><code>featureAlt</code></td><td>The alternative text description for the cover image.</td></tr><tr><td><code>coverCaption</code></td><td><em>Not set</em></td><td>The figure caption text to be displayed beneath the cover image.</td></tr><tr><td><code>thumbnail</code></td><td><code>"*thumb*"</code>_</td><td>The text pattern to match the thumbnail image filename for this article.</td></tr><tr><td><code>thumbnailAlt</code></td><td><code>featureAlt</code></td><td>The alternative text description for the thumbnail image.</td></tr><tr><td><code>externalUrl</code></td><td><em>Not set</em></td><td>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.</td></tr><tr><td><code>editURL</code></td><td><code>article.editURL</code></td><td>When <code>showEdit</code> is active, the URL for the edit link.</td></tr><tr><td><code>editAppendPath</code></td><td><code>article.editAppendPath</code></td><td>When <code>showEdit</code> is active, whether or not the path to the current article should be appended to the URL set at <code>editURL</code>.</td></tr><tr><td><code>groupByYear</code></td><td><code>list.groupByYear</code></td><td>Whether or not articles are grouped by year on list pages.</td></tr><tr><td><code>keywords</code></td><td><em>Not set</em></td><td>Any keywords that should be included in the article metadata.</td></tr><tr><td><code>menu</code></td><td><em>Not set</em></td><td>When a value is provided, a link to this article will appear in the named menus. Valid values are <code>main</code> or <code>footer</code>.</td></tr><tr><td><code>robots</code></td><td><em>Not set</em></td><td>String that indicates how robots should handle this article. If set, it will be output in the page head. Refer to <ahref=https://developers.google.com/search/docs/advanced/robots/robots_meta_tag#directivestarget=_blankrel="noreferrer noopener">Google’s docs</a>
for valid values.</td></tr><tr><td><code>sharingLinks</code></td><td><code>article.sharingLinks</code></td><td>Which sharing links to display at the end of this article. When not provided, or set to <code>false</code> no links will be displayed.</td></tr><tr><td><code>showAuthor</code></td><td><code>article.showAuthor</code></td><td>Whether or not the author box is displayed in the article footer.</td></tr><tr><td><code>showBreadcrumbs</code></td><td><code>article.showBreadcrumbs</code> or <code>list.showBreadcrumbs</code></td><td>Whether the breadcrumbs are displayed in the article or list header.</td></tr><tr><td><code>showDate</code></td><td><code>article.showDate</code></td><td>Whether or not the article date is displayed. The date is set using the <code>date</code> parameter.</td></tr><tr><td><code>showDateUpdated</code></td><td><code>article.showDateUpdated</code></td><td>Whether or not the date the article was updated is displayed. The date is set using the <code>lastmod</code> parameter.</td></tr><tr><td><code>showEdit</code></td><td><code>article.showEdit</code></td><td>Whether or not the link to edit the article content should be displayed.</td></tr><tr><td><code>showHeadingAnchors</code></td><td><code>article.showHeadingAnchors</code></td><td>Whether or not heading anchor links are displayed alongside headings within this article.</td></tr><tr><td><code>showPagination</code></td><td><code>article.showPagination</code></td><td>Whether or not the next/previous article links are displayed in the article footer.</td></tr><tr><td><code>invertPagination</code></td><td><code>article.invertPagination</code></td><td>Whether or not to flip the direction of the next/previous article links.</td></tr><tr><td><code>showReadingTime</code></td><td><code>article.showReadingTime</code></td><td>Whether or not the article reading time is displayed.</td></tr><tr><td><code>showTaxonomies</code></td><td><code>article.showTaxonomies</code></td><td>Whether or not the taxonomies that relate to this article are displayed.</td></tr><tr><td><code>showTableOfContents</code></td><td><code>article.showTableOfContents</code></td><td>Whether or not the table of contents is displayed on this article.</td></tr><tr><td><code>showWordCount</code></td><td><code>article.showWordCount</code></td><td>Whether or not the article word count is displayed.</td></tr><tr><td><code>showComments</code></td><td><code>article.showComments</code></td><td>Whether or not the <ahref=https://jpanther.github.io/congo/docs/partials/#comments>comments partial</a>
is included after the article footer.</td></tr><tr><td><code>showSummary</code></td><td><code>list.showSummary</code></td><td>Whether or not the article summary should be displayed on list pages.</td></tr><tr><td><code>summary</code></td><td>Auto generated using <code>summaryLength</code> (see <ahref=https://jpanther.github.io/congo/docs/configuration/#site-configuration>site configuration</a>
)</td><td>When <code>showSummary</code> is enabled, this is the Markdown string to be used as the summary for this article.</td></tr><tr><td><code>xml</code></td><td><code>true</code> unless excluded by <code>sitemap.excludedKinds</code></td><td>Whether or not this article is included in the generated <code>/sitemap.xml</code> file.</td></tr></tbody></table></div></section><footerclass="pt-8 max-w-prose print:hidden"><divclass=pt-8><hrclass="border-dotted border-neutral-300 dark:border-neutral-600"><divclass="flex justify-between pt-3"><span><aclass="group flex"href=/congo/docs/homepage-layout/><spanclass="mr-2 text-neutral-700 transition-transform group-hover:-translate-x-[2px] group-hover:text-primary-600 ltr:inline rtl:hidden dark:text-neutral dark:group-hover:text-primary-400">←</span>
