diff --git a/exampleSite/config.toml b/exampleSite/config.toml index ce78d974bf..6ac29d1edb 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -1,14 +1,31 @@ +# this is a required setting for this theme to appear on https://themes.gohugo.io/ +# change this to a value appropriate for you baseURL = "https://example.com" +# as the official Hugo documentation recommends, we turn this off for this +# showcase; this allows the published site to be served by both http and https canonifyURLs = false -relativeURLs = false #required for official documentation served from subfolder +# required for official documentation served from subfolder +relativeURLs = false +# the directory where Hugo reads the themes from; this is specific to your +# installation and most certainly needs be deleted or changed +themesdir = "../.." +# yeah, well, obviously a mandatory setting for your site, if you want to +# use this theme ;-) +theme = "hugo-theme-relearn" + +# the main language of this site; also an automatic pirrrate translation is +# available in this showcase languageCode = "en" defaultContentLanguage = "en" +# if you want to get rrrid o' ourrr pirrrates nonsense uncomment th' next line +# disableLanguages = ['pir'] +# the site's title of this showcase; you should change this ;-) title = "Hugo Relearn Documentation" -theme = "hugo-theme-relearn" -themesdir = "../.." +# settings specific to this theme's features; choose to your likings and +# consult this documentation for explaination [params] editURL = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/" description = "Documentation for Hugo Relearn Theme" @@ -29,7 +46,7 @@ themesdir = "../.." [markup] [markup.highlight] - # if set to `guessSyntax = true`, there will be no unstyled code even if no language + # if `guessSyntax = true`, there will be no unstyled code even if no language # was given BUT mermaid code fences will not work anymore! So this is a mandatory # setting for your site guessSyntax = false @@ -96,11 +113,12 @@ themesdir = "../.." url = "tags/" weight = 40 - # this ourrr way t' showcase th' multilang settings by + # this is ourrr way t' showcase th' multilang settings by # doing autotrrranlat'n of th' english content; we are # lazy and don't supporrt furrrther trrranslations; arrr, # don't take it t' serrrious, fello'; it's prrretty hacky and: # NOT MEANT FOR PRRRODUCTION! ARRR! + [Languages.pir] title = "Documentat'n fer Cap'n Hugo Relearrrn Theme" weight = 1