"><linkrel=canonicalhref=https://jpanther.github.io/congo/docs/configuration/><linkrel=apple-touch-iconsizes=180x180href=/congo/apple-touch-icon.png><linkrel=icontype=image/pngsizes=32x32href=/congo/favicon-32x32.png><linkrel=icontype=image/pngsizes=16x16href=/congo/favicon-16x16.png><linkrel=manifesthref=/congo/site.webmanifest><metaproperty="og:title"content="Configuration"><metaproperty="og:description"content="All the configuration variables available in Congo."><metaproperty="og:type"content="article"><metaproperty="og:url"content="https://jpanther.github.io/congo/docs/configuration/"><metaproperty="article:section"content="docs"><metaproperty="article:published_time"content="2020-08-14T00:00:00+00:00"><metaproperty="article:modified_time"content="2020-08-14T00:00:00+00:00"><metaname=twitter:cardcontent="summary"><metaname=twitter:titlecontent="Configuration"><metaname=twitter:descriptioncontent="All the configuration variables available in Congo."><scripttype=application/ld+json>{"@context":"https://schema.org","@type":"Article","articleSection":"Documentation","name":"Configuration","headline":"Configuration","description":"All the configuration variables available in Congo.","abstract":"Discover all the site, language and theme configurations that are available in Congo and how they can be used to customise your project.","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":"2344"}</script><metaname=authorcontent="Congo"><linkhref=https://twitter.com/rel=me><linkhref=https://facebook.com/rel=me><linkhref=https://linkedin.com/rel=me><linkhref=https://youtube.com/rel=me></head><bodyclass="m-auto flex h-screen max-w-7xl flex-col bg-neutral px-6 text-lg leading-7 text-neutral-900 sm:px-14 md:px-24 lg:px-32 dark:bg-neutral-800 dark:text-neutral"><divid=the-topclass="absolute flex self-center"><aclass="-translate-y-8 rounded-b-lg bg-primary-200 px-3 py-1 text-sm focus:translate-y-0 dark:bg-neutral-600"href=#main-content><spanclass="pe-2 font-bold text-primary-600 dark:text-primary-400">↓</span>Skip to main content</a></div><headerclass="py-6 font-semibold text-neutral-900 print:hidden sm:py-10 dark:text-neutral"><navclass="flex items-start justify-between sm:items-center"><divclass="flex flex-row items-center"><aclass="decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2"rel=mehref=/congo/>Congo</a></div><ulclass="flex list-none flex-col text-end sm:flex-row"><liclass="group mb-1 sm:mb-0 sm:me-7 sm:last:me-0.5"><ahref=/congo/docs/title><spanclass="decoration-primary-500 group-hover:underline group-hover:decoration-2 group-hover:underline-offset-2">Docs</span></a></li><liclass="group mb-1 sm:mb-0 sm:me-7 sm:last:me-0.5"><ahref=/congo/samples/title><spanclass="decoration-primary-500 group-hover:underline group-hover:decoration-2 group-hover:underline-offset-2">Samples</span></a></li><liclass="group mb-1 sm:mb-0 sm:me-7 sm:last:me-0.5"><ahref=/congo/users/title><spanclass="decoration-primary-500 group-hover:underline group-hover:decoration-2 group-hover:underline-offset-2">Users</span></a></li><liclass="group mb-1 sm:mb-0 sm:me-7 sm:last:me-0.5"><ahref=https://github.com/jpanther/congotitletarget=_blank><spanclass="group-dark:hover:text-primary-400 transition-colors group-hover:text-primary-600"><spanclass="icon relative inline-block px-1 align-text-bottom"><svgxmlns="http://www.w3.org/2000/svg"viewBox="0 0 496 512"><pathfill="currentcolor"d="M165.9397.4c02-2.33.6-5.23.6-3.3.3-5.6-1.3-5.6-3.6.0-22.3-3.65.2-3.63-.35.61.35.63.6zm-31.1-4.5c-.721.34.34.34.92.615.6.06.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.22.3zm44.2-1.7c-2.9.7-4.92.6-4.64.9.322.93.35.92.62.9-.74.9-2.64.6-4
<spanclass=mb-[2px]><ahref=https://github.com/jpanther/congo/tree/dev/exampleSite/content/docs/configuration/index.mdclass="text-lg hover:text-primary-500"rel="noopener noreferrer"target=_blanktitle="Edit content"><spanclass="icon relative inline-block px-1 align-text-bottom"><svgxmlns="http://www.w3.org/2000/svg"viewBox="0 0 512 512"><pathfill="currentcolor"d="M490.3 40.4c21.9 21.87 21.9 57.33.0 79.2l-30 30.1-98-97.98 30.1-30.06C414.3-.2135 449.7-.2135 471.6 21.66L490.3 40.4zM172.4 241.7 339.7 74.34l98 97.96L270.3 339.6C264.2 345.8 256.7 350.4 248.4 353.2l-88.8 29.6C150.1 385.6 141.5 383.4 135 376.1 128.6 370.5 126.4 361 129.2 352.4l29.6-88.8C161.6 255.3 166.2 247.8 172.4 241.7v0zM192 63.1c17.7.0 32 15.23 32 32 0 18.6-14.3 32-32 32H96c-17.67.0-32 15.2-32 32V416c0 17.7 14.33 32 32 32H352c17.7.0 32-14.3 32-32V319.1c0-16.8 14.3-32 32-32s32 15.2 32 32V416c0 53-43 96-96 96H96c-53.02.0-96-43-96-96V159.1c0-53 42.98-96 96-96h96z"/></svg></span></a></span></div></div></header><sectionclass="prose mt-0 flex max-w-full flex-col dark:prose-invert lg:flex-row"><divclass="order-first px-0 lg:order-last lg:max-w-xs lg:ps-8"><divclass="toc pe-5 print:hidden lg:sticky lg:top-10"><detailsopenclass="-ms-5 mt-0 overflow-hidden rounded-lg ps-5"><summaryclass="block cursor-pointer bg-neutral-100 py-1 ps-5 text-lg font-semibold text-neutral-800 dark:bg-neutral-700 dark:text-neutral-100 lg:hidden">Table of Contents</summary><divclass="border-s border-dotted border-neutral-300 py-2 ps-5 dark:border-neutral-600"><navid=TableOfContents><ul><li><ahref=#site-configuration>Site configuration</a></li><li><ahref=#language-and-i18n>Language and i18n</a><ul><li><ahref=#configuration>Configuration</a></li><li><ahref=#menus>Menus</a></li></ul></li><li><ahref=#theme-parameters>Theme parameters</a></li><li><ahref=#other-configuration-files>Other configuration files</a></li></ul></nav></div></details></div></div><divclass="min-h-0 min-w-0 max-w-prose grow"><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><divclass="flex rounded-md bg-primary-100 px-4 py-3 dark:bg-primary-900"><spanclass="pe-3 text-primary-400"><spanclass="icon relative inline-block px-1 align-text-bottom"><svgxmlns="http://www.w3.org/2000/svg"viewBox="0 0 512 512"><pathfill="currentcolor"d="M506.3 417 293 53c-16.33-28-57.54-28-73.98.0l-213.2 364C-10.59 444.9 9.849 480 42.74 480h426.6c32.76.0 53.26-35 36.96-63zM232 168c0-13.25 10.75-24 24-24s24 10.8 24 24v128c0 13.25-10.75 24-23.1 24S232 309.3 232 296V168zm24 248c-17.36.0-31.44-14.08-31.44-31.44s14.07-31.44 31.44-31.44 31.44 14.08 31.44 31.44C287.4 401.9 273.4 416 256 416z"/></svg>
</span></span><spanclass=dark:text-neutral-300>As outlined in the <ahref=https://jpanther.github.io/congo/docs/installation/#set-up-theme-configuration-filestarget=_blankrel=noreferrer>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><h2id=site-configurationclass="relative group">Site configuration <spanclass="absolute top-0 w-6 transition-opacity opacity-0 -start-6 not-prose group-hover:opacity-100"><aclass="group-hover:text-primary-300 dark:group-hover:text-neutral-700"style=text-decoration-line:none!importanthref=#site-configurationaria-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 <ahref=#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 <ahref=https://jpanther.github.io/congo/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 <ahref=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 <ahref=https://gohugo.io/content-management/urls/#permalinkstarget=_blankrel=noreferrer>Hugo docs</a> for permalink configuration.</td></tr><tr><td><code>taxonomies</code></td><td><em>Not set</em></td><td>Refer to the <ahref=https://jpanther.github.io/congo/docs/getting-started/#organising-content>Organising content</a> section for taxonomy configuration.</td></tr></tbody></table><h2id=language-and-i18nclass="relative group">Language and i18n <spanclass="absolute top-0 w-6 transition-opacity opacity-0 -start-6 not-prose group-hover:opacity-100"><aclass="group-hover:text-primary-300 dark:group-hover:text-neutral-700"style=text-decoration-line:none!importanthref=#language-and-i18naria-label=Anchor>#</a></span></h2><p>Congo is optimised for full mult
</span></span><spanclass=dark:text-neutral-300><strong>Note:</strong> Ensure the <code>defaultContentLanguage</code> parameter in the <ahref=#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.</td></tr><tr><td><code>languageName</code></td><td><code>"English"</code></td><td>The name of the language.</td></tr><tr><td><code>languageDirection</code></td><td><code>"ltr"</code></td><td>Whether or not this is an RTL language. Set to <code>"rtl"</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>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>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>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>params.dateFormat</code></td><td><code>"2 January 2006"</code></td><td>How dates are formatted in this language. Refer to the <ahref=https://gohugo.io/functions/format/#gos-layout-stringtarget=_blankrel=noreferrer>Hugo docs</a> for acceptable formats.</td></tr><tr><td><code>params.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>params.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>params.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>params.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>params.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>params.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>params.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><h3id=menusclass="relative group">Menus <spanclass="absolute top-0 w-6 transition-opacity opacity-0 -start-6 not-prose group-hover:opacity-100"><aclass="group-hover:text-primary-300 dark:group-hover:text-neutral-700"style=text-decoration-line:none!importanthref=#menusaria-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].to
