marcel
/
congo
mirror of https://github.com/jpanther/congo.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
congo/docs/configuration/index.html

631 lines
38 KiB
HTML
Raw Blame History

<!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>Configuration &#183; Congo</title>
<meta name=title content="Configuration &#183; 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/configuration/>
<link type=text/css rel=stylesheet href=/congo/css/main.bundle.min.7cf5f777be3c7df137ce077a4475b281ed18ce73466f3184261f987e521b5b90626d2c320d43a71885fc2fa58ee7aeb5aa0025fa6676bf05c2dc5af1545a8ec3.css integrity="sha512-fPX3d748ffE3zgd6RHWyge0YznNGbzGEJh+YflIbW5BibSwyDUOnGIX8L6WO5661qgAl+mZ2vwXC3FrxVFqOww==">
<script type=text/javascript src=/congo/js/appearance.min.dbca9e2200cf929a23b55442f2ff09361b8d5290147ff1407f89ed3839f0fea13db4e94f5ae6bf2f3de10d322b4bede74b578455e9cc7d5565314d914602c974.js integrity="sha512-28qeIgDPkpojtVRC8v8JNhuNUpAUf/FAf4ntODnw/qE9tOlPWua/Lz3hDTIrS+3nS1eEVenMfVVlMU2RRgLJdA=="></script>
<script defer type=text/javascript id=script-bundle src=/congo/js/main.bundle.min.f8481c25f066c54d3f3577b6a975c91581f15e4964a2887793f3b8957f93ff43e0c2c6fd2d2719c0bbb9712b124057f6708606a898c8f8cf1ea8229c7ba2d665.js integrity="sha512-+EgcJfBmxU0/NXe2qXXJFYHxXklkooh3k/O4lX+T/0Pgwsb9LScZwLu5cSsSQFf2cIYGqJjI+M8eqCKce6LWZQ==" 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="Configuration">
<meta property="og:description" content="All the configuration variables available in Congo.">
<meta property="og:type" content="article">
<meta property="og:url" content="https://jpanther.github.io/congo/docs/configuration/"><meta property="article:section" content="docs">
<meta property="article:published_time" content="2020-08-14T00:00:00+00:00">
<meta property="article:modified_time" content="2020-08-14T00:00:00+00:00"><meta property="og:site_name" content="Congo">
<meta name=twitter:card content="summary">
<meta name=twitter:title content="Configuration">
<meta name=twitter:description content="All the configuration variables available in Congo.">
<script type=application/ld+json>[{"@context":"https://schema.org","@type":"Article","articleSection":"Documentation","name":"Configuration","headline":"Configuration","description":"All the configuration variables available in Congo.","abstract":"Congo is a highly customisable theme and uses some of the latest Hugo features to simplify how it is configured.","inLanguage":"en-au","url":"https:\/\/jpanther.github.io\/congo\/docs\/configuration\/","author":{"@type":"Person","name":"Congo"},"copyrightYear":"2020","dateCreated":"2020-08-14T00:00:00\u002b00:00","datePublished":"2020-08-14T00:00:00\u002b00:00","dateModified":"2020-08-14T00:00:00\u002b00:00","keywords":["config","docs"],"mainEntityOfPage":"true","wordCount":"1872"}]</script>
<meta name=generator content="Hugo 0.92.1">
<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">&darr;</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">
<div>
<a class="hover:underline hover:decoration-primary-500 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="hover:underline hover:decoration-primary-500 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="hover:underline hover:decoration-primary-500 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="hover:underline hover:decoration-primary-500 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="hover:underline hover:decoration-primary-500 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>
<main id=main-content class=relative>
<article>
<header class=max-w-prose>
<ol class="text-sm text-neutral-500 dark:text-neutral-400">
<li class="inline hidden">
<a class="hover:underline hover: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 hover: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 hover:decoration-neutral-300 dark:underline-neutral-600" href=/congo/docs/configuration/>Configuration</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">
Configuration
</h1>
<div class="mt-8 mb-12 text-base text-neutral-500 dark:text-neutral-400">
<div class="flex flex-row flex-wrap items-center">
<span title="Reading time">9 mins</span><span class="px-2 text-primary-500">&#183;</span>
<span class=mb-[2px]>
<a href=https://github.com/jpanther/congo/tree/dev/exampleSite/content/docs/configuration.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>
</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="order-first px-0 lg:max-w-xs ltr:lg:pl-8 rtl:lg:pr-8 lg:order-last">
<div class="ltr:pl-5 rtl:pr-5 toc lg:sticky lg:top-10">
<details open class="mt-0 overflow-hidden rounded-lg rtl:pr-5 ltr:pl-5 ltr:-ml-5 rtl:-mr-5 lg:mt-3">
<summary class="block py-1 text-lg font-semibold cursor-pointer rtl:pr-5 ltr:pl-5 ltr:-ml-5 rtl:-mr-5 text-neutral-800 dark:text-neutral-100 lg:hidden bg-neutral-100 dark:bg-neutral-700">
Table of Contents
</summary>
<div class="py-2 border-dotted ltr:border-l rtl:border-r rtl:pr-5 ltr:pl-5 ltr:-ml-5 rtl:-mr-5 border-neutral-300 dark:border-neutral-600">
<nav id=TableOfContents>
<ul>
<li><a href=#site-configuration>Site configuration</a></li>
<li><a href=#language-and-i18n>Language and i18n</a>
<ul>
<li><a href=#configuration>Configuration</a></li>
<li><a href=#menus>Menus</a></li>
</ul>
</li>
<li><a href=#theme-parameters>Theme parameters</a></li>
</ul>
</nav>
</div>
</details>
</div>
</div>
<div class="min-w-0 min-h-0 max-w-prose">
<p>Congo is a highly customisable theme and uses some of the latest Hugo features to simplify how it is configured.</p>
<p>The theme ships with a default configuration that gets you up and running with a basic blog or static website.</p>
<blockquote>
<p>Configuration files bundled with the theme are provided in TOML format as this is the default Hugo syntax. Feel free to convert your config to YAML or JSON if you wish.</p>
</blockquote>
<p>The default theme configuration is documented in each file so you can freely adjust the settings to meet your needs.</p>
<div class="flex px-4 py-3 rounded-md bg-primary-100 dark:bg-primary-900">
<span class="ltr:pr-3 rtl:pl-3 text-primary-400">
<span class="relative inline-block align-text-bottom icon"><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="exclamation-triangle" class="svg-inline--fa fa-exclamation-triangle fa-w-18" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path fill="currentcolor" d="M569.517 440.013C587.975 472.007 564.806 512 527.94 512H48.054c-36.937.0-59.999-40.055-41.577-71.987L246.423 23.985c18.467-32.009 64.72-31.951 83.154.0l239.94 416.028zM288 354c-25.405.0-46 20.595-46 46s20.595 46 46 46 46-20.595 46-46-20.595-46-46-46zm-43.673-165.346 7.418 136c.347 6.364 5.609 11.346 11.982 11.346h48.546c6.373.0 11.635-4.982 11.982-11.346l7.418-136c.375-6.874-5.098-12.654-11.982-12.654h-63.383c-6.884.0-12.356 5.78-11.981 12.654z"/></svg>
</span>
</span>
<span class=dark:text-neutral-300>As outlined in the <a href=https://jpanther.github.io/congo/docs/installation/#set-up-theme-configuration-files>installation instructions</a>, you should adjust your theme configuration by modifying the files in the <code>config/_default/</code> folder of your Hugo project and delete the <code>config.toml</code> file in your project root.</span>
</div>
<h2 id=site-configuration class="relative group">Site configuration <span class="absolute top-0 w-6 transition-opacity opacity-0 ltr:-left-6 rtl:-right-6 not-prose group-hover:opacity-100"><a class="group-hover:text-primary-300 dark:group-hover:text-neutral-700" style=text-decoration-line:none!important href=#site-configuration aria-label=Anchor>#</a></span></h2>
<p>Standard Hugo configuration variables are respected throughout the theme, however there are some specific things that should be configured for the best experience.</p>
<p>The site configuration is managed through the <code>config/_default/config.toml</code> file. The table below outlines all the settings that the Congo takes advantage of.</p>
<p>Note that the variable names provided in this table use dot notation to simplify the TOML data structure (ie. <code>outputs.home</code> refers to <code>[outputs] home</code>).</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>theme</code></td>
<td><code>"congo"</code></td>
<td>When using Hugo Modules this config value should be removed. For all other installation types, this must be set to <code>congo</code> for the theme to function.</td>
</tr>
<tr>
<td><code>baseURL</code></td>
<td><em>Not set</em></td>
<td>The URL to the root of the website.</td>
</tr>
<tr>
<td><code>defaultContentLanguage</code></td>
<td><code>"en"</code></td>
<td>This value determines the default language of theme components and content. Refer to the <a href=#language-and-i18n>language and i18n</a> section below for supported language codes.</td>
</tr>
<tr>
<td><code>enableRobotsTXT</code></td>
<td><code>true</code></td>
<td>When enabled a <code>robots.txt</code> file will be created in the site root that allows search engines to crawl the entire site. Set to <code>false</code> if you wish to provide your own file.</td>
</tr>
<tr>
<td><code>paginate</code></td>
<td><code>10</code></td>
<td>The number of articles listed on each page of the article listing.</td>
</tr>
<tr>
<td><code>summaryLength</code></td>
<td><code>0</code></td>
<td>The number of words that are used to generate the article summary when one is not provided in the <a href=https://jpanther.github.io/congo/docs/front-matter/>front matter</a>. A value of <code>0</code> will use the first sentence. This value has no effect when summaries are hidden.</td>
</tr>
<tr>
<td><code>outputs.home</code></td>
<td><code>["HTML", "RSS", "JSON"]</code></td>
<td>The output formats that are generated for the site. Congo requires HTML, RSS and JSON for all theme components to work correctly.</td>
</tr>
<tr>
<td><code>permalinks</code></td>
<td><em>Not set</em></td>
<td>Refer to the <a href=https://gohugo.io/content-management/urls/#permalinks>Hugo docs</a> for permalink configuration.</td>
</tr>
<tr>
<td><code>taxonomies</code></td>
<td><em>Not set</em></td>
<td>Refer to the <a href=https://jpanther.github.io/congo/docs/getting-started/#organising-content>Organising content</a> section for taxonomy configuration.</td>
</tr>
</tbody>
</table>
<h2 id=language-and-i18n class="relative group">Language and i18n <span class="absolute top-0 w-6 transition-opacity opacity-0 ltr:-left-6 rtl:-right-6 not-prose group-hover:opacity-100"><a class="group-hover:text-primary-300 dark:group-hover:text-neutral-700" style=text-decoration-line:none!important href=#language-and-i18n aria-label=Anchor>#</a></span></h2>
<p>Congo is optimised for full multilingual websites and theme assets are translated into several languages out of the box. The language configuration allows you to generate multiple versions of your content to provide a customised experience to your visitors in their native language.</p>
<p>The theme currently supports the following languages by default:</p>
<table>
<thead>
<tr>
<th>Language</th>
<th>Code</th>
</tr>
</thead>
<tbody>
<tr>
<td>🇬🇧 English</td>
<td><code>en</code></td>
</tr>
<tr>
<td>🇨🇳 Chinese</td>
<td><code>zh</code></td>
</tr>
<tr>
<td>🇫🇷 French</td>
<td><code>fr</code></td>
</tr>
<tr>
<td>🇩🇪 German</td>
<td><code>de</code></td>
</tr>
<tr>
<td>🇧🇷 Portuguese (Brazil)</td>
<td><code>pt-br</code></td>
</tr>
<tr>
<td>🇪🇸 Spanish (Spain)</td>
<td><code>es</code></td>
</tr>
<tr>
<td>🇹🇷 Turkish</td>
<td><code>tr</code></td>
</tr>
</tbody>
</table>
<p>The default translations can be overridden by creating a custom file in <code>i18n/[code].yaml</code> that contains the translation strings. You can also use this method to add new languages. If you&rsquo;d like to share a new translation with the community, please <a href=https://github.com/jpanther/congo/pulls>open a pull request</a>.</p>
<h3 id=configuration class="relative group">Configuration <span class="absolute top-0 w-6 transition-opacity opacity-0 ltr:-left-6 rtl:-right-6 not-prose group-hover:opacity-100"><a class="group-hover:text-primary-300 dark:group-hover:text-neutral-700" style=text-decoration-line:none!important href=#configuration aria-label=Anchor>#</a></span></h3>
<p>In order to be as flexible as possible, a language configuration file needs to be created for each language on the website. By default Congo includes an English language configuration at <code>config/_default/languages.en.toml</code>.</p>
<p>The default file can be used as a template to create additional languages, or renamed if you wish to author your website in a language other than English. Simply name the file using the format <code>languages.[language-code].toml</code>.</p>
<div class="flex px-4 py-3 rounded-md bg-primary-100 dark:bg-primary-900">
<span class="ltr:pr-3 rtl:pl-3 text-primary-400">
<span class="relative inline-block align-text-bottom icon"><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="exclamation-triangle" class="svg-inline--fa fa-exclamation-triangle fa-w-18" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path fill="currentcolor" d="M569.517 440.013C587.975 472.007 564.806 512 527.94 512H48.054c-36.937.0-59.999-40.055-41.577-71.987L246.423 23.985c18.467-32.009 64.72-31.951 83.154.0l239.94 416.028zM288 354c-25.405.0-46 20.595-46 46s20.595 46 46 46 46-20.595 46-46-20.595-46-46-46zm-43.673-165.346 7.418 136c.347 6.364 5.609 11.346 11.982 11.346h48.546c6.373.0 11.635-4.982 11.982-11.346l7.418-136c.375-6.874-5.098-12.654-11.982-12.654h-63.383c-6.884.0-12.356 5.78-11.981 12.654z"/></svg>
</span>
</span>
<span class=dark:text-neutral-300><strong>Note:</strong> Ensure the <code>defaultContentLanguage</code> parameter in the <a href=#site-configuration>site configuration</a> matches the language code in your language config filename.</span>
</div>
<table>
<thead>
<tr>
<th>Name</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>languageCode</code></td>
<td><code>"en"</code></td>
<td>The Hugo language code for this file. It can be a top-level language (ie. <code>en</code>) or a sub-variant (ie. <code>en-au</code>) and should match the language code in the filename. Hugo expects this value to always be in lowercase. For proper HTML compliance, set the <code>isoCode</code> parameter which is case-sensitive.</td>
</tr>
<tr>
<td><code>languageName</code></td>
<td><code>"English"</code></td>
<td>The name of the language.</td>
</tr>
<tr>
<td><code>displayName</code></td>
<td><code>"EN"</code></td>
<td>The name used when the language appears on the website.</td>
</tr>
<tr>
<td><code>isoCode</code></td>
<td><code>"en"</code></td>
<td>The ISO language code for HTML metadata purposes. It can be a top-level language (ie. <code>en</code>) or a sub-variant (ie. <code>en-AU</code>).</td>
</tr>
<tr>
<td><code>weight</code></td>
<td><code>1</code></td>
<td>The weight determines the order of languages when building multilingual sites.</td>
</tr>
<tr>
<td><code>rtl</code></td>
<td><code>false</code></td>
<td>Whether or not this is a RTL language. Set to <code>true</code> to reflow content from right-to-left. Congo fully supports using RTL and LTR languages at the same time and will dynamically adjust to both.</td>
</tr>
<tr>
<td><code>dateFormat</code></td>
<td><code>"2 January 2006"</code></td>
<td>How dates are formatted in this language. Refer to the <a href=https://gohugo.io/functions/format/#gos-layout-string>Hugo docs</a> for acceptable formats.</td>
</tr>
<tr>
<td><code>title</code></td>
<td><code>"Congo"</code></td>
<td>The title of the website. This will be displayed in the site header and footer.</td>
</tr>
<tr>
<td><code>description</code></td>
<td><em>Not set</em></td>
<td>The website description. This will be used in the site metadata.</td>
</tr>
<tr>
<td><code>copyright</code></td>
<td><em>Not set</em></td>
<td>A Markdown string containing the copyright message to be displayed in the site footer. If none is provided, Congo will automatically generate a copyright string using the site <code>title</code>.</td>
</tr>
<tr>
<td><code>author.name</code></td>
<td><em>Not set</em></td>
<td>The author&rsquo;s name. This will be displayed in article footers, and on the homepage when the profile layout is used.</td>
</tr>
<tr>
<td><code>author.image</code></td>
<td><em>Not set</em></td>
<td>Path to the image file of the author. The image should be a 1:1 aspect ratio and placed in the site&rsquo;s <code>assets/</code> folder.</td>
</tr>
<tr>
<td><code>author.headline</code></td>
<td><em>Not set</em></td>
<td>A Markdown string containing the author&rsquo;s headline. It will be displayed on the profile homepage under the author&rsquo;s name.</td>
</tr>
<tr>
<td><code>author.bio</code></td>
<td><em>Not set</em></td>
<td>A Markdown string containing the author&rsquo;s bio. It will be displayed in article footers.</td>
</tr>
<tr>
<td><code>author.links</code></td>
<td><em>Not set</em></td>
<td>The links to display alongside the author&rsquo;s details. The config file contains example links which can simply be uncommented to enable. The order that the links are displayed is determined by the order they appear in the array. Custom links can be added by providing corresponding SVG icon assets in <code>assets/icons/</code>.</td>
</tr>
</tbody>
</table>
<h3 id=menus class="relative group">Menus <span class="absolute top-0 w-6 transition-opacity opacity-0 ltr:-left-6 rtl:-right-6 not-prose group-hover:opacity-100"><a class="group-hover:text-primary-300 dark:group-hover:text-neutral-700" style=text-decoration-line:none!important href=#menus aria-label=Anchor>#</a></span></h3>
<p>Congo also supports language-specific menu configurations. Menu config files follow the same naming format as the languages file. Simply provide the language code in the file name to tell Hugo which language the file relates to.</p>
<p>Menu config files are named with the format <code>menus.[language-code].toml</code>. Always ensure that the language code used in the menus configuration matches the languages configuration.</p>
<p>The <a href=https://jpanther.github.io/congo/docs/getting-started/#menus>Getting Started</a> section explains more about the structure of this file. You can also refer to the <a href=https://gohugo.io/content-management/menus/>Hugo menu docs</a> for more configuration examples.</p>
<h2 id=theme-parameters class="relative group">Theme parameters <span class="absolute top-0 w-6 transition-opacity opacity-0 ltr:-left-6 rtl:-right-6 not-prose group-hover:opacity-100"><a class="group-hover:text-primary-300 dark:group-hover:text-neutral-700" style=text-decoration-line:none!important href=#theme-parameters aria-label=Anchor>#</a></span></h2>
<p>Congo provides a large number of configuration parameters that control how the theme functions. The table below outlines every available parameter in the <code>config/_default/params.toml</code> file.</p>
<p>Many of the article defaults here can be overridden on a per article basis by specifying it in the front matter. Refer to the <a href=https://jpanther.github.io/congo/docs/front-matter/>Front Matter</a> section for further details.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>colorScheme</code></td>
<td><code>"congo"</code></td>
<td>The theme colour scheme to use. Valid values are <code>congo</code> (default), <code>avocado</code>, <code>ocean</code>, <code>fire</code> and <code>slate</code>. Refer to the <a href=https://jpanther.github.io/congo/docs/getting-started/#colour-schemes>Colour Schemes</a> section for more details.</td>
</tr>
<tr>
<td><code>defaultAppearance</code></td>
<td><code>"light"</code></td>
<td>The default theme appearance, either <code>light</code> or <code>dark</code>.</td>
</tr>
<tr>
<td><code>autoSwitchAppearance</code></td>
<td><code>true</code></td>
<td>Whether the theme appearance automatically switches based upon the visitor&rsquo;s operating system preference. Set to <code>false</code> to force the site to always use the <code>defaultAppearance</code>.</td>
</tr>
<tr>
<td><code>showAppearanceSwitcher</code></td>
<td><code>false</code></td>
<td>Whether or not to show the appearance switcher in the site footer. The browser&rsquo;s local storage is used to persist the visitor&rsquo;s preference.</td>
</tr>
<tr>
<td><code>enableSearch</code></td>
<td><code>false</code></td>
<td>Whether site search is enabled. Set to <code>true</code> to enable search functionality. Note that the search feature depends on the <code>outputs.home</code> setting in the <a href=#site-configuration>site configuration</a> being set correctly.</td>
</tr>
<tr>
<td><code>enableCodeCopy</code></td>
<td><code>false</code></td>
<td>Whether copy-to-clipboard buttons are enabled for <code>&lt;code></code> blocks.</td>
</tr>
<tr>
<td><code>logo</code></td>
<td><em>Not set</em></td>
<td>The relative path to the site logo file within the <code>assets/</code> folder. The logo file should be provided at 2x resolution and supports any image dimensions.</td>
</tr>
<tr>
<td><code>mainSections</code></td>
<td><em>Not set</em></td>
<td>The sections that should be displayed in the recent articles list. If not provided the section with the greatest number of articles is used.</td>
</tr>
<tr>
<td><code>robots</code></td>
<td><em>Not set</em></td>
<td>String that indicates how robots should handle your site. 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&rsquo;s docs</a> for valid values.</td>
</tr>
<tr>
<td><code>showScrollToTop</code></td>
<td><code>true</code></td>
<td>When set to <code>true</code> the scroll to top arrow is displayed.</td>
</tr>
<tr>
<td><code>homepage.layout</code></td>
<td><code>"page"</code></td>
<td>The layout of the homepage. Valid values are <code>page</code>, <code>profile</code> or <code>custom</code>. When set to <code>custom</code>, you must provide your own layout by creating a <code>/layouts/partials/home/custom.html</code> file. Refer to the <a href=https://jpanther.github.io/congo/docs/homepage-layout/>Homepage Layout</a> section for more details.</td>
</tr>
<tr>
<td><code>homepage.showRecent</code></td>
<td><code>false</code></td>
<td>Whether or not to display the recent articles list on the homepage.</td>
</tr>
<tr>
<td><code>article.showDate</code></td>
<td><code>true</code></td>
<td>Whether or not article dates are displayed.</td>
</tr>
<tr>
<td><code>article.showDateUpdated</code></td>
<td><code>false</code></td>
<td>Whether or not the dates articles were updated are displayed.</td>
</tr>
<tr>
<td><code>article.showAuthor</code></td>
<td><code>true</code></td>
<td>Whether or not the author box is displayed in the article footer.</td>
</tr>
<tr>
<td><code>article.showBreadcrumbs</code></td>
<td><code>false</code></td>
<td>Whether or not breadcrumbs are displayed in the article header.</td>
</tr>
<tr>
<td><code>article.showDraftLabel</code></td>
<td><code>true</code></td>
<td>Whether or not the draft indicator is shown next to articles when site is built with <code>--buildDrafts</code>.</td>
</tr>
<tr>
<td><code>article.showEdit</code></td>
<td><code>false</code></td>
<td>Whether or not the link to edit the article content should be displayed.</td>
</tr>
<tr>
<td><code>article.editURL</code></td>
<td><em>Not set</em></td>
<td>When <code>article.showEdit</code> is active, the URL for the edit link.</td>
</tr>
<tr>
<td><code>article.editAppendPath</code></td>
<td><code>true</code></td>
<td>When <code>article.showEdit</code> is active, whether or not the path to the current article should be appended to the URL set at <code>article.editURL</code>.</td>
</tr>
<tr>
<td><code>article.showHeadingAnchors</code></td>
<td><code>true</code></td>
<td>Whether or not heading anchor links are displayed alongside headings within articles.</td>
</tr>
<tr>
<td><code>article.showPagination</code></td>
<td><code>true</code></td>
<td>Whether or not the next/previous article links are displayed in the article footer.</td>
</tr>
<tr>
<td><code>article.invertPagination</code></td>
<td><code>false</code></td>
<td>Whether or not to flip the direction of the next/previous article links.</td>
</tr>
<tr>
<td><code>article.showReadingTime</code></td>
<td><code>true</code></td>
<td>Whether or not article reading times are displayed.</td>
</tr>
<tr>
<td><code>article.showTableOfContents</code></td>
<td><code>false</code></td>
<td>Whether or not the table of contents is displayed on articles.</td>
</tr>
<tr>
<td><code>article.showTaxonomies</code></td>
<td><code>false</code></td>
<td>Whether or not the taxonomies related to this article are displayed.</td>
</tr>
<tr>
<td><code>article.showWordCount</code></td>
<td><code>false</code></td>
<td>Whether or not article word counts are displayed.</td>
</tr>
<tr>
<td><code>article.sharingLinks</code></td>
<td><em>Not set</em></td>
<td>Which sharing links to display at the end of each article. When not provided, or set to <code>false</code> no links will be displayed.</td>
</tr>
<tr>
<td><code>list.showBreadcrumbs</code></td>
<td><code>false</code></td>
<td>Whether or not breadcrumbs are displayed in the header on list pages.</td>
</tr>
<tr>
<td><code>list.showTableOfContents</code></td>
<td><code>false</code></td>
<td>Whether or not the table of contents is displayed on list pages.</td>
</tr>
<tr>
<td><code>list.showSummary</code></td>
<td><code>false</code></td>
<td>Whether or not article summaries are displayed on list pages. If a summary is not provided in the <a href=https://jpanther.github.io/congo/docs/front-matter/>front matter</a>, one will be auto generated using the <code>summaryLength</code> parameter in the <a href=#site-configuration>site configuration</a>.</td>
</tr>
<tr>
<td><code>list.groupByYear</code></td>
<td><code>true</code></td>
<td>Whether or not articles are grouped by year on list pages.</td>
</tr>
<tr>
<td><code>sitemap.excludedKinds</code></td>
<td><code>["taxonomy", "term"]</code></td>
<td>Kinds of content that should be excluded from the generated <code>/sitemap.xml</code> file. Refer to the <a href=https://gohugo.io/templates/section-templates/#page-kinds>Hugo docs</a> for acceptable values.</td>
</tr>
<tr>
<td><code>taxonomy.showTermCount</code></td>
<td><code>true</code></td>
<td>Whether or not the number of articles within a taxonomy term is displayed on the taxonomy listing.</td>
</tr>
<tr>
<td><code>fathomAnalytics.site</code></td>
<td><em>Not set</em></td>
<td>The site code generated by Fathom Analytics for the website. Refer to the <a href=https://jpanther.github.io/congo/docs/partials/#analytics>Analytics docs</a> for more details.</td>
</tr>
<tr>
<td><code>fathomAnalytics.domain</code></td>
<td><em>Not set</em></td>
<td>If using a custom domain with Fathom Analytics, provide it here to serve <code>script.js</code> from the custom domain.</td>
</tr>
<tr>
<td><code>verification.google</code></td>
<td><em>Not set</em></td>
<td>The site verification string provided by Google to be included in the site metadata.</td>
</tr>
<tr>
<td><code>verification.bing</code></td>
<td><em>Not set</em></td>
<td>The site verification string provided by Bing to be included in the site metadata.</td>
</tr>
<tr>
<td><code>verification.pinterest</code></td>
<td><em>Not set</em></td>
<td>The site verification string provided by Pinterest to be included in the site metadata.</td>
</tr>
<tr>
<td><code>verification.yandex</code></td>
<td><em>Not set</em></td>
<td>The site verification string provided by Yandex to be included in the site metadata.</td>
</tr>
</tbody>
</table>
</div>
</section>
<footer class="pt-8 max-w-prose">
<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/getting-started/>
<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">&larr;</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">&rarr;</span>
<span class="flex flex-col">
<span class="mt-[0.1rem] leading-6 group-hover:underline group-hover:decoration-primary-500">Getting Started</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/homepage-layout/>
<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>
<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">&rarr;</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">&larr;</span>
</a>
</span>
</div>
</div>
</footer>
</article>
<div class="absolute top-[110vh] ltr:right-0 rtl:left-0 w-12 pointer-events-none bottom-[-5.5rem]">
<a href=#the-top class="w-12 h-12 sticky pointer-events-auto top-[calc(100vh-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">
&uarr;
</a>
</div>
</main>
<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 aria-hidden="true" focusable="false" data-prefix="fas" data-icon="times" class="svg-inline--fa fa-times fa-w-11" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 352 512"><path fill="currentcolor" d="M242.72 256l100.07-100.07c12.28-12.28 12.28-32.19.0-44.48l-22.24-22.24c-12.28-12.28-32.19-12.28-44.48.0L176 189.28 75.93 89.21c-12.28-12.28-32.19-12.28-44.48.0L9.21 111.45c-12.28 12.28-12.28 32.19.0 44.48L109.28 256 9.21 356.07c-12.28 12.28-12.28 32.19.0 44.48l22.24 22.24c12.28 12.28 32.2 12.28 44.48.0L176 322.72l100.07 100.07c12.28 12.28 32.2 12.28 44.48.0l22.24-22.24c12.28-12.28 12.28-32.19.0-44.48L242.72 256z"/></svg>
</span>
</button>
</header>
<section class="flex-auto px-2 overflow-auto">
<ul id=search-results>
</ul>
</section>
</div>
</div>
<footer class=py-10>
<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 aria-hidden="true" focusable="false" data-prefix="fas" data-icon="moon" class="svg-inline--fa fa-moon fa-w-16" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentcolor" d="M283.211 512c78.962.0 151.079-35.925 198.857-94.792 7.068-8.708-.639-21.43-11.562-19.35-124.203 23.654-238.262-71.576-238.262-196.954.0-72.222 38.662-138.635 101.498-174.394 9.686-5.512 7.25-20.197-3.756-22.23A258.156 258.156.0 00283.211.0c-141.309.0-256 114.511-256 256 0 141.309 114.511 256 256 256z"/></svg>
</span>
</span>
<span class="hidden dark:inline">
<span class="relative inline-block align-text-bottom icon"><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="sun" class="svg-inline--fa fa-sun fa-w-16" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentcolor" d="M256 160c-52.9.0-96 43.1-96 96s43.1 96 96 96 96-43.1 96-96-43.1-96-96-96zm246.4 80.5-94.7-47.3 33.5-100.4c4.5-13.6-8.4-26.5-21.9-21.9l-100.4 33.5-47.4-94.8c-6.4-12.8-24.6-12.8-31 0l-47.3 94.7L92.7 70.8c-13.6-4.5-26.5 8.4-21.9 21.9l33.5 100.4-94.7 47.4c-12.8 6.4-12.8 24.6.0 31l94.7 47.3-33.5 100.5c-4.5 13.6 8.4 26.5 21.9 21.9l100.4-33.5 47.3 94.7c6.4 12.8 24.6 12.8 31 0l47.3-94.7 100.4 33.5c13.6 4.5 26.5-8.4 21.9-21.9l-33.5-100.4 94.7-47.3c13-6.5 13-24.7.2-31.1zm-155.9 106c-49.9 49.9-131.1 49.9-181 0s-49.9-131.1.0-181 131.1-49.9 181 0 49.9 131.1.0 181z"/></svg>
</span>
</span>
</button>
</div>
</div>
</footer>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink