diff --git a/README.md b/README.md index 5007186e..dcd92e60 100644 --- a/README.md +++ b/README.md @@ -190,26 +190,40 @@ When you create a new taxonomy, you will need to adjust the navigation links on 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) below for further details. + |Name|Type|Default|Description| | --- | --- | --- | --- | -|`article.showDate`|boolean|`true`|Whether or not the article date is displayed.| -|`article.dateFormat`|string|`"2 January 2006"`|How the article date is formatted. Refer to the [Hugo docs](https://gohugo.io/functions/format/#gos-layout-string) for acceptable formats.| -|`article.showReadingTime`|boolean|`true`|Whether or not reading time is displayed.| +|`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.showReadingTime`|boolean|`true`|Whether or not article reading times are displayed.| +|`article.showHeadingAnchors`|boolean|`true`|Whether or not heading anchor links are displayed alongside headings within articles.| |`article.showAuthor`|boolean|`true`|Whether or not the author box is displayed in the article footer.| |`article.showPagination`|boolean|`true`|Whether or not the next/previous article links are displayed in the article footer.| |`taxonomy.showTermCount`|boolean|`true`|Whether or not the number of articles within a taxonomy term is displayed on the taxonomy 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.| +|`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.| +|`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.| +|`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.| ## Front Matter -In addition to the default Hugo front matter parameters, Congo adds a number of additional options to customise the presentation of individual articles. All the available theme parameters are listed below. Keep in mind that you only need to specify these parameters in your front matter when you want to override the default. +In addition to the [default Hugo front matter parameters](https://gohugo.io/content-management/front-matter/#front-matter-variables), Congo adds a number of additional options to customise the presentation of individual articles. All the available theme parameters are listed below. + +Front matter parameter default values are inherited from the [base theme config](#parameters) above, so you only need to specify these parameters in your front matter when you want to override the default. |Name|Type|Default|Description| | --- | --- | --- | --- | -|`xml`|boolean|`true`|Whether or not this article is included in the generated sitemap.xml file.| +|`showHeadingAnchors`|boolean|`article.showHeadingAnchors`|Whether or not heading anchor links are displayed alongside headings within this article.| +|`showAuthor`|boolean|`article.showAuthor`|Whether or not the author box is displayed in the article footer.| +|`showPagination`|boolean|`article.showPagination`|Whether or not the next/previous article links are displayed in the article footer.| +|`xml`|boolean|`true` unless excluded by `sitemap.excludedKinds`|Whether or not this article is included in the generated `/sitemap.xml` file.| ## Shortcodes diff --git a/config/_default/params.toml b/config/_default/params.toml index 9eec6d7b..7bd803b6 100644 --- a/config/_default/params.toml +++ b/config/_default/params.toml @@ -1,11 +1,14 @@ # -- Theme Options -- # These options control how the theme functions and allow you to # customise the display of your website. +# +# Refer to the README for more details about each of these parameters. [article] showDate = true dateFormat = "2 January 2006" showReadingTime = true + showHeadingAnchors = true showAuthor = true showPagination = true @@ -15,21 +18,12 @@ [sitemap] excludedKinds = ["taxonomy", "term"] -# -- Site Verification -- -# Provide the verification strings for the providers below and the -# corresponding meta tags will be added to the site . - [verification] # google = "" # bing = "" # pinterest = "" # yandex = "" - -# -- Fathom Analytics -- -# To enable Fathom Analytics on your site, specify your site code below. -# If you also use a custom domain with Fathom, you can add it at `domain`. - [fathomAnalytics] # site = "ABC12345" # domain = "llama.yoursite.com" diff --git a/layouts/_default/_markup/render-heading.html b/layouts/_default/_markup/render-heading.html index ff5ea9fc..84253591 100644 --- a/layouts/_default/_markup/render-heading.html +++ b/layouts/_default/_markup/render-heading.html @@ -1 +1 @@ -{{ .Text | safeHTML }} # +{{ .Text | safeHTML }} {{ if .Page.Params.showHeadingAnchors | default (.Page.Site.Params.article.showHeadingAnchors | default true) }}#{{ end }} diff --git a/layouts/_default/single.html b/layouts/_default/single.html index 6df43111..9c6256a1 100644 --- a/layouts/_default/single.html +++ b/layouts/_default/single.html @@ -17,7 +17,7 @@ {{ .Content | emojify }} {{/* Comments */}} diff --git a/layouts/partials/article-pagination.html b/layouts/partials/article-pagination.html index b09ae3d5..99d91451 100644 --- a/layouts/partials/article-pagination.html +++ b/layouts/partials/article-pagination.html @@ -1,4 +1,4 @@ -{{ if .Site.Params.article.showPagination | default true }} +{{ if .Params.showPagination | default (.Site.Params.article.showPagination | default true) }} {{ if or .NextInSection .PrevInSection }}
diff --git a/layouts/partials/author.html b/layouts/partials/author.html index 4d907fc6..cc8480cb 100644 --- a/layouts/partials/author.html +++ b/layouts/partials/author.html @@ -1,4 +1,4 @@ -{{ if .Site.Params.article.showAuthor | default true }} +{{ if .Params.showAuthor | default (.Site.Params.article.showAuthor | default true) }}
{{ with .Site.Author.image }}