mirror of https://github.com/jpanther/congo.git
12 lines
20 KiB
HTML
12 lines
20 KiB
HTML
<!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 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="A powerful, lightweight theme for Hugo built with Tailwind CSS."><link rel=canonical href=https://jpanther.github.io/congo/docs/front-matter/><link type=text/css rel=stylesheet href=/congo/css/main.bundle.min.2b3764388e411aefa0e58f80c082a0dfc1cb1aa6a9bba3259cc31a856a2321d59d6bb8f7fa24fba5f4eb28c37b8fb2b3157f20cfe2c0f6c8d5fecb30e88ddf6c.css integrity="sha512-KzdkOI5BGu+g5Y+AwIKg38HLGqapu6MlnMMahWojIdWda7j3+iT7pfTrKMN7j7KzFX8gz+LA9sjV/ssw6I3fbA=="><script type=text/javascript src=/congo/js/appearance.min.12e98742cd283574d030a7fe55f29597df4ee214f7ff7075b4d19a64d046a602753c715295550be7899b661619cec89c679049d36c624681671a8013c1249896.js integrity="sha512-EumHQs0oNXTQMKf+VfKVl99O4hT3/3B1tNGaZNBGpgJ1PHFSlVUL54mbZhYZzsicZ5BJ02xiRoFnGoATwSSYlg=="></script>
|
|
<script defer type=text/javascript id=script-bundle src=/congo/js/main.bundle.min.cafcfbc73fa8e2d294dcab6a6cfeebad834a920df64733b3fb27375e701be0e4fe6d9cd3223aa364a04fd75d3cfcea69c09f0560c107e4795e256b73b67f2f71.js integrity="sha512-yvz7xz+o4tKU3KtqbP7rrYNKkg32RzOz+yc3XnAb4OT+bZzTIjqjZKBP1108/OppwJ8FYMEH5HleJWtztn8vcQ==" data-copy=Copy data-copied=Copied></script>
|
|
<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:title" content="Front Matter"><meta property="og:description" content="All the front matter variables available in Congo."><meta property="og:type" content="article"><meta property="og:url" content="https://jpanther.github.io/congo/docs/front-matter/"><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="og:site_name" content="Congo"><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":"In addition to the default Hugo front matter parameters, Congo adds a number of additional options 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":"494"}]</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="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"><div id=the-top class="absolute flex self-center"><a class="px-3 py-1 text-sm -translate-y-8 rounded-b-lg bg-primary-200 dark:bg-neutral-600 focus:translate-y-0" href=#main-content><span class="font-bold ltr:pr-2 rtl:pl-2 text-primary-600 dark:text-primary-400">↓</span>Skip to main content</a></div><header class="flex justify-between py-6 font-semibold sm:items-center sm:py-10 text-neutral-900 dark:text-neutral print:hidden"><div><a class="decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2" rel=me href=/congo/>Congo</a></div><nav><ul class="flex flex-col list-none sm:flex-row"><li class="mb-1 ltr:text-right rtl:text-left sm:mb-0 ltr:sm:mr-7 ltr:sm:last:mr-0 rtl:sm:ml-7 rtl:sm:last:ml-0"><a class="decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2" href=/congo/docs/ title=Documentation>Docs</a></li><li class="mb-1 ltr:text-right rtl:text-left sm:mb-0 ltr:sm:mr-7 ltr:sm:last:mr-0 rtl:sm:ml-7 rtl:sm:last:ml-0"><a class="decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2" href=/congo/samples/ title="Content Samples">Samples</a></li><li class="mb-1 ltr:text-right rtl:text-left sm:mb-0 ltr:sm:mr-7 ltr:sm:last:mr-0 rtl:sm:ml-7 rtl:sm:last:ml-0"><a class="decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2" href=/congo/users/ title=Users>Users</a></li><li class="mb-1 ltr:text-right rtl:text-left sm:mb-0 ltr:sm:mr-7 ltr:sm:last:mr-0 rtl:sm:ml-7 rtl:sm:last:ml-0"><a class="decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2" href=https://github.com/jpanther/congo title>GitHub</a></li><li class="ltr:text-right rtl:text-left ltr:sm:mr-7 ltr:sm:last:mr-0 rtl:sm:ml-7 rtl:sm:last:ml-0"><button id=search-button class="text-base hover:text-primary-600 dark:hover:text-primary-400" title="Search (/)">
|
|
<span class="relative inline-block align-text-bottom icon"><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></button></li></ul></nav></header><div class="relative flex flex-col grow"><main id=main-content class=grow><article><header class=max-w-prose><ol class="text-sm text-neutral-500 dark:text-neutral-400 print:hidden"><li class="inline hidden"><a class="hover:underline decoration-neutral-300 dark:underline-neutral-600" href=/congo/>Welcome to Congo! :tada:</a><span class="px-1 text-primary-500">/</span></li><li class=inline><a class="hover:underline decoration-neutral-300 dark:underline-neutral-600" href=/congo/docs/>Documentation</a><span class="px-1 text-primary-500">/</span></li><li class="inline hidden"><a class="hover:underline decoration-neutral-300 dark:underline-neutral-600" 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="mt-8 mb-12 text-base text-neutral-500 dark:text-neutral-400 print:hidden"><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.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 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="flex flex-col max-w-full mt-0 prose lg:flex-row dark:prose-invert"><div class="min-w-0 min-h-0 max-w-prose"><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><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>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>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 <a href=https://developers.google.com/search/docs/advanced/robots/robots_meta_tag#directives>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>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 <a href=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><footer class="pt-8 max-w-prose print:hidden"><div class=pt-8><hr class="border-dotted border-neutral-300 dark:border-neutral-600"><div class="flex justify-between pt-3"><span><a class="flex group" href=/congo/docs/homepage-layout/><span class="mr-3 ltr:inline rtl:hidden text-neutral-700 dark:text-neutral group-hover:text-primary-600 dark:group-hover:text-primary-400">←</span>
|
|
<span class="ml-3 ltr:hidden rtl:inline text-neutral-700 dark:text-neutral group-hover:text-primary-600 dark:group-hover:text-primary-400">→</span>
|
|
<span class="flex flex-col"><span class="mt-[0.1rem] leading-6 group-hover:underline group-hover:decoration-primary-500">Homepage Layout</span>
|
|
<span class="mt-[0.1rem] text-xs text-neutral-500 dark:text-neutral-400"></span></span></a></span><span><a class="flex text-right group" 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>
|
|
<span class="mt-[0.1rem] text-xs text-neutral-500 dark:text-neutral-400"></span></span><span class="ml-3 ltr:inline rtl:hidden text-neutral-700 dark:text-neutral group-hover:text-primary-600 dark:group-hover:text-primary-400">→</span>
|
|
<span class="mr-3 ltr:hidden rtl:inline text-neutral-700 dark:text-neutral group-hover:text-primary-600 dark:group-hover:text-primary-400">←</span></a></span></div></div></footer></article><div class="absolute top-[110vh] ltr:right-0 rtl:left-0 w-12 pointer-events-none bottom-0"><a href=#the-top class="w-12 h-12 sticky pointer-events-auto top-[calc(100vh-5.5rem)] bg-neutral/50 dark:bg-neutral-800/50 backdrop-blur rounded-full text-xl flex items-center justify-center text-neutral-700 dark:text-neutral hover:text-primary-600 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 justify-between"><div><p class="text-sm text-neutral-500 dark:text-neutral-400">© 2022 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://git.io/hugo-congo target=_blank rel="noopener noreferrer">Congo</a></p></div><div class="text-sm cursor-pointer text-neutral-700 dark:text-neutral hover:text-primary-600 dark:hover:text-primary-400 ltr:mr-14 rtl:ml-14"><button id=appearance-switcher class="w-12 h-12" type=button title="Switch to dark appearance">
|
|
<span class="inline dark:hidden"><span class="relative inline-block align-text-bottom icon"><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></span><span class="hidden dark:inline"><span class="relative inline-block align-text-bottom icon"><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></span></button></div></div></footer><div id=search-wrapper class="fixed inset-0 z-50 flex flex-col p-4 sm:p-6 md:p-[10vh] lg:p-[12vh] w-screen h-screen cursor-default bg-neutral-500/50 backdrop-blur-sm dark:bg-neutral-900/50 invisible" data-url=https://jpanther.github.io/congo/><div id=search-modal class="flex flex-col w-full max-w-3xl min-h-0 mx-auto border rounded-md shadow-lg border-neutral-200 top-20 bg-neutral dark:bg-neutral-800 dark:border-neutral-700"><header class="relative z-10 flex items-center justify-between flex-none px-2"><form class="flex items-center flex-auto min-w-0"><div class="flex items-center justify-center w-8 h-8 text-neutral-400"><span class="relative inline-block align-text-bottom icon"><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></div><input type=search id=search-query class="flex flex-auto h-12 mx-1 bg-transparent appearance-none focus:outline-dotted focus:outline-transparent focus:outline-2" placeholder=Search tabindex=0></form><button id=close-search-button class="flex items-center justify-center w-8 h-8 text-neutral-700 dark:text-neutral hover:text-primary-600 dark:hover:text-primary-400" title="Close (Esc)">
|
|
<span class="relative inline-block align-text-bottom icon"><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 px-2 overflow-auto"><ul id=search-results></ul></section></div></div></div></body></html> |