nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2025-02-17 09:10:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: fully documentad config.toml

Browse source
This commit is contained in:
Sören Weber 2022-02-11 01:49:03 +01:00
parent f761f1fcea
commit ddb993761b
No known key found for this signature in database
GPG key ID: 07D17FF580AE7589
1 changed files with 23 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
exampleSite/config.toml
View file

@ -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" 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 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" languageCode = "en"
defaultContentLanguage = "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" 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] [params]
editURL = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/" editURL = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/"
description = "Documentation for Hugo Relearn Theme" description = "Documentation for Hugo Relearn Theme"
@ -29,7 +46,7 @@ themesdir = "../.."
[markup] [markup]
[markup.highlight] [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 # was given BUT mermaid code fences will not work anymore! So this is a mandatory
# setting for your site # setting for your site
guessSyntax = false guessSyntax = false
@ -96,11 +113,12 @@ themesdir = "../.."
url = "tags/" url = "tags/"
weight = 40 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 # doing autotrrranlat'n of th' english content; we are
# lazy and don't supporrt furrrther trrranslations; arrr, # lazy and don't supporrt furrrther trrranslations; arrr,
# don't take it t' serrrious, fello'; it's prrretty hacky and: # don't take it t' serrrious, fello'; it's prrretty hacky and:
# NOT MEANT FOR PRRRODUCTION! ARRR! # NOT MEANT FOR PRRRODUCTION! ARRR!
[Languages.pir] [Languages.pir]
title = "Documentat'n fer Cap'n Hugo Relearrrn Theme" title = "Documentat'n fer Cap'n Hugo Relearrrn Theme"
weight = 1 weight = 1