mirror of https://github.com/jpanther/congo.git
161 lines
6.2 KiB
HTML
161 lines
6.2 KiB
HTML
|
<!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.">
|
||
|
|
<link rel=canonical href=https://jpanther.github.io/Congo/docs/front-matter/>
|
||
|
|
<link type=text/css rel=stylesheet href=https://jpanther.github.io/Congo/css/main.css>
|
||
|
|
<link rel=apple-touch-icon sizes=180x180 href=https://jpanther.github.io/apple-touch-icon.png>
|
||
|
|
<link rel=icon type=image/png sizes=32x32 href=https://jpanther.github.io/favicon-32x32.png>
|
||
|
|
<link rel=icon type=image/png sizes=16x16 href=https://jpanther.github.io/favicon-16x16.png>
|
||
|
|
<link rel=manifest href=https://jpanther.github.io/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 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.">
|
||
|
|
<meta itemprop=name content="Front Matter">
|
||
|
|
<meta itemprop=description content="All the front matter variables available in Congo."><meta itemprop=datePublished content="2020-08-12T00:00:00+00:00">
|
||
|
|
<meta itemprop=dateModified content="2020-08-12T00:00:00+00:00">
|
||
|
|
<meta itemprop=wordCount content="194">
|
||
|
|
<meta itemprop=keywords content="front matter,config,docs,">
|
||
|
|
<meta name=generator content="Hugo 0.87.0">
|
||
|
|
<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-white text-grey-900 sm:px-14 md:px-24 lg:px-32 dark:bg-gray-800 dark:text-white max-w-7xl"><header class="flex justify-between py-6 font-semibold sm:py-10">
|
||
|
|
<div>
|
||
|
|
<a class=hover:underline rel=me href=https://jpanther.github.io/Congo/>Congo</a>
|
||
|
|
</div>
|
||
|
|
<nav>
|
||
|
|
<ul class="flex flex-col list-none sm:flex-row">
|
||
|
|
<li class="text-right sm:mr-7 sm:last:mr-0">
|
||
|
|
<a class=hover:underline href=/Congo/docs/ title=Documentation>Docs</a>
|
||
|
|
</li>
|
||
|
|
<li class="text-right sm:mr-7 sm:last:mr-0">
|
||
|
|
<a class=hover:underline href=/Congo/samples/ title="Content Samples">Samples</a>
|
||
|
|
</li>
|
||
|
|
<li class="text-right sm:mr-7 sm:last:mr-0">
|
||
|
|
<a class=hover:underline href=https://github.com/jpanther/Congo title>GitHub</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
</header>
|
||
|
|
<main class=flex-grow>
|
||
|
|
<article class=max-w-prose>
|
||
|
|
<header>
|
||
|
|
<h1 class="mt-0 text-4xl font-extrabold">Front Matter</h1>
|
||
|
|
<div class="mt-8 mb-12 text-base text-gray-400 dark:text-gray-500">
|
||
|
|
<span title="Reading time">
|
||
|
|
1
|
||
|
|
min
|
||
|
|
</span>
|
||
|
|
</div>
|
||
|
|
</header>
|
||
|
|
<section class="prose dark:prose-light">
|
||
|
|
<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 parameters are listed below.</p>
|
||
|
|
<p>Front matter parameter default values are inherited from the theme’s <a href=/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>Type</th>
|
||
|
|
<th>Default</th>
|
||
|
|
<th>Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<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>
|
||
|
|
</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>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>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>
|
||
|
|
<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>
|
||
|
|
<div class=pt-8>
|
||
|
|
<hr class="border-gray-300 border-dotted dark:border-gray-600">
|
||
|
|
<div class="flex justify-between pt-3">
|
||
|
|
<span>
|
||
|
|
<a class=flex href=https://jpanther.github.io/Congo/docs/homepage-layout/>
|
||
|
|
<span class=mr-3>←</span>
|
||
|
|
<span class="flex flex-col">
|
||
|
|
<span class=button__text>Homepage Layout</span>
|
||
|
|
</span>
|
||
|
|
</a>
|
||
|
|
</span>
|
||
|
|
<span>
|
||
|
|
<a class="flex text-right" href=https://jpanther.github.io/Congo/docs/shortcodes/>
|
||
|
|
<span class="flex flex-col">
|
||
|
|
<span>Shortcodes</span>
|
||
|
|
</span>
|
||
|
|
<span class=ml-3>→</span>
|
||
|
|
</a>
|
||
|
|
</span>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</footer>
|
||
|
|
</article>
|
||
|
|
</main><footer class="py-10 text-sm">
|
||
|
|
<p class="text-gray-400 dark:text-gray-500">
|
||
|
|
©
|
||
|
|
2021
|
||
|
|
Congo
|
||
|
|
</p>
|
||
|
|
<p class="text-xs text-gray-300 dark:text-gray-600">
|
||
|
|
Powered by
|
||
|
|
<a class=hover:underline href=https://gohugo.io/ target=_blank>Hugo</a>
|
||
|
|
&
|
||
|
|
<a class=hover:underline href=https://git.io/hugo-congo target=_blank>Congo</a>
|
||
|
|
</p>
|
||
|
|
</footer>
|
||
|
|
</body>
|
||
|
|
</html>
|