From 8f099316b5e069ee87cf5674749e58ecc82b5c9d Mon Sep 17 00:00:00 2001 From: James Panther <4462786+jpanther@users.noreply.github.com> Date: Fri, 13 Aug 2021 19:08:35 +1000 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Document=20configuration=20files?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- config/_default/author.toml | 5 +++++ config/_default/config.toml | 14 ++++++++++++++ config/_default/markup.toml | 3 +++ config/_default/menus.toml | 12 ++++++++++++ config/_default/params.toml | 9 +++++++++ 5 files changed, 43 insertions(+) diff --git a/config/_default/author.toml b/config/_default/author.toml index 552b5aa5..5aa0e4f9 100644 --- a/config/_default/author.toml +++ b/config/_default/author.toml @@ -1,3 +1,8 @@ +# -- Site Author Details -- +# To display the author box below each article, configure the settings below. +# The author image should be placed inside the `/static` folder. +# Uncomment any links to enable them. The icons will be displayed in the order listed. + [author] # name = "Your name here" # image = "/img/author.jpg" diff --git a/config/_default/config.toml b/config/_default/config.toml index 8d028486..fda0ff81 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -1,9 +1,23 @@ +# -- Site Configuration -- theme = "congo" + +# Speficiy the base URL for the website. # baseURL = "https://your_domain.com/" + +# The language code of the language that the website is written in. +# This can be a base language (ie. "en") or a specific variant (ie. "en-AU"). languageCode = "en" +# The website title. This will be displayed in the site header. title = "Congo" + +# A default copyright message is generated automatically. +# Uncomment the line below to provide a custom copyright Markdown string. # copyright = "Copy, _right?_ :thinking_face:" +# To automatically convert strings such as :bang: to emoji, set this to true. enableEmoji = true + +# Congo will generate a robots file that allows search engines to index +# the entire site. If you don't want a robots file, set this to false. enableRobotsTXT = true diff --git a/config/_default/markup.toml b/config/_default/markup.toml index aadff293..2ca49b3b 100644 --- a/config/_default/markup.toml +++ b/config/_default/markup.toml @@ -1,3 +1,6 @@ +# -- Markup -- +# These settings are required for the theme to function. + [goldmark] [goldmark.renderer] unsafe = true diff --git a/config/_default/menus.toml b/config/_default/menus.toml index 05445b84..7d0c31f4 100644 --- a/config/_default/menus.toml +++ b/config/_default/menus.toml @@ -1,3 +1,15 @@ +# -- Main Menu -- +# The main menu is displayed at the top of the theme. +# Acceptable parameters are name, pageRef, page, url, title, weight. +# +# The simplest menu configuration is to provide: +# name = The name to be displayed for this menu link +# pageRef = The identifier of the page or section to link to +# +# By default the menu is ordered alphabetically. This can be +# overridden by providing a weight value. The menu will then be +# ordered by weight from lowest to highest. + [[main]] name = "Blog" pageRef = "posts" diff --git a/config/_default/params.toml b/config/_default/params.toml index 40404aef..cfcc0593 100644 --- a/config/_default/params.toml +++ b/config/_default/params.toml @@ -1,9 +1,18 @@ +# -- 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"