task: even more documentation for the config files

docs/config/_default/hugo.toml

@@ -1,3 +1,9 @@
+# The main configuration file.
+# Usable standalone for a fully functioning site
+# or as base values for all other configurations.
+
+# To use run `hugo` or `hugo server`
+
 # this is a required setting for this theme to appear on https://themes.gohugo.io/
 # change this to a value appropriate for you; if your site is served from a subdirectory
 # set it like 'https://example.com/mysite/'

docs/config/github/hugo.toml

@@ -1,4 +1,8 @@
-# Configuration to release this site on GitHub Pages
+# Configuration to release this site on GitHub Pages.
 
+# To use run `hugo -e github` or `hugo server -e github`
+
+# For usual GH pages, your website resides in a subdirectory
+# making it necessary to disable headless server mode
 baseURL = 'https://mcshelby.github.io/hugo-theme-relearn/'
 relativeURLs = false

docs/config/performance/hugo.toml

@@ -1,8 +1,10 @@
 # This configuration file disables all performance intensive features.
 
+# To use run `hugo -e performance` or `hugo server -e performance`
+
 # The Piratish pages are slow due to the mechanism used to autotranslate
 # the original english content via the piratify shortcode. This is
-# only an issue with this showcase as your site should have the piratish
+# only an issue with this showcase as your site should have no piratish
 # translations.
 disableLanguages = ['pir']
 

docs/config/testing/hugo.toml

@@ -1,6 +1,8 @@
-# Configuration to test the exampleSite for changes in development
+# Configuration to test the showcase for changes in development
 # This configuration will not result in a functioning website.
 
+# To use run `hugo -e testing` or `hugo server -e testing`
+
 # We disable this for testing; you must do so too
 # if you want to use the themes parameter disableGeneratorVersion=true;
 # otherwise Hugo will create a generator tag on your home page

exampleSite/config/_default/hugo.toml

@@ -1,3 +1,9 @@
+# The main configuration file.
+# Usable standalone for a fully functioning site
+# or as base values for all other configurations.
+
+# To use run `hugo` or `hugo server`
+
 # change this to a value appropriate for you; if your site is served from a subdirectory
 # set it like 'https://example.com/mysite/'
 baseURL = 'https://example.com/'

exampleSite/config/dev/hugo.toml

@@ -1,13 +1,13 @@
 # Configuration to create a complete website locally, containing of the docs
-# and the exampleSite.
+# and the exampleSite. This resembles the same structure as the GitHub Pages
 #
 # 1. Build the docs by either `hugo` or `hugo server`
-# 2. Build the exampleSite by `hugo --environment dev` or `hugo server --environment dev
+# 2. Build the exampleSite by `hugo -e dev` or `hugo server -e dev
 #`
 # After that, a complete website is available in the docs/public folder
 # and can be used from the file system. The links between both projects
-# will not work with `hugo server`, the pages need to be visited
-# separately, adding different ports.
+# will not work as they are pointing the the GitHub Pages copy. So
+# for testing you will have to type them manually.
 
 # Standard adjustments for deveolpment, to make this site work
 baseURL = 'https://example.com/exampleSite/'

exampleSite/config/github/hugo.toml

@@ -1,4 +1,8 @@
-# Configuration to release this site on GitHub Pages
+# Configuration to release this site on GitHub Pages.
 
+# To use run `hugo -e github` or `hugo server -e github`
+
+# For usual GH pages, your website resides in a subdirectory
+# making it necessary to disable headless server mode
 baseURL = 'https://mcshelby.github.io/hugo-theme-relearn/exampleSite/'
 relativeURLs = false

exampleSite/config/performance/hugo.toml

@@ -1,8 +1,10 @@
 # This configuration file disables all performance intensive features.
 
+# To use run `hugo -e performance` or `hugo server -e performance`
+
 # The Piratish pages are slow due to the mechanism used to autotranslate
 # the original english content via the piratify shortcode. This is
-# only an issue with this showcase as your site should have the piratish
+# only an issue with this showcase as your site should have no piratish
 # translations.
 disableLanguages = ['pir']
 

exampleSite/config/testing/hugo.toml

@@ -1,6 +1,8 @@
-# Configuration to test the exampleSite for changes in development
+# Configuration to test the showcase for changes in development
 # This configuration will not result in a functioning website.
 
+# To use run `hugo -e testing` or `hugo server -e testing`
+
 # We disable this for testing; you must do so too
 # if you want to use the themes parameter disableGeneratorVersion=true;
 # otherwise Hugo will create a generator tag on your home page

layouts/partials/version.txt

@@ -1 +1 @@
-7.4.0+713531ec7d191694a7a939068b47329e204e6e1e
+7.4.0+00881d7646d2c81cc308d447a29452be33f472e3