2021-08-16 07:33:06 +00:00
<!doctype html> < html lang = en-au > < head >
< meta charset = utf-8 >
< meta http-equiv = content-language content = "en-AU" >
< meta name = viewport content = "width=device-width,initial-scale=1" >
< meta http-equiv = x-ua-compatible content = "ie=edge" >
< title > Front Matter · Congo< / title >
< meta name = title content = "Front Matter · Congo" >
< meta name = description content = "All the front matter variables available in Congo." >
2021-08-19 02:53:58 +00:00
< link rel = canonical href = https://jpanther.github.io/congo/docs/front-matter/ >
2021-08-26 00:19:03 +00:00
< link type = text/css rel = stylesheet href = /congo/css/schemes/congo.min.b48d6ba061dc77186a2524fb8aac5ac3823b2679a9299ca60325abbccc9c1764c884715f0ba24b4e2776cb3814df4af1f4c854b87207cd5d4c7a254da9b55751.css integrity = "sha512-tI1roGHcdxhqJST7iqxaw4I7JnmpKZymAyWrvMycF2TIhHFfC6JLTid2yzgU30rx9MhUuHIHzV1MeiVNqbVXUQ==" >
2021-11-10 01:57:05 +00:00
< link type = text/css rel = stylesheet href = /congo/css/compiled/main.min.402d3b4f742c02489d0fd69ca742521356f014e6cf7cebaa4e5ae7828b6c4847676ae80103ecb4fc1ccf8c7feea273005876aaa930ac102a50d707ea771b4ec2.css integrity = "sha512-QC07T3QsAkidD9acp0JSE1bwFObPfOuqTlrngotsSEdnaugBA+y0/BzPjH/uonMAWHaqqTCsECpQ1wfqdxtOwg==" >
2021-11-04 00:06:52 +00:00
< script > function loadPreferredAppearance ( ) { localStorage . preferredAppearance === "dark" || ! ( "preferredAppearance" in localStorage ) && window . matchMedia ( "(prefers-color-scheme: dark)" ) . matches ? document . documentElement . classList . add ( "dark" ) : document . documentElement . classList . remove ( "dark" ) } function setPreferredAppearance ( a ) { a == "default" ? localStorage . removeItem ( "preferredAppearance" ) : localStorage . preferredAppearance = a , loadPreferredAppearance ( ) } loadPreferredAppearance ( ) , window . matchMedia ( "(prefers-color-scheme: dark)" ) . addListener ( loadPreferredAppearance ) < / script >
2021-08-26 00:19:03 +00:00
< link rel = apple-touch-icon sizes = 180x180 href = /congo/apple-touch-icon.png >
< link rel = icon type = image/png sizes = 32x32 href = /congo/favicon-32x32.png >
< link rel = icon type = image/png sizes = 16x16 href = /congo/favicon-16x16.png >
< link rel = manifest href = /congo/site.webmanifest >
2021-08-16 07:33:06 +00:00
< meta property = "og:title" content = "Front Matter" >
< meta property = "og:description" content = "All the front matter variables available in Congo." >
< meta property = "og:type" content = "article" >
2021-08-19 02:53:58 +00:00
< meta property = "og:url" content = "https://jpanther.github.io/congo/docs/front-matter/" > < meta property = "article:section" content = "docs" >
2021-08-16 07:33:06 +00:00
< meta property = "article:published_time" content = "2020-08-12T00:00:00+00:00" >
< meta property = "article:modified_time" content = "2020-08-12T00:00:00+00:00" >
< meta name = twitter:card content = "summary" >
< meta name = twitter:title content = "Front Matter" >
< meta name = twitter:description content = "All the front matter variables available in Congo." >
2021-11-04 00:06:52 +00:00
< script type = application/ld+json > { "@context" : "https://schema.org" , "@type" : "BlogPosting" , "articleSection" : "Documentation" , "name" : "Front Matter" , "headline" : "Front Matter" , "description" : "All the front matter variables available in Congo." , "inLanguage" : "en-AU" , "author" : { "@type" : "Person" , "name" : "Congo" } , "creator" : { "@type" : "Person" , "name" : "Congo" } , "copyrightHolder" : "Congo" , "copyrightYear" : "2020" , "dateCreated" : "2020-08-12T00:00:00\u002b00:00" , "datePublished" : "2020-08-12T00:00:00\u002b00:00" , "dateModified" : "2020-08-12T00:00:00\u002b00:00" , "url" : "https:\/\/jpanther.github.io\/congo\/docs\/front-matter\/" , "wordCount" : "409" , "keywords" : [ "front matter" , "config" , "docs" ] } < / script >
2021-11-10 01:57:05 +00:00
< meta name = generator content = "Hugo 0.89.2" >
2021-08-16 07:33:06 +00:00
< meta name = author content = "Congo" >
< link href = https://twitter.com/ rel = me >
< link href = https://facebook.com/ rel = me >
< link href = https://linkedin.com/ rel = me >
< link href = https://youtube.com/ rel = me >
< / head >
2021-09-29 00:56:46 +00:00
< body class = "flex flex-col h-screen px-6 m-auto text-lg leading-7 bg-neutral text-neutral-900 sm:px-14 md:px-24 lg:px-32 dark:bg-neutral-800 dark:text-neutral max-w-7xl" > < header class = "flex justify-between py-6 font-semibold sm:items-center sm:py-10 text-neutral-800 dark:text-neutral" >
2021-08-16 07:33:06 +00:00
< div >
2021-08-26 00:19:03 +00:00
< a class = "hover:underline hover:underline-primary-500 hover:underline-thickness-bold hover:underline-offset-small" rel = me href = /congo/ > Congo< / a >
2021-08-16 07:33:06 +00:00
< / div >
< nav >
< ul class = "flex flex-col list-none sm:flex-row" >
2021-08-22 07:24:36 +00:00
< li class = "mb-1 text-right sm:mb-0 sm:mr-7 sm:last:mr-0" >
2021-08-26 00:19:03 +00:00
< a class = "hover:underline hover:underline-primary-500 hover:underline-thickness-bold hover:underline-offset-small" href = /congo/docs/ title = Documentation > Docs< / a >
2021-08-16 07:33:06 +00:00
< / li >
2021-08-22 07:24:36 +00:00
< li class = "mb-1 text-right sm:mb-0 sm:mr-7 sm:last:mr-0" >
2021-08-26 00:19:03 +00:00
< a class = "hover:underline hover:underline-primary-500 hover:underline-thickness-bold hover:underline-offset-small" href = /congo/samples/ title = "Content Samples" > Samples< / a >
< / li >
< li class = "mb-1 text-right sm:mb-0 sm:mr-7 sm:last:mr-0" >
< a class = "hover:underline hover:underline-primary-500 hover:underline-thickness-bold hover:underline-offset-small" href = /congo/users/ title = Users > Users< / a >
2021-08-16 07:33:06 +00:00
< / li >
2021-08-22 07:24:36 +00:00
< li class = "mb-1 text-right sm:mb-0 sm:mr-7 sm:last:mr-0" >
< a class = "hover:underline hover:underline-primary-500 hover:underline-thickness-bold hover:underline-offset-small" href = https://github.com/jpanther/congo title > GitHub< / a >
2021-08-16 07:33:06 +00:00
< / li >
< / ul >
< / nav >
< / header >
< main class = flex-grow >
< article class = max-w-prose >
< header >
2021-08-22 07:24:36 +00:00
< ol class = "text-sm text-neutral-400 dark:text-neutral-500" >
2021-08-18 08:05:12 +00:00
< li class = "inline hidden" >
2021-08-26 00:19:03 +00:00
< a class = "hover:underline hover:underline-neutral-300 dark:underline-neutral-600" href = /congo/ > Welcome to Congo! :tada:< / a > < span class = "px-1 text-primary-500" > /< / span >
2021-08-18 08:05:12 +00:00
< / li >
< li class = inline >
2021-08-26 00:19:03 +00:00
< a class = "hover:underline hover:underline-neutral-300 dark:underline-neutral-600" href = /congo/docs/ > Documentation< / a > < span class = "px-1 text-primary-500" > /< / span >
2021-08-18 08:05:12 +00:00
< / li >
< li class = "inline hidden" >
2021-08-26 00:19:03 +00:00
< a class = "hover:underline hover:underline-neutral-300 dark:underline-neutral-600" href = /congo/docs/front-matter/ > Front Matter< / a > < span class = "px-1 text-primary-500" > /< / span >
2021-08-18 08:05:12 +00:00
< / li >
< / ol >
2021-08-22 07:24:36 +00:00
< h1 class = "mt-0 text-4xl font-extrabold text-neutral-800 dark:text-neutral" >
Front Matter
< / h1 >
< div class = "mt-8 mb-12 text-base text-neutral-400 dark:text-neutral-500" >
< div class = "flex flex-row items-center" >
< span title = "Reading time" > 2 mins< / span > < span class = "px-2 text-primary-500" > · < / span >
< span class = mb-[2px] >
2021-11-10 01:57:05 +00:00
< a href = https://github.com/jpanther/congo/tree/dev/exampleSite/content/docs/front-matter.md class = "text-lg hover:text-primary-500" rel = "noopener noreferrer" target = _blank title = "Edit content" >
< span class = "relative inline-block align-text-bottom icon" > < svg aria-hidden = "true" focusable = "false" data-prefix = "far" data-icon = "edit" class = "svg-inline--fa fa-edit fa-w-18" role = "img" xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 576 512" > < path fill = "currentcolor" d = "M402.3 344.9l32-32c5-5 13.7-1.5 13.7 5.7V464c0 26.5-21.5 48-48 48H48c-26.5.0-48-21.5-48-48V112c0-26.5 21.5-48 48-48h273.5c7.1.0 10.7 8.6 5.7 13.7l-32 32c-1.5 1.5-3.5 2.3-5.7 2.3H48v352h352V350.5c0-2.1.8-4.1 2.3-5.6zm156.6-201.8L296.3 405.7l-90.4 10c-26.2 2.9-48.5-19.2-45.6-45.6l10-90.4L432.9 17.1c22.9-22.9 59.9-22.9 82.7.0l43.2 43.2c22.9 22.9 22.9 60 .1 82.8zM460.1 174 402 115.9 216.2 301.8l-7.3 65.3 65.3-7.3L460.1 174zm64.8-79.7-43.2-43.2c-4.1-4.1-10.8-4.1-14.8.0L436 82l58.1 58.1 30.9-30.9c4-4.2 4-10.8-.1-14.9z" / > < / svg >
2021-08-22 07:24:36 +00:00
< / span >
< / a >
2021-08-16 07:33:06 +00:00
< / span >
< / div >
2021-08-22 07:24:36 +00:00
< / div >
2021-08-16 07:33:06 +00:00
< / header >
< section class = "prose dark:prose-light" >
2021-10-20 03:57:06 +00:00
< p > In addition to the < a href = https://gohugo.io/content-management/front-matter/#front-matter-variables > default Hugo front matter parameters< / a > , 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 >
2021-08-26 00:19:03 +00:00
< p > Front matter parameter default values are inherited from the theme’ s < a href = 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 >
2021-08-16 07:33:06 +00:00
< table >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Default< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2021-10-20 03:57:06 +00:00
< td > < code > description< / code > < / td >
2021-08-16 07:33:06 +00:00
< td > string< / td >
< td > < em > Not set< / em > < / td >
2021-10-20 03:57:06 +00:00
< td > The text description for the article. It is used in the HTML metadata.< / td >
2021-08-16 07:33:06 +00:00
< / tr >
< tr >
2021-10-20 03:57:06 +00:00
< td > < code > externalUrl< / code > < / td >
< td > string< / 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 >
2021-08-22 07:24:36 +00:00
< / tr >
< tr >
< td > < code > editURL< / code > < / td >
< td > string< / 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 > boolean< / 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 >
2021-11-04 00:06:52 +00:00
< td > < code > groupByYear< / code > < / td >
< td > boolean< / td >
< td > < code > list.groupByYear< / code > < / td >
< td > Whether or not articles are grouped by year on list pages.< / td >
< / tr >
< tr >
2021-10-20 03:57:06 +00:00
< td > < code > menu< / code > < / td >
< td > string or array< / 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 >
2021-08-26 00:19:03 +00:00
< td > < code > robots< / code > < / td >
< td > string< / 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 < a href = https://developers.google.com/search/docs/advanced/robots/robots_meta_tag#directives > Google’ s docs< / a > for valid values.< / td >
< / tr >
< tr >
2021-10-20 03:57:06 +00:00
< td > < code > sharingLinks< / code > < / td >
< td > array of strings< / 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 > boolean< / 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 > showDate< / code > < / td >
< td > boolean< / td >
< td > < code > article.showDate< / code > < / td >
< td > Whether or not article dates are displayed.< / td >
< / tr >
< tr >
< td > < code > showEdit< / code > < / td >
< td > boolean< / td >
< td > < code > article.showEdit< / code > < / td >
< td > Whether or not the link to edit the article content should be displayed.< / td >
< / tr >
< tr >
2021-08-16 07:33:06 +00:00
< td > < code > showHeadingAnchors< / code > < / td >
< td > boolean< / 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 > boolean< / 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 > showReadingTime< / code > < / td >
< td > boolean< / td >
< td > < code > article.showReadingTime< / code > < / td >
< td > Whether or not article reading times are displayed.< / td >
< / tr >
< tr >
2021-10-20 03:57:06 +00:00
< td > < code > showSummary< / code > < / td >
< td > boolean< / 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 > string< / td >
< td > < em > Auto generated using < code > summaryLength< / code > (see < a href = https://jpanther.github.io/congo/docs/configuration/#site-configuration > site configuration< / a > )< / em > < / 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 >
2021-08-16 07:33:06 +00:00
< td > < code > xml< / code > < / td >
< td > boolean< / 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 >
< / section >
< footer class = pt-8 >
2021-08-18 08:05:12 +00:00
< div class = "pt-8 article-pagination" >
2021-08-22 07:24:36 +00:00
< hr class = "border-dotted border-neutral-300 dark:border-neutral-600" >
2021-08-16 07:33:06 +00:00
< div class = "flex justify-between pt-3" >
< span >
2021-08-26 00:19:03 +00:00
< a class = flex href = /congo/docs/homepage-layout/ >
2021-08-18 08:05:12 +00:00
< span class = "mr-3 article-pagination-direction" > ← < / span >
2021-08-16 07:33:06 +00:00
< span class = "flex flex-col" >
2021-11-10 01:57:05 +00:00
< span class = "article-pagination-title mt-[0.1rem] leading-6" > Homepage Layout< / span >
< span class = "mt-[0.1rem] text-xs text-neutral-400 dark:text-neutral-500" >
2021-08-22 07:24:36 +00:00
< / span >
2021-08-16 07:33:06 +00:00
< / span >
< / a >
< / span >
< span >
2021-08-26 00:19:03 +00:00
< a class = "flex text-right" href = /congo/docs/shortcodes/ >
2021-08-16 07:33:06 +00:00
< span class = "flex flex-col" >
2021-11-10 01:57:05 +00:00
< span class = "article-pagination-title mt-[0.1rem] leading-6" > Shortcodes< / span >
< span class = "mt-[0.1rem] text-xs text-neutral-400 dark:text-neutral-500" >
2021-08-22 07:24:36 +00:00
< / span >
2021-08-16 07:33:06 +00:00
< / span >
2021-08-18 08:05:12 +00:00
< span class = "ml-3 article-pagination-direction" > → < / span >
2021-08-16 07:33:06 +00:00
< / a >
< / span >
< / div >
< / div >
< / footer >
< / article >
2021-10-20 03:57:06 +00:00
< / main > < footer class = py-10 >
2021-11-04 00:06:52 +00:00
< div class = "flex justify-between" >
< div >
2021-10-20 03:57:06 +00:00
< p class = "text-sm text-neutral-400 dark:text-neutral-500" >
2021-08-16 07:33:06 +00:00
©
2021
Congo
< / p >
2021-08-22 07:24:36 +00:00
< p class = "text-xs text-neutral-300 dark:text-neutral-600" >
2021-10-20 03:57:06 +00:00
Powered by < a class = "hover:underline hover:underline-primary-300 hover:text-primary-400" href = https://gohugo.io/ target = _blank rel = "noopener noreferrer" > Hugo< / a > & < a class = "hover:underline hover:underline-primary-300 hover:text-primary-400" href = https://git.io/hugo-congo target = _blank rel = "noopener noreferrer" > Congo< / a >
2021-08-16 07:33:06 +00:00
< / p >
2021-11-04 00:06:52 +00:00
< / div >
< / div >
2021-08-16 07:33:06 +00:00
< / footer >
< / body >
< / html >
