mirror of
https://github.com/nunocoracao/blowfish.git
synced 2026-10-21 19:25:22 +00:00
1202 lines
52 KiB
HTML
1202 lines
52 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html
|
|
lang="en"
|
|
dir="ltr"
|
|
class="scroll-smooth"
|
|
data-default-appearance="dark"
|
|
data-auto-appearance="false"
|
|
><head>
|
|
<meta charset="utf-8" />
|
|
|
|
<meta http-equiv="content-language" content="en" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<meta http-equiv="X-UA-Compatible" content="ie=edge" />
|
|
|
|
<title>Configuration · Blowfish</title>
|
|
<meta name="title" content="Configuration · Blowfish" />
|
|
|
|
<meta name="description" content="Product | Nuno Coração" />
|
|
|
|
|
|
|
|
<link rel="canonical" href="https://nunocoracao.github.io/blowfish/docs/configuration/" />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link
|
|
type="text/css"
|
|
rel="stylesheet"
|
|
href="/blowfish/css/main.bundle.min.3f7a3d89b943c3dacb033ff4448c83a5b58692eb75f99e903ee759443c690298da06dc2cc7adc967ae51bb50103acfa1b65f99a428ef2ff09176f2519b277273.css"
|
|
integrity="sha512-P3o9iblDw9rLAz/0RIyDpbWGkut1+Z6QPudZRDxpApjaBtwsx63JZ65Ru1AQOs+htl+ZpCjvL/CRdvJRmydycw=="
|
|
/>
|
|
|
|
|
|
<script type="text/javascript" src="/blowfish/js/main.min.cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e.js" integrity="sha512-z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg=="></script>
|
|
|
|
|
|
<script type="text/javascript" src="/blowfish/js/appearance.min.4a00b8b8a9118d31826a03a2a9cca83390fcd3eddd9e03868fffcf4dc1e2dc15649e9266091f1225a24e1bcf6558ff4807f77663bcfaaa8f3050d73c1bd5bf0b.js" integrity="sha512-SgC4uKkRjTGCagOiqcyoM5D80+3dngOGj//PTcHi3BVknpJmCR8SJaJOG89lWP9IB/d2Y7z6qo8wUNc8G9W/Cw=="></script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script defer type="text/javascript" id="script-bundle" src="/blowfish/js/main.bundle.min.9ae0a991bb442898e9bc60cf318b4de3ff878325ff3821625a5564b32b2f66aec0e7f7d0e00ca3ac7df59d9f01c18c88b6bdd213184f86ac9ce06d7bdffbadf8.js" integrity="sha512-muCpkbtEKJjpvGDPMYtN4/+HgyX/OCFiWlVksysvZq7A5/fQ4AyjrH31nZ8BwYyItr3SExhPhqyc4G173/ut+A==" data-copy="Copy" data-copied="Copied"></script>
|
|
|
|
<script src="/js/zoom.min.js"></script>
|
|
|
|
|
|
<link rel="apple-touch-icon" sizes="180x180" href="/blowfish/apple-touch-icon.png" />
|
|
<link rel="icon" type="image/png" sizes="32x32" href="/blowfish/favicon-32x32.png" />
|
|
<link rel="icon" type="image/png" sizes="16x16" href="/blowfish/favicon-16x16.png" />
|
|
<link rel="manifest" href="/blowfish/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://nunocoracao.github.io/blowfish/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="Blowfish" />
|
|
|
|
|
|
<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.\nThe theme ships with a default configuration that gets you up and running with a basic blog or static website.",
|
|
"inLanguage": "en",
|
|
"url" : "https:\/\/nunocoracao.github.io\/blowfish\/docs\/configuration\/",
|
|
"author" : {
|
|
"@type": "Person",
|
|
"name": "Blowfish"
|
|
},
|
|
"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": "2127"
|
|
}]
|
|
</script>
|
|
|
|
|
|
|
|
<meta name="author" content="Blowfish" />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=G-XXXXXX"></script>
|
|
<script>
|
|
var doNotTrack = false;
|
|
if (!doNotTrack) {
|
|
window.dataLayer = window.dataLayer || [];
|
|
function gtag(){dataLayer.push(arguments);}
|
|
gtag('js', new Date());
|
|
gtag('config', 'G-XXXXXX', { 'anonymize_ip': false });
|
|
}
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="https://rsms.me/inter/inter.css">
|
|
</head>
|
|
<body
|
|
class="flex flex-col h-screen px-6 m-auto text-lg leading-7 max-w-7xl bg-neutral text-neutral-900 dark:bg-neutral-800 dark:text-neutral sm:px-14 md:px-24 lg:px-32"
|
|
>
|
|
<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 focus:translate-y-0 dark:bg-neutral-600"
|
|
href="#main-content"
|
|
><span class="font-bold text-primary-600 ltr:pr-2 rtl:pl-2 dark:text-primary-400"
|
|
>↓</span
|
|
>Skip to main content</a
|
|
>
|
|
</div>
|
|
|
|
|
|
<div style="padding-left:0;padding-right:0"
|
|
class="flex items-center justify-between px-4 py-6 sm:px-6 md:justify-start space-x-3">
|
|
|
|
|
|
<div>
|
|
<a href="/blowfish/" class="flex">
|
|
<span class="sr-only">Blowfish</span>
|
|
|
|
<img src="/blowfish/img/blowfish_logo_transparent.png" width="1000" height="1000"
|
|
class="max-h-[5rem] max-w-[5rem] object-scale-down object-left nozoom" alt="Blowfish" />
|
|
|
|
</a>
|
|
</div>
|
|
|
|
<div class="flex flex-1 items-center justify-between">
|
|
<nav class="flex space-x-3">
|
|
|
|
<a href="/" class="text-base font-medium text-gray-500 hover:text-gray-900">Blowfish</a>
|
|
|
|
</nav>
|
|
<div class="hidden md:flex items-center space-x-5 md:ml-12">
|
|
|
|
|
|
|
|
<a href="https://github.com/nunocoracao/blowfish" class="text-base font-medium text-gray-500 hover:text-gray-900" title="">GitHub</a>
|
|
|
|
|
|
|
|
<span></span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="flex md:hidden items-center space-x-5 md:ml-12">
|
|
|
|
<span></span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="-my-2 -mr-2 md:hidden">
|
|
|
|
<label id="menu-button" for="menu-controller" class="block">
|
|
<input type="checkbox" id="menu-controller" class="hidden" />
|
|
<div class="cursor-pointer hover:text-primary-600 dark:hover:text-primary-400">
|
|
|
|
|
|
<span class="relative inline-block align-text-bottom icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path fill="currentColor" d="M0 96C0 78.33 14.33 64 32 64H416C433.7 64 448 78.33 448 96C448 113.7 433.7 128 416 128H32C14.33 128 0 113.7 0 96zM0 256C0 238.3 14.33 224 32 224H416C433.7 224 448 238.3 448 256C448 273.7 433.7 288 416 288H32C14.33 288 0 273.7 0 256zM416 448H32C14.33 448 0 433.7 0 416C0 398.3 14.33 384 32 384H416C433.7 384 448 398.3 448 416C448 433.7 433.7 448 416 448z"/></svg>
|
|
|
|
</span>
|
|
|
|
|
|
</div>
|
|
<div id="menu-wrapper" style="padding-top:25px;"
|
|
class="fixed inset-0 z-30 invisible w-screen h-screen m-auto overflow-auto transition-opacity opacity-0 cursor-default bg-neutral-100/50 backdrop-blur-sm dark:bg-neutral-900/50">
|
|
<ul
|
|
class="flex movedown flex-col w-full px-6 py-6 mx-auto overflow-visible list-none ltr:text-right rtl:text-left max-w-7xl sm:px-14 md:px-24 lg:px-32 sm:py-10 sm:pt-10">
|
|
<li class="mb-1">
|
|
<span class="cursor-pointer hover:text-primary-600 dark:hover:text-primary-400">
|
|
|
|
<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.3L54.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>
|
|
|
|
</span>
|
|
</li>
|
|
|
|
|
|
|
|
<li class="mb-1">
|
|
<a class="decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2"
|
|
href="https://github.com/nunocoracao/blowfish" title="">GitHub</a>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</div>
|
|
</label>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div id="mobile-menu"
|
|
class="fixed inset-0 z-30 invisible w-screen h-screen m-auto overflow-auto transition-opacity opacity-0 cursor-default bg-neutral-100/50 backdrop-blur-sm dark:bg-neutral-900/50">
|
|
<ul
|
|
class="flex movedown flex-col w-full px-6 py-6 mx-auto overflow-visible list-none ltr:text-right rtl:text-left max-w-7xl sm:px-14 md:px-24 lg:px-32 sm:py-10 sm:pt-10">
|
|
<li class="mb-1">
|
|
<span class="cursor-pointer hover:text-primary-600 dark:hover:text-primary-400">
|
|
|
|
<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.3L54.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>
|
|
|
|
</span>
|
|
</li>
|
|
|
|
|
|
<li class="mb-1">
|
|
<a class="decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2"
|
|
href="https://github.com/nunocoracao/blowfish" title="">GitHub</a>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
<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="/blowfish/"
|
|
>Blowfish</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="/blowfish/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="/blowfish/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 print:hidden">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="flex flex-row flex-wrap items-center">
|
|
|
|
|
|
<span>2127 words</span><span class="px-2 text-primary-500">·</span><span title="Reading time">10 mins</span><span class="px-2 text-primary-500">·</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="mb-[2px]">
|
|
<a
|
|
href="#/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 xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentColor" d="M490.3 40.4C512.2 62.27 512.2 97.73 490.3 119.6L460.3 149.7L362.3 51.72L392.4 21.66C414.3-.2135 449.7-.2135 471.6 21.66L490.3 40.4zM172.4 241.7L339.7 74.34L437.7 172.3L270.3 339.6C264.2 345.8 256.7 350.4 248.4 353.2L159.6 382.8C150.1 385.6 141.5 383.4 135 376.1C128.6 370.5 126.4 361 129.2 352.4L158.8 263.6C161.6 255.3 166.2 247.8 172.4 241.7V241.7zM192 63.1C209.7 63.1 224 78.33 224 95.1C224 113.7 209.7 127.1 192 127.1H96C78.33 127.1 64 142.3 64 159.1V416C64 433.7 78.33 448 96 448H352C369.7 448 384 433.7 384 416V319.1C384 302.3 398.3 287.1 416 287.1C433.7 287.1 448 302.3 448 319.1V416C448 469 405 512 352 512H96C42.98 512 0 469 0 416V159.1C0 106.1 42.98 63.1 96 63.1H192z"/></svg>
|
|
|
|
</span>
|
|
|
|
</a
|
|
>
|
|
</span>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</header>
|
|
<section class="flex flex-col max-w-full mt-0 prose dark:prose-invert lg:flex-row">
|
|
|
|
<div class="order-first px-0 lg:order-last lg:max-w-xs ltr:lg:pl-8 rtl:lg:pr-8">
|
|
<div class="toc ltr:pl-5 rtl:pr-5 print:hidden lg:sticky lg:top-10">
|
|
<details open class="mt-0 overflow-hidden rounded-lg ltr:-ml-5 ltr:pl-5 rtl:-mr-5 rtl:pr-5">
|
|
<summary
|
|
class="block py-1 text-lg font-semibold cursor-pointer bg-neutral-100 text-neutral-800 ltr:-ml-5 ltr:pl-5 rtl:-mr-5 rtl:pr-5 dark:bg-neutral-700 dark:text-neutral-100 lg:hidden"
|
|
>
|
|
Table of Contents
|
|
</summary>
|
|
<div
|
|
class="py-2 border-dotted border-neutral-300 ltr:-ml-5 ltr:border-l ltr:pl-5 rtl:-mr-5 rtl:border-r rtl:pr-5 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>
|
|
<li><a href="#other-configuration-files">Other configuration files</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="text-primary-400 ltr:pr-3 rtl:pl-3">
|
|
|
|
|
|
<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="M506.3 417l-213.3-364c-16.33-28-57.54-28-73.98 0l-213.2 364C-10.59 444.9 9.849 480 42.74 480h426.6C502.1 480 522.6 445 506.3 417zM232 168c0-13.25 10.75-24 24-24S280 154.8 280 168v128c0 13.25-10.75 24-23.1 24S232 309.3 232 296V168zM256 416c-17.36 0-31.44-14.08-31.44-31.44c0-17.36 14.07-31.44 31.44-31.44s31.44 14.08 31.44 31.44C287.4 401.9 273.4 416 256 416z"/></svg>
|
|
|
|
</span>
|
|
|
|
|
|
</span>
|
|
<span class="dark:text-neutral-300">As outlined in the <a href="https://nunocoracao.github.io/blowfish/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>
|
|
<!-- prettier-ignore-start -->
|
|
<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. If you prefer to provide your own pre-made <code>robots.txt</code>, set to <code>false</code> and place your file in the <code>static</code> directory. For complete control, you may provide a <a href="https://nunocoracao.github.io/blowfish/docs/content-examples/#custom-layouts">custom layout</a> to generate this 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://nunocoracao.github.io/blowfish/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://nunocoracao.github.io/blowfish/docs/getting-started/#organising-content">Organising content</a> section for taxonomy configuration.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<!-- prettier-ignore-end -->
|
|
<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>🇧🇩 Bengali</td>
|
|
<td><code>bn</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>🇨🇳 Simplified Chinese (China)</td>
|
|
<td><code>zh-cn</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>🇹🇼 Traditional Chinese (Taiwan)</td>
|
|
<td><code>zh-tw</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>🇫🇮 Finnish</td>
|
|
<td><code>fi</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>🇮🇱 Hebrew</td>
|
|
<td><code>he</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>🇭🇺 Hungarian</td>
|
|
<td><code>hu</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>🇮🇹 Italian</td>
|
|
<td><code>it</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>🇯🇵 Japanese</td>
|
|
<td><code>ja</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>🇧🇷 Portuguese (Brazil)</td>
|
|
<td><code>pt-br</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>🇵🇹 Portuguese (Portugal)</td>
|
|
<td><code>pt-pt</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>🇷🇴 Romanian</td>
|
|
<td><code>ro</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’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="text-primary-400 ltr:pr-3 rtl:pl-3">
|
|
|
|
|
|
<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="M506.3 417l-213.3-364c-16.33-28-57.54-28-73.98 0l-213.2 364C-10.59 444.9 9.849 480 42.74 480h426.6C502.1 480 522.6 445 506.3 417zM232 168c0-13.25 10.75-24 24-24S280 154.8 280 168v128c0 13.25-10.75 24-23.1 24S232 309.3 232 296V168zM256 416c-17.36 0-31.44-14.08-31.44-31.44c0-17.36 14.07-31.44 31.44-31.44s31.44 14.08 31.44 31.44C287.4 401.9 273.4 416 256 416z"/></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>
|
|
|
|
<!-- prettier-ignore-start -->
|
|
<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’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’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’s headline. It will be displayed on the profile homepage under the author’s name.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>author.bio</code></td>
|
|
<td><em>Not set</em></td>
|
|
<td>A Markdown string containing the author’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’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>
|
|
<!-- prettier-ignore-end -->
|
|
<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://nunocoracao.github.io/blowfish/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://nunocoracao.github.io/blowfish/docs/front-matter/">Front Matter</a> section for further details.</p>
|
|
<!-- prettier-ignore-start -->
|
|
<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://nunocoracao.github.io/blowfish/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’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>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><code></code> blocks. The <code>highlight.noClasses</code> parameter must be set to <code>false</code> for code copy to function correctly. Read more about <a href="#other-configuration-files">other configuration files</a> below.</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’s docs</a> for valid values.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>header.layout</code></td>
|
|
<td><code>"basic"</code></td>
|
|
<td>The layout of the page header and menu. Valid values are <code>basic</code>, <code>hamburger</code> or <code>custom</code>. When set to <code>custom</code>, you must provide your own layout by creating a <code>/layouts/partials/header/custom.html</code> file.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>footer.showCopyright</code></td>
|
|
<td><code>true</code></td>
|
|
<td>Whether or not to show the copyright string in the site footer. Note that the string itself can be customised using the <code>copyright</code> parameter in the <a href="#language-and-i18n">languages configuration</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>footer.showThemeAttribution</code></td>
|
|
<td><code>true</code></td>
|
|
<td>Whether or not to show the “powered by” theme attribution in the site footer. If you choose to disable this message, please consider attributing the theme somewhere else on your site (for example, on your about page).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>footer.showAppearanceSwitcher</code></td>
|
|
<td><code>false</code></td>
|
|
<td>Whether or not to show the appearance switcher in the site footer. The browser’s local storage is used to persist the visitor’s preference.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>footer.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://nunocoracao.github.io/blowfish/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.showComments</code></td>
|
|
<td><code>false</code></td>
|
|
<td>Whether or not the <a href="https://nunocoracao.github.io/blowfish/docs/partials/#comments">comments partial</a> is included after the article footer.</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://nunocoracao.github.io/blowfish/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://nunocoracao.github.io/blowfish/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>
|
|
<!-- prettier-ignore-end -->
|
|
<h2 id="other-configuration-files" class="relative group">Other configuration files <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="#other-configuration-files" aria-label="Anchor">#</a></span></h2>
|
|
<p>The theme also includes a <code>markup.toml</code> configuration file. This file contains some important parameters that ensure that Hugo is correctly configured to generate sites built with Congo.</p>
|
|
<p>Always ensure this file is present in the config directory and that the required values are set. Failure to do so may cause certain features to fucntion incorrectly and could result in unintended behaviour.</p>
|
|
|
|
</div>
|
|
</section>
|
|
<footer class="pt-8 max-w-prose print:hidden">
|
|
|
|
|
|
|
|
|
|
<section class="flex flex-row flex-wrap justify-center pt-4 text-xl">
|
|
|
|
|
|
<a
|
|
class="m-1 inline-block min-w-[2.4rem] rounded bg-neutral-300 p-1 text-center text-neutral-700 hover:bg-primary-500 hover:text-neutral dark:bg-neutral-700 dark:text-neutral-300 dark:hover:bg-primary-400 dark:hover:text-neutral-800"
|
|
href="https://www.linkedin.com/shareArticle?mini=true&url=https://nunocoracao.github.io/blowfish/docs/configuration/&title=Configuration"
|
|
title="Share on LinkedIn"
|
|
aria-label="Share on LinkedIn"
|
|
>
|
|
|
|
<span class="relative inline-block align-text-bottom icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path fill="currentColor" d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3zM135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5zm282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9V416z"/></svg>
|
|
|
|
</span>
|
|
|
|
</a
|
|
>
|
|
|
|
|
|
|
|
<a
|
|
class="m-1 inline-block min-w-[2.4rem] rounded bg-neutral-300 p-1 text-center text-neutral-700 hover:bg-primary-500 hover:text-neutral dark:bg-neutral-700 dark:text-neutral-300 dark:hover:bg-primary-400 dark:hover:text-neutral-800"
|
|
href="https://twitter.com/intent/tweet/?url=https://nunocoracao.github.io/blowfish/docs/configuration/&text=Configuration"
|
|
title="Tweet on Twitter"
|
|
aria-label="Tweet on Twitter"
|
|
>
|
|
|
|
<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="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg>
|
|
|
|
</span>
|
|
|
|
</a
|
|
>
|
|
|
|
|
|
|
|
|
|
|
|
<a
|
|
class="m-1 inline-block min-w-[2.4rem] rounded bg-neutral-300 p-1 text-center text-neutral-700 hover:bg-primary-500 hover:text-neutral dark:bg-neutral-700 dark:text-neutral-300 dark:hover:bg-primary-400 dark:hover:text-neutral-800"
|
|
href="https://pinterest.com/pin/create/bookmarklet/?url=https://nunocoracao.github.io/blowfish/docs/configuration/&description=Configuration"
|
|
title="Pin on Pinterest"
|
|
aria-label="Pin on Pinterest"
|
|
>
|
|
|
|
<span class="relative inline-block align-text-bottom icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path fill="currentColor" d="M496 256c0 137-111 248-248 248-25.6 0-50.2-3.9-73.4-11.1 10.1-16.5 25.2-43.5 30.8-65 3-11.6 15.4-59 15.4-59 8.1 15.4 31.7 28.5 56.8 28.5 74.8 0 128.7-68.8 128.7-154.3 0-81.9-66.9-143.2-152.9-143.2-107 0-163.9 71.8-163.9 150.1 0 36.4 19.4 81.7 50.3 96.1 4.7 2.2 7.2 1.2 8.3-3.3.8-3.4 5-20.3 6.9-28.1.6-2.5.3-4.7-1.7-7.1-10.1-12.5-18.3-35.3-18.3-56.6 0-54.7 41.4-107.6 112-107.6 60.9 0 103.6 41.5 103.6 100.9 0 67.1-33.9 113.6-78 113.6-24.3 0-42.6-20.1-36.7-44.8 7-29.5 20.5-61.3 20.5-82.6 0-19-10.2-34.9-31.4-34.9-24.9 0-44.9 25.7-44.9 60.2 0 22 7.4 36.8 7.4 36.8s-24.5 103.8-29 123.2c-5 21.4-3 51.6-.9 71.2C65.4 450.9 0 361.1 0 256 0 119 111 8 248 8s248 111 248 248z"/></svg>
|
|
|
|
</span>
|
|
|
|
</a
|
|
>
|
|
|
|
|
|
|
|
<a
|
|
class="m-1 inline-block min-w-[2.4rem] rounded bg-neutral-300 p-1 text-center text-neutral-700 hover:bg-primary-500 hover:text-neutral dark:bg-neutral-700 dark:text-neutral-300 dark:hover:bg-primary-400 dark:hover:text-neutral-800"
|
|
href="https://reddit.com/submit/?url=https://nunocoracao.github.io/blowfish/docs/configuration/&resubmit=true&title=Configuration"
|
|
title="Submit to Reddit"
|
|
aria-label="Submit to Reddit"
|
|
>
|
|
|
|
<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="M201.5 305.5c-13.8 0-24.9-11.1-24.9-24.6 0-13.8 11.1-24.9 24.9-24.9 13.6 0 24.6 11.1 24.6 24.9 0 13.6-11.1 24.6-24.6 24.6zM504 256c0 137-111 248-248 248S8 393 8 256 119 8 256 8s248 111 248 248zm-132.3-41.2c-9.4 0-17.7 3.9-23.8 10-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3 55.4 12.5c0 13.6 11.1 24.6 24.6 24.6 13.8 0 24.9-11.3 24.9-24.9s-11.1-24.9-24.9-24.9c-9.7 0-18 5.8-22.1 13.8l-61.2-13.6c-3-.8-6.1 1.4-6.9 4.4l-19.1 86.4c-33.2 1.4-63.1 11.3-85.5 26.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9 0-46.3 46.9-14.4 62.8-1.1 5-1.7 10.2-1.7 15.5 0 52.6 59.2 95.2 132 95.2 73.1 0 132.3-42.6 132.3-95.2 0-5.3-.6-10.8-1.9-15.8 31.3-16 19.8-62.5-14.9-62.5zM302.8 331c-18.2 18.2-76.1 17.9-93.6 0-2.2-2.2-6.1-2.2-8.3 0-2.5 2.5-2.5 6.4 0 8.6 22.8 22.8 87.3 22.8 110.2 0 2.5-2.2 2.5-6.1 0-8.6-2.2-2.2-6.1-2.2-8.3 0zm7.7-75c-13.6 0-24.6 11.1-24.6 24.9 0 13.6 11.1 24.6 24.6 24.6 13.8 0 24.9-11.1 24.9-24.6 0-13.8-11-24.9-24.9-24.9z"/></svg>
|
|
|
|
</span>
|
|
|
|
</a
|
|
>
|
|
|
|
|
|
|
|
<a
|
|
class="m-1 inline-block min-w-[2.4rem] rounded bg-neutral-300 p-1 text-center text-neutral-700 hover:bg-primary-500 hover:text-neutral dark:bg-neutral-700 dark:text-neutral-300 dark:hover:bg-primary-400 dark:hover:text-neutral-800"
|
|
href="https://www.facebook.com/sharer/sharer.php?u=https://nunocoracao.github.io/blowfish/docs/configuration/&quote=Configuration"
|
|
title="Share on Facebook"
|
|
aria-label="Share on Facebook"
|
|
>
|
|
|
|
<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="M504 256C504 119 393 8 256 8S8 119 8 256c0 123.78 90.69 226.38 209.25 245V327.69h-63V256h63v-54.64c0-62.15 37-96.48 93.67-96.48 27.14 0 55.52 4.84 55.52 4.84v61h-31.28c-30.8 0-40.41 19.12-40.41 38.73V256h68.78l-11 71.69h-57.78V501C413.31 482.38 504 379.78 504 256z"/></svg>
|
|
|
|
</span>
|
|
|
|
</a
|
|
>
|
|
|
|
|
|
|
|
<a
|
|
class="m-1 inline-block min-w-[2.4rem] rounded bg-neutral-300 p-1 text-center text-neutral-700 hover:bg-primary-500 hover:text-neutral dark:bg-neutral-700 dark:text-neutral-300 dark:hover:bg-primary-400 dark:hover:text-neutral-800"
|
|
href="mailto:?body=https://nunocoracao.github.io/blowfish/docs/configuration/&subject=Configuration"
|
|
title="Send via email"
|
|
aria-label="Send via email"
|
|
>
|
|
|
|
<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="M207.8 20.73c-93.45 18.32-168.7 93.66-187 187.1c-27.64 140.9 68.65 266.2 199.1 285.1c19.01 2.888 36.17-12.26 36.17-31.49l.0001-.6631c0-15.74-11.44-28.88-26.84-31.24c-84.35-12.98-149.2-86.13-149.2-174.2c0-102.9 88.61-185.5 193.4-175.4c91.54 8.869 158.6 91.25 158.6 183.2l0 16.16c0 22.09-17.94 40.05-40 40.05s-40.01-17.96-40.01-40.05v-120.1c0-8.847-7.161-16.02-16.01-16.02l-31.98 .0036c-7.299 0-13.2 4.992-15.12 11.68c-24.85-12.15-54.24-16.38-86.06-5.106c-38.75 13.73-68.12 48.91-73.72 89.64c-9.483 69.01 43.81 128 110.9 128c26.44 0 50.43-9.544 69.59-24.88c24 31.3 65.23 48.69 109.4 37.49C465.2 369.3 496 324.1 495.1 277.2V256.3C495.1 107.1 361.2-9.332 207.8 20.73zM239.1 304.3c-26.47 0-48-21.56-48-48.05s21.53-48.05 48-48.05s48 21.56 48 48.05S266.5 304.3 239.1 304.3z"/></svg>
|
|
|
|
</span>
|
|
|
|
</a
|
|
>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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="/blowfish/docs/getting-started/">
|
|
<span
|
|
class="mr-3 text-neutral-700 group-hover:text-primary-600 ltr:inline rtl:hidden dark:text-neutral dark:group-hover:text-primary-400"
|
|
>←</span
|
|
>
|
|
<span
|
|
class="ml-3 text-neutral-700 group-hover:text-primary-600 ltr:hidden rtl:inline dark:text-neutral 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"
|
|
>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="/blowfish/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 text-neutral-700 group-hover:text-primary-600 ltr:inline rtl:hidden dark:text-neutral dark:group-hover:text-primary-400"
|
|
>→</span
|
|
>
|
|
<span
|
|
class="mr-3 text-neutral-700 group-hover:text-primary-600 ltr:hidden rtl:inline dark:text-neutral dark:group-hover:text-primary-400"
|
|
>←</span
|
|
>
|
|
</a>
|
|
|
|
</span>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</footer>
|
|
</article>
|
|
|
|
|
|
<div
|
|
class="pointer-events-none absolute top-[100vh] bottom-0 w-12 ltr:right-0 rtl:left-0"
|
|
>
|
|
<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">
|
|
|
|
|
|
<nav class="pb-4 text-base font-medium text-neutral-500 dark:text-neutral-400">
|
|
<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="/blowfish/tags/"
|
|
title="Tags"
|
|
>Tags</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="/blowfish/categories/"
|
|
title="Categories"
|
|
>Categories</a
|
|
>
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
<div class="flex items-center justify-between">
|
|
|
|
|
|
|
|
<p class="text-sm text-neutral-500 dark:text-neutral-400">
|
|
©
|
|
2022
|
|
Blowfish
|
|
</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/nunocoracao/blowfish" target="_blank" rel="noopener noreferrer">Blowfish</a>
|
|
</p>
|
|
|
|
|
|
</div>
|
|
<script>
|
|
mediumZoom(document.querySelectorAll("img:not(.nozoom)"), {
|
|
margin: 24,
|
|
background: 'rgba(0,0,0,0.5)',
|
|
scrollOffset: 0,
|
|
})
|
|
</script>
|
|
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|