From 6fa23b9563da11707a590081aaa22acccf3e1a0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Wed, 19 Feb 2025 21:54:51 +0100 Subject: [PATCH] task: even more documentation for the config files --- docs/config/_default/hugo.toml | 6 ++++++ docs/config/github/hugo.toml | 6 +++++- docs/config/performance/hugo.toml | 4 +++- docs/config/testing/hugo.toml | 4 +++- exampleSite/config/_default/hugo.toml | 6 ++++++ exampleSite/config/dev/hugo.toml | 8 ++++---- exampleSite/config/github/hugo.toml | 6 +++++- exampleSite/config/performance/hugo.toml | 4 +++- exampleSite/config/testing/hugo.toml | 4 +++- layouts/partials/version.txt | 2 +- 10 files changed, 39 insertions(+), 11 deletions(-) diff --git a/docs/config/_default/hugo.toml b/docs/config/_default/hugo.toml index 1910bd9dd3..727ffe7408 100644 --- a/docs/config/_default/hugo.toml +++ b/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/' diff --git a/docs/config/github/hugo.toml b/docs/config/github/hugo.toml index 0d921d55f3..c97b88c6ca 100644 --- a/docs/config/github/hugo.toml +++ b/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 diff --git a/docs/config/performance/hugo.toml b/docs/config/performance/hugo.toml index be994c65bf..fc72050461 100644 --- a/docs/config/performance/hugo.toml +++ b/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'] diff --git a/docs/config/testing/hugo.toml b/docs/config/testing/hugo.toml index 26d4309033..b374507a5f 100644 --- a/docs/config/testing/hugo.toml +++ b/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 diff --git a/exampleSite/config/_default/hugo.toml b/exampleSite/config/_default/hugo.toml index 2da8ff377c..92dc0859ff 100644 --- a/exampleSite/config/_default/hugo.toml +++ b/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/' diff --git a/exampleSite/config/dev/hugo.toml b/exampleSite/config/dev/hugo.toml index bcd33d0aea..71c756a479 100644 --- a/exampleSite/config/dev/hugo.toml +++ b/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/' diff --git a/exampleSite/config/github/hugo.toml b/exampleSite/config/github/hugo.toml index 84f9689233..03e5185d33 100644 --- a/exampleSite/config/github/hugo.toml +++ b/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 diff --git a/exampleSite/config/performance/hugo.toml b/exampleSite/config/performance/hugo.toml index be994c65bf..fc72050461 100644 --- a/exampleSite/config/performance/hugo.toml +++ b/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'] diff --git a/exampleSite/config/testing/hugo.toml b/exampleSite/config/testing/hugo.toml index 26d4309033..b374507a5f 100644 --- a/exampleSite/config/testing/hugo.toml +++ b/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 diff --git a/layouts/partials/version.txt b/layouts/partials/version.txt index 5ce3f193cb..9b77292ff4 100644 --- a/layouts/partials/version.txt +++ b/layouts/partials/version.txt @@ -1 +1 @@ -7.4.0+713531ec7d191694a7a939068b47329e204e6e1e \ No newline at end of file +7.4.0+00881d7646d2c81cc308d447a29452be33f472e3 \ No newline at end of file