mirror of https://github.com/jpanther/congo.git
54 lines
4.5 KiB
Markdown
54 lines
4.5 KiB
Markdown
---
|
|
title: "Configuration"
|
|
date: 2020-08-14
|
|
draft: false
|
|
description: "All the configuration variables available in Congo."
|
|
slug: "configuration"
|
|
tags: ["config", "docs"]
|
|
showDate: false
|
|
showAuthor: false
|
|
---
|
|
|
|
Congo is a highly customisable theme and uses some of the latest Hugo features to simplify how it is configured.
|
|
|
|
The theme ships with a default configuration that gets you up and running with a basic blog or static website.
|
|
|
|
> 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.
|
|
|
|
The default theme configuration is documented in each file so you can freely adjust the settings to meet your needs.
|
|
|
|
{{< alert >}}
|
|
As outlined in the [installation instructions](/docs/installation/#set-up-your-configuration-files), you should adjust your theme configuration by modifying the files in the `config/_default/` folder of your Hugo project and delete the `config.toml` file in your project root.
|
|
{{< /alert >}}
|
|
|
|
## Parameters
|
|
|
|
Congo provides a large number of configuration parameters that control how the theme functions. The table below outlines every available parameter in the `config/_default/params.toml` file.
|
|
|
|
Many of the article defaults here can be overridden on a per article basis by specifying it in the front matter. Refer to the [Front Matter](/docs/front-matter/) section for further details.
|
|
|
|
<!-- prettier-ignore-start -->
|
|
|Name|Type|Default|Description|
|
|
| --- | --- | --- | --- |
|
|
|`homepage.layout`|string|`"page"`|The layout of the homepage. Valid values are `page`, `profile` or `custom`. When set to `custom`, you must provide your own layout by creating a `/layouts/partials/home/custom.html` file. Refer to the [Homepage Layout](/docs/homepage-layout/) section for more details.|
|
|
|`homepage.showList`|boolean|`false`|Whether or not recent articles are listed on the homepage beneath the page content. Refer to the [Recent Articles](/docs/homepage-layout/#recent-articles) docs for more details.|
|
|
|`homepage.listSections`|array of strings|`["blog"]`|The sections of content to include in the recent list when `homepage.showList` is `true`.|
|
|
|`article.showDate`|boolean|`true`|Whether or not article dates are displayed.|
|
|
|`article.dateFormat`|string|`"2 January 2006"`|How article dates are formatted. Refer to the [Hugo docs](https://gohugo.io/functions/format/#gos-layout-string) for acceptable formats.|
|
|
|`article.showAuthor`|boolean|`true`|Whether or not the author box is displayed in the article footer.|
|
|
|`article.showDraftLabel`|boolean|`true`|Whether or not the draft indicator is shown next to articles when site is built with `--buildDrafts`.|
|
|
|`article.showHeadingAnchors`|boolean|`true`|Whether or not heading anchor links are displayed alongside headings within articles.|
|
|
|`article.showPagination`|boolean|`true`|Whether or not the next/previous article links are displayed in the article footer.|
|
|
|`article.showReadingTime`|boolean|`true`|Whether or not article reading times are displayed.|
|
|
|`article.sharingLinks`|array of strings|_Not set_|Which sharing links to display at the end of each article. When not provided, or set to `false` no links will be displayed.|
|
|
|`list.groupByYear`|boolean|`true`|Whether or not articles are grouped under years in the article listing.|
|
|
|`sitemap.excludedKinds`|array of strings|`["taxonomy", "term"]`|Kinds of content that should be excluded from the generated `/sitemap.xml` file. Refer to the [Hugo docs](https://gohugo.io/templates/section-templates/#page-kinds) for acceptable values.|
|
|
|`taxonomy.showTermCount`|boolean|`true`|Whether or not the number of articles within a taxonomy term is displayed on the taxonomy listing.|
|
|
|`fathomAnalytics.site`|string|_Not set_|The site code generated by Fathom Analytics for the website. Refer to the [Analytics docs](#analyticshtml) below for more details.|
|
|
|`fathomAnalytics.domain`|string|_Not set_|If using a custom domain with Fathom Analytics, provide it here to serve `script.js` from the custom domain.|
|
|
|`verification.google`|string|_Not set_|The site verification string provided by Google to be included in the site metadata.|
|
|
|`verification.bing`|string|_Not set_|The site verification string provided by Bing to be included in the site metadata.|
|
|
|`verification.pinterest`|string|_Not set_|The site verification string provided by Pinterest to be included in the site metadata.|
|
|
|`verification.yandex`|string|_Not set_|The site verification string provided by Yandex to be included in the site metadata.|
|
|
<!-- prettier-ignore-end -->
|