<scripttype=application/ld+json>{"@context":"https://schema.org","@type":"BlogPosting","articleSection":"Documentation","name":"Configuration","headline":"Configuration","description":"All the configuration variables available in Congo.","inLanguage":"en-AU","author":{"@type":"Person","name":"Congo"},"creator":{"@type":"Person","name":"Congo"},"copyrightHolder":"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","url":"https:\/\/jpanther.github.io\/congo\/docs\/configuration\/","wordCount":"1225","keywords":["config","docs"]}</script>
<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>
<spanclass="no-prose dark:text-neutral-300">As outlined in the <ahref=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>
<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>author.name</code> refers to <code>[author] name</code>).</p>
<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>
<td>The language of the website for site metadata purposes. It can be a top-level language (ie. <code>en</code>) or a sub-variant (ie. <code>en-AU</code>)."</td>
<td>This value determines the language of theme components."</td>
</tr>
<tr>
<td><code>title</code></td>
<td>string</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>string</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>enableEmoji</code></td>
<td>boolean</td>
<td><code>true</code></td>
<td>Whether emoji strings in content should be converted to emoji symbols.</td>
</tr>
<tr>
<td><code>enableRobotsTXT</code></td>
<td>boolean</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>
<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>
<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>string</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>static/</code> folder.</td>
</tr>
<tr>
<td><code>author.links</code></td>
<td>array of objects</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>
<td>Refer to the <ahref=https://jpanther.github.io/congo/docs/getting-started/#organising-content>Organising content</a> section for taxonomy configuration.</td>
<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 <ahref=https://jpanther.github.io/congo/docs/front-matter/>Front Matter</a> section for further details.</p>
<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 <ahref=https://jpanther.github.io/congo/docs/getting-started/#colour-schemes>Colour Schemes</a> section for more details.</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>
<td>String that indicates how robots should handle your site. If set, it will be output in the page head. Refer to <ahref=https://developers.google.com/search/docs/advanced/robots/robots_meta_tag#directives>Google’s docs</a> for valid values.</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 <ahref=https://jpanther.github.io/congo/docs/homepage-layout/>Homepage Layout</a> section for more details.</td>
<td>Whether or not article dates are displayed.</td>
</tr>
<tr>
<td><code>article.dateFormat</code></td>
<td>string</td>
<td><code>"2 January 2006"</code></td>
<td>How article dates are formatted. Refer to the <ahref=https://gohugo.io/functions/format/#gos-layout-string>Hugo docs</a> for acceptable formats.</td>
</tr>
<tr>
<td><code>article.showAuthor</code></td>
<td>boolean</td>
<td><code>true</code></td>
<td>Whether or not the author box is displayed in the article footer.</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>string</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>boolean</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>
<td>Whether or not article summaries are displayed on list pages. If a summary is not provided in the <ahref=https://jpanther.github.io/congo/docs/front-matter/>front matter</a>, one will be auto generated using the <code>summaryLength</code> parameter in the <ahref=#site-configuration>site configuration</a>.</td>
<td>Kinds of content that should be excluded from the generated <code>/sitemap.xml</code> file. Refer to the <ahref=https://gohugo.io/templates/section-templates/#page-kinds>Hugo docs</a> for acceptable values.</td>
</tr>
<tr>
<td><code>taxonomy.showTermCount</code></td>
<td>boolean</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>
<td>The site code generated by Fathom Analytics for the website. Refer to the <ahref=https://jpanther.github.io/congo/docs/partials/#analytics>Analytics docs</a> for more details.</td>
