2023-10-30 22:52:12 +00:00
<!doctype html> < html lang = en-AU dir = ltr class = scroll-smooth data-default-appearance = light data-auto-appearance = true > < head > < meta charset = utf-8 > < meta name = viewport content = "width=device-width,initial-scale=1" > < meta name = theme-color content = "rgb(255,255,255)" > < title > Front Matter · Congo< / title >
2024-04-17 00:42:14 +00:00
< meta name = title content = "Front Matter · Congo" > < script type = text/javascript src = /congo/js/appearance.min.74ad8406faea02f3e186ba5126249aaeed9073629e04b05037b903396b188724.js integrity = "sha256-dK2EBvrqAvPhhrpRJiSaru2Qc2KeBLBQN7kDOWsYhyQ=" > < / script > < link type = text/css rel = stylesheet href = /congo/css/main.bundle.min.9602fe0216290b9ff0322c1fd14e88ab9fc0a13741f4de563f67831708d72bb2.css integrity = "sha256-lgL+AhYpC5/wMiwf0U6Iq5/AoTdB9N5WP2eDFwjXK7I=" > < script defer type = text/javascript id = script-bundle src = /congo/js/main.bundle.min.5ff2b3a0b729a3f13a3d681740c924c9009e2be09e22a8458e486651e9e1af40.js integrity = "sha256-X/KzoLcpo/E6PWgXQMkkyQCeK+CeIqhFjkhmUenhr0A=" data-copy = Copy data-copied = Copied > < / script > < meta name = description content = "
2023-10-22 23:23:53 +00:00
All the front matter variables available in Congo.
2024-04-17 00:42:14 +00:00
">< link rel = canonical href = https://jpanther.github.io/congo/docs/front-matter/ > < 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 > < meta property = "og:url" content = "https://jpanther.github.io/congo/docs/front-matter/" > < meta property = "og:site_name" content = "Congo" > < meta property = "og:title" content = "Front Matter" > < meta property = "og:description" content = "All the front matter variables available in Congo." > < meta property = "og:locale" content = "en-AU" > < meta property = "og:type" content = "article" > < meta property = "article:section" content = "docs" > < 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 property = "article:tag" content = "Front Matter" > < meta property = "article:tag" content = "Config" > < meta property = "article:tag" content = "Docs" > < 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." > < script type = application/ld+json > { "@context" : "https://schema.org" , "@type" : "Article" , "articleSection" : "Documentation" , "name" : "Front Matter" , "headline" : "Front Matter" , "description" : "All the front matter variables available in Congo." , "abstract" : "While supporting most Hugo defaults, Congo adds a number of front matter parameters to customise the presentation of individual articles." , "inLanguage" : "en-AU" , "url" : "https:\/\/jpanther.github.io\/congo\/docs\/front-matter\/" , "author" : { "@type" : "Person" , "name" : "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" , "keywords" : [ "front matter" , "config" , "docs" ] , "mainEntityOfPage" : "true" , "wordCount" : "607" } < / script > < 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 > < body class = "m-auto flex h-screen max-w-7xl flex-col bg-neutral px-6 text-lg leading-7 text-neutral-900 sm:px-14 md:px-24 lg:px-32 dark:bg-neutral-800 dark:text-neutral" > < div id = the-top class = "absolute flex self-center" > < a class = "-translate-y-8 rounded-b-lg bg-primary-200 px-3 py-1 text-sm focus:translate-y-0 dark:bg-neutral-600" href = #main-content > < span class = "pe-2 font-bold text-primary-600 dark:text-primary-400" > ↓ < / span > Skip to main content< / a > < / div > < header class = "py-6 font-semibold text-neutral-900 print:hidden sm:py-10 dark:text-neutral" > < nav class = "flex items-start justify-between sm:items-center" > < div class = "flex flex-row items-center" > < a class = "decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2" rel = me href = /congo/ > Congo< / a > < / div > < ul class = "flex list-none flex-col text-end sm:flex-row" > < li class = "group mb-1 sm:mb-0 sm:me-7 sm:last:me-0.5" > < a href = /congo/docs/ title > < span class = "decoration-primary-500 group-hover:underline group-hover:decoration-2 group-hover:underline-offset-2" > Docs< / span > < / a > < / li > < li class = "group mb-1 sm:mb-0 sm:me-7 sm:last:me-0.5" > < a href = /congo/samples/ title > < span class = "decoration-primary-500 group-hover:underline group-hover:decoration-2 group-hover:underline-offset-2" > Samples< / span > < / a > < / li > < li class = "group mb-1 sm:mb-0 sm:me-7 sm:last:me-0.5" > < a href = /congo/users/ title > < span class = "decoration-primary-500 group-hover:underline group-hover:decoration-2 group-hover:underline-offset-2" > Users< / span > < / a > < / li > < li class = "group mb-1 sm:mb-0 sm:me-7 sm:last:me-0.5" > < a href = https://github.com/jpanther/congo title target = _blank > < span class = "group-dark:hover:text-primary-400 transition-colors group-hover:text-primary-600" > < span class = "icon relative inline-block px-1 align-text-bottom" > < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 496 512" > < path fill = "currentcolor" d = "M165.9 397 . 4c0 2-2 . 3 3 .
2024-03-09 04:37:45 +00:00
< span class = "group-dark:hover:text-primary-400 transition-colors group-hover:text-primary-600" > < span class = "icon relative inline-block px-1 align-text-bottom" > < svg aria-hidden = "true" focusable = "false" data-prefix = "fas" data-icon = "search" class = "svg-inline--fa fa-search fa-w-16" role = "img" xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 512 512" > < path fill = "currentcolor" d = "M505 442.7 405.3 343c-4.5-4.5-10.6-7-17-7H372c27.6-35.3 44-79.7 44-128C416 93.1 322.9.0 208 0S0 93.1.0 208s93.1 208 208 208c48.3.0 92.7-16.4 128-44v16.3c0 6.4 2.5 12.5 7 17l99.7 99.7c9.4 9.4 24.6 9.4 33.9.0l28.3-28.3c9.4-9.4 9.4-24.6.1-34zM208 336c-70.7.0-128-57.2-128-128 0-70.7 57.2-128 128-128 70.7.0 128 57.2 128 128 0 70.7-57.2 128-128 128z" / > < / svg >
< / span > < / span > < span class = "decoration-primary-500 group-hover:underline group-hover:decoration-2 group-hover:underline-offset-2" > < / span > < / button > < / li > < li class = "group mb-1 sm:mb-0 sm:me-7 sm:last:me-0.5" > < div class = "group relative" > < button class = "group-dark:hover:text-primary-400 flex w-full items-center justify-end transition-colors group-hover:text-primary-600" >
< span class = "icon relative inline-block px-1 align-text-bottom" > < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 16 16" > < path fill = "currentcolor" d = "M4.545 6.714 4.11 8H3l1.862-5h1.284L8 8H6.833l-.435-1.286H4.545zm1.634-.736L5.5 3.956h-.049l-.679 2.022H6.18z" / > < path fill = "currentcolor" d = "M0 2a2 2 0 012-2h7a2 2 0 012 2v3h3a2 2 0 012 2v7a2 2 0 01-2 2H7a2 2 0 01-2-2v-3H2A2 2 0 010 9V2zm2-1A1 1 0 001 2v7a1 1 0 001 1h7a1 1 0 001-1V2A1 1 0 009 1H2zm7.138 9.995c.193.301.402.583.63.846-.748.575-1.673 1.001-2.768 1.292.178.217.451.635.555.867 1.125-.359 2.08-.844 2.886-1.494.777.665 1.739 1.165 2.93 1.472.133-.254.414-.673.629-.89-1.125-.253-2.057-.694-2.82-1.284.681-.747 1.222-1.651 1.621-2.757H14V8h-3v1.047h.765c-.318.844-.74 1.546-1.272 2.13a6.066 6.066.0 01-.415-.492 1.988 1.988.0 01-.94.31z" / > < / svg >
< / span > < span class = text-sm > EN< / span > < span class = text-[0.6rem] > < span class = "icon relative inline-block px-1 align-text-bottom" > < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 512 512" > < path fill = "currentcolor" d = "M233.4 406.6c12.5 12.5 32.8 12.5 45.3.0l192-192c12.5-12.5 12.5-32.8.0-45.3s-32.8-12.5-45.3.0L256 338.7 86.6 169.4c-12.5-12.5-32.8-12.5-45.3.0s-12.5 32.8.0 45.3l192 192z" / > < / svg > < / span > < / span > < / button > < div class = "invisible w-full bg-transparent group-hover:visible" > < / div > < div class = "invisible absolute z-50 flex flex-col whitespace-nowrap rounded border border-neutral-300 bg-neutral text-start text-base shadow group-hover:visible ltr:right-0 rtl:left-0 dark:border-neutral-600 dark:bg-neutral-800" > < div class = "flex flex-grow" > < a href = /congo/docs/front-matter/ class = "flex w-full items-center justify-between bg-primary-100 px-2 py-1 dark:bg-primary-900" > English (Australia)< span class = "ms-2 w-6 text-primary-600 dark:text-primary-400" > < span class = "icon relative inline-block px-1 align-text-bottom" > < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > < path fill = "currentcolor" d = "M438.6 105.4c12.5 12.5 12.5 32.7.0 45.2l-256 256c-12.5 12.5-32.7 12.5-45.2.0L9.372 278.6c-12.496-12.5-12.496-32.7.0-45.2 12.498-12.5 32.758-12.5 45.258.0L159.1 338.7 393.4 105.4c12.5-12.52 32.7-12.52 45.2.0h0z" / > < / svg > < / span > < / span > < / a > < / div > < div class = "flex flex-grow" > < a href = /congo/zh-cn/docs/front-matter/ class = "w-full py-1 pe-10 ps-2 decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2" > 简体中文< / a > < / div > < div class = "flex flex-grow" > < a href = /congo/ja/docs/front-matter/ class = "w-full py-1 pe-10 ps-2 decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2" > 日本語< / a > < / div > < / div > < / div > < / li > < / ul > < / nav > < / header > < div class = "relative flex grow flex-col" > < main id = main-content class = grow > < article > < header class = max-w-prose > < ol class = "text-sm text-neutral-500 print:hidden dark:text-neutral-400" > < li class = "hidden inline" > < a class = "dark:underline-neutral-600 decoration-neutral-300 hover:underline" href = /congo/ > Welcome to Congo! :tada:< / a > < span class = "px-1 text-primary-500" > /< / span > < / li > < li class = inline > < a class = "dark:underline-neutral-600 decoration-neutral-300 hover:underline" href = /congo/docs/ > Documentation< / a > < span class = "px-1 text-primary-500" > /< / span > < / li > < li class = "hidden inline" > < a class = "dark:underline-neutral-600 decoration-neutral-300 hover:underline" href = /congo/docs/front-matter/ > Front Matter< / a > < span class = "px-1 text-primary-500" > /< / span > < / li > < / ol > < h1 class = "mt-0 text-4xl font-extrabold text-neutral-900 dark:text-neutral" > Front Matter< / h1 > < div class = "mb-12 mt-8 text-base text-neutral-500 print:hidden dark:text-neutral-400" > < div class = "flex flex-row flex-wrap items-center" > < span title = "Reading time" > 3 mins< / span > < span class = "px-2 text-primary-500" > · < / span >
< span class = mb-[2px] > < a href = https://github.com/jpanther/congo/tree/dev/exampleSite/content/docs/front-matter/index.md class = "text-lg hover:text-primary-500" rel = "noopener noreferrer" target = _blank title = "Edit content" > < span class = "icon relative inline-block px-1 align-text-bottom" > < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 512 512" > < path fill = "currentcolor" d = "M490.3 40.4c21.9 21.87 21.9 57.33.0 79.2l-30 30.1-98-97.98 30.1-30.06C414.3-.2135 449.7-.2135 471.6 21.66L490.3 40.4zM172.4 241.7 339.7 74.34l98 97.96L270.3 339.6C264.2 345.8 256.7 350.4 248.4 353.2l-88.8 29.6C150.1 385.6 141.5 383.4 135 376.1 128.6 370.5 126.4 361 129.2 352.4l29.6-88.8C161.6 255.3 166.2 247.8 172.4 241.7v0zM192 63.1c17.7.0 32 15.23 32 32 0 18.6-14.3 32-32 32H96c-17.67.0-32 15.2-32 32V416c0 17.7 14.33 32 32 32H352c17.7.0 32-14.3 32-32V319.1c0-16.8 14.3-32 32-32s32 15.2 32 32V416c0 53-43 96-96 96H96c-53.02.0-96-43-96-96V159.1c0-53 42.98-96 96-96h96z" / > < / svg > < / span > < / a > < / span > < / div > < / div > < / header > < section class = "prose mt-0 flex max-w-full flex-col dark:prose-invert lg:flex-row" > < div class = "min-h-0 min-w-0 max-w-prose grow" > < p > In addition to the < a href = https://gohugo.io/content-management/front-matter/#front-matter-variables target = _blank rel = noreferrer > 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 > < 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 > < 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 pr
2022-03-13 23:47:01 +00:00
< span class = "flex flex-col" > < span class = "mt-[0.1rem] leading-6 group-hover:underline group-hover:decoration-primary-500" > Homepage Layout< / span >
2022-11-10 02:13:45 +00:00
< span class = "mt-[0.1rem] text-xs text-neutral-500 dark:text-neutral-400" > < / span > < / span > < / a > < / span > < span > < a class = "group flex text-right" href = /congo/docs/shortcodes/ > < span class = "flex flex-col" > < span class = "mt-[0.1rem] leading-6 group-hover:underline group-hover:decoration-primary-500" > Shortcodes< / span >
2024-01-21 22:23:05 +00:00
< span class = "mt-[0.1rem] text-xs text-neutral-500 dark:text-neutral-400" > < / span > < / span > < span class = "ms-2 text-neutral-700 transition-transform group-hover:-translate-x-[2px] group-hover:text-primary-600 dark:text-neutral dark:group-hover:text-primary-400" > < span class = "ltr:inline rtl:hidden" > → < / span > < span class = "ltr:hidden rtl:inline" > ← < / span > < / span > < / a > < / span > < / div > < / div > < / footer > < / article > < div class = "pointer-events-none absolute bottom-0 end-0 top-[100vh] w-12" > < a href = #the-top class = "pointer-events-auto sticky top-[calc(100vh-5.5rem)] flex h-12 w-12 items-center justify-center rounded-full bg-neutral/50 text-xl text-neutral-700 backdrop-blur hover:text-primary-600 dark:bg-neutral-800/50 dark:text-neutral dark:hover:text-primary-400" aria-label = "Scroll to top" title = "Scroll to top" > ↑ < / a > < / div > < / main > < footer class = "py-10 print:hidden" > < div class = "flex items-center justify-between" > < div > < p class = "text-sm text-neutral-500 dark:text-neutral-400" > © 2023 Congo contributors< / p > < p class = "text-xs text-neutral-500 dark:text-neutral-400" > Powered by < a class = "hover:underline hover:decoration-primary-400 hover:text-primary-500" href = https://gohugo.io/ target = _blank rel = "noopener noreferrer" > Hugo< / a > & < a class = "hover:underline hover:decoration-primary-400 hover:text-primary-500" href = https://github.com/jpanther/congo target = _blank rel = "noopener noreferrer" > Congo< / a > < / p > < / div > < div class = "flex flex-row items-center" > < div class = "me-14 cursor-pointer text-sm text-neutral-700 hover:text-primary-600 dark:text-neutral dark:hover:text-primary-400" > < button id = appearance-switcher-0 type = button aria-label = "appearance switcher" > < div class = "flex h-12 w-12 items-center justify-center dark:hidden" title = "Switch to dark appearance" > < span class = "icon relative inline-block px-1 align-text-bottom" > < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 512 512" > < path fill = "currentcolor" d = "M32 256C32 132.2 132.3 32 255.8 32c11.36.0 29.7 1.668 40.9 3.746 9.616 1.777 11.75 14.63 3.279 19.44C245 86.5 211.2 144.6 211.2 207.8c0 109.7 99.71 193 208.3 172.3 9.561-1.805 16.28 9.324 10.11 16.95C387.9 448.6 324.8 480 255.8 480 132.1 480 32 379.6 32 256z" / > < / svg > < / span > < / div > < div class = "hidden h-12 w-12 items-center justify-center dark:flex" title = "Switch to light appearance" > < span class = "icon relative inline-block px-1 align-text-bottom" > < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 512 512" > < path fill = "currentcolor" d = "M256 159.1c-53.02.0-95.1 42.98-95.1 95.1s41.2 96.9 95.1 96.9 95.1-42.98 95.1-95.1S309 159.1 256 159.1zM509.3 347l-63.2-91.9 63.15-91.01c6.332-9.125 1.104-21.74-9.826-23.72l-109-19.7-19.7-109c-1.975-10.93-14.59-16.16-23.72-9.824L256 65.89 164.1 2.736c-9.125-6.332-21.74-1.107-23.72 9.824L121.6 121.6 12.56 141.3C1.633 143.2-3.596 155.9 2.736 164.1L65.89 256 2.74 347.01c-6.332 9.125-1.105 21.74 9.824 23.72l109 19.7 19.7 109c1.975 10.93 14.59 16.16 23.72 9.824L256 446.1l91.01 63.15c9.127 6.334 21.75 1.107 23.72-9.822l19.7-109 109-19.7C510.4 368.8 515.6 356.1 509.3 347zM256 383.1c-70.69.0-127.1-57.31-127.1-127.1.0-70.69 57.31-127.1 127.1-127.1S383.1 186.2 383.1 256c0 70.7-56.4 127.1-127.1 127.1z" / > < / svg > < / span > < / div > < / button > < / div > < / div > < / div > < / footer > < div id = search-wrapper class = "invisible fixed inset-0 z-50 flex h-screen w-screen cursor-default flex-col bg-neutral-500/50 p-4 backdrop-blur-sm sm:p-6 md:p-[10vh] lg:p-[12vh] dark:bg-neutral-900/50" data-url = https://jpanther.github.io/congo/ > < div id = search-modal class = "top-20 mx-auto flex min-h-0 w-full max-w-3xl flex-col rounded-md border border-neutral-200 bg-neutral shadow-lg dark:border-neutral-700 dark:bg-neutral-800" > < header class = "relative z-10 flex flex-none items-center justify-between px-2" > < form class = "flex min-w-0 flex-auto items-center" > < div class = "flex h-8 w-8 items-center justify-center text-neutral-400" > < span class = "icon relative inline-block px-1 align-text-bottom" > < svg aria-hidden = "true" focusable = "false" data-prefix = "fas" data-icon = "search" class = "svg-inline--fa fa-search fa-w-16" role = "img" xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 512 512" > < path fill = "curr
< span class = "icon relative inline-block px-1 align-text-bottom" > < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 320 512" > < path fill = "currentcolor" d = "M310.6 361.4c12.5 12.5 12.5 32.75.0 45.25C304.4 412.9 296.2 416 288 416s-16.38-3.125-22.62-9.375L160 301.3 54.63 406.6C48.38 412.9 40.19 416 32 416S15.63 412.9 9.375 406.6c-12.5-12.5-12.5-32.75.0-45.25l105.4-105.4L9.375 150.6c-12.5-12.5-12.5-32.75.0-45.25s32.75-12.5 45.25.0L160 210.8l105.4-105.4c12.5-12.5 32.75-12.5 45.25.0s12.5 32.75.0 45.25l-105.4 105.4L310.6 361.4z" / > < / svg > < / span > < / button > < / header > < section class = "flex-auto overflow-auto px-2" > < ul id = search-results > < / ul > < / section > < / div > < / div > < / div > < / body > < / html >
