hugo-theme-relearn/exampleSite/config.toml

baseURL = "https://example.com"
canonifyURLs = false
relativeURLs = false #required for official documentation served from subfolder

languageCode = "en"
defaultContentLanguage = "en"

title = "Hugo Relearn Documentation"
theme = "hugo-theme-relearn"
themesdir = "../.."

[params]
  editURL = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/"
  description = "Documentation for Hugo Relearn Theme"
  author = "Sören Weber"
  showVisitedLinks = true
  disableBreadcrumb = false
  disableNextPrev = false
  disableLandingPageButton = true
  disableMermaid = false
  titleSeparator = "::"
  themeVariant = "relearn"
  disableSeoHiddenPages = true

[outputs]
  home = ["HTML", "RSS", "JSON"] # add JSON to the home page to support lunr search

[markup]
  [markup.highlight]
    style = "base16-snazzy" # choose a color theme or create your own
    guessSyntax = false     # if set to true, avoid unstyled code if no language was given but mermaid code fences will not work anymore

[markup.goldmark.renderer]
  unsafe= true

[Languages]
  [Languages.en]
    title = "Documentation for Hugo Relearn Theme"
    weight = 1
    languageName = "English"
    landingPageURL = "/"
    landingPageName = "<i class='fas fa-home'></i> Home"

  [[Languages.en.menu.shortcuts]]
    name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
    identifier = "ds"
    url = "https://github.com/McShelby/hugo-theme-relearn"
    weight = 10

  [[Languages.en.menu.shortcuts]]
    name = "<i class='fas fa-fw fa-camera'></i> Showcases"
    url = "showcase/"
    weight = 11

  [[Languages.en.menu.shortcuts]]
    name = "<i class='fas fa-fw fa-bookmark'></i> Hugo Documentation"
    identifier = "hugodoc"
    url = "https://gohugo.io/"
    weight = 20

  [[Languages.en.menu.shortcuts]]
    name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
    url = "credits/"
    weight = 30

  [[Languages.en.menu.shortcuts]]
    name = "<i class='fas fa-fw fa-tags'></i> Tags"
    url = "tags/"
    weight = 40

  [Languages.pir]
    title = "Documentat'n fer Cap'n Hugo Relearrrn Theme"
    weight = 1
    languageName = "Arrr! Pirrrates"
    landingPageURL = "/pir/"
    landingPageName = "<i class='fas fa-home'></i> Arrr! Home"

  [[Languages.pir.menu.shortcuts]]
    name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
    identifier = "ds"
    url = "https://github.com/McShelby/hugo-theme-relearn"
    weight = 10

  [[Languages.pir.menu.shortcuts]]
    name = "<i class='fas fa-fw fa-camera'></i> Showcases"
    url = "showcase/"
    weight = 11

  [[Languages.pir.menu.shortcuts]]
    name = "<i class='fas fa-fw fa-bookmark'></i> Cap'n Hugo Documentat'n"
    identifier = "hugodoc"
    url = "https://gohugo.io/"
    weight = 20

  [[Languages.pir.menu.shortcuts]]
    name = "<i class='fas fa-fw fa-bullhorn'></i> Crrredits"
    url = "credits/"
    weight = 30

  [[Languages.pir.menu.shortcuts]]
    name = "<i class='fas fa-fw fa-tags'></i> Arrr! Tags"
    url = "tags/"
    weight = 40
Hardening examplesite against misconfiguration 2021-07-01 19:47:17 +00:00			`baseURL = "https://example.com"`
exampleSite: make configuration work from subfolder and canonifyURLs=false #163 2022-02-06 00:55:07 +00:00			`canonifyURLs = false`
exampleSite: fix official documentation served from subfolder #163 2022-02-06 01:13:38 +00:00			`relativeURLs = false #required for official documentation served from subfolder`
exampleSite: make configuration work from subfolder and canonifyURLs=false #163 2022-02-06 00:55:07 +00:00
docs: showcase multilang feature #87 Arrr, Pirrrate trrranslat'n 2021-09-11 13:46:14 +00:00			`languageCode = "en"`
feat: add full i18n. Select desired language in the site automatically 2017-07-31 20:32:06 +00:00			`defaultContentLanguage = "en"`
feat: mermaid #53 + archetypes + move doc + expand 2017-07-30 16:02:07 +00:00
Rebranding to new theme name - Rename theme from "Learn" to "Relearn" - also change URLs - remove old references - more removal of french and chinese 2021-06-30 12:56:06 +00:00			`title = "Hugo Relearn Documentation"`
			`theme = "hugo-theme-relearn"`
feat: mermaid #53 + archetypes + move doc + expand 2017-07-30 16:02:07 +00:00			`themesdir = "../.."`

			`[params]`
Compliance: Rename branch master to main 2021-07-01 09:01:51 +00:00			`editURL = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/"`
Rebranding to new theme name - Rename theme from "Learn" to "Relearn" - also change URLs - remove old references - more removal of french and chinese 2021-06-30 12:56:06 +00:00			`description = "Documentation for Hugo Relearn Theme"`
Remove more references 2021-06-30 12:56:51 +00:00			`author = "Sören Weber"`
feat: add 'more' section in left menu 2017-08-02 21:39:49 +00:00			`showVisitedLinks = true`
Enable breadcrumb and prevnext for demosite 2018-10-23 02:53:45 +00:00			`disableBreadcrumb = false`
			`disableNextPrev = false`
Navigation home option (#381) * enabled mermaid by default * implemented logic to use internal oder cdn mermaid * added english documentation * added french translation for the mermaid options * Removed useless test print * Hugo does not use upper case letters in params * fixed false sample link * improved mermaid pages * fixed always load mermaid if no frontmatter specified * applied 3 new params to default config * Implemented Home Button logic * Applied default style * applied same landingpage ref to logo partials * added sample image, how the button will looks like * added en documentation on how to configure the button * translated home button configuration to french via deepl * applied home button style to theme variants * set button disabled by default * fixed mermaid samples * removed obsolete css files * changed default version of mermaid cdn * renamed mermaidURL to customMermaidURL and removed css link * improved mermaid configuration description Co-authored-by: Arthur Ferdinand Lindner <Arthur-Ferdinand.Lindner@Telekom.de> Co-authored-by: Arthur Ferdinand Lindner <arthur.lindner@outlook.de> 2020-10-21 16:53:27 +00:00			`disableLandingPageButton = true`
Customize mermaid module (#362) * enabled mermaid by default * implemented logic to use internal oder cdn mermaid * added english documentation * added french translation for the mermaid options * Removed useless test print * Hugo does not use upper case letters in params * fixed false sample link * improved mermaid pages * fixed always load mermaid if no frontmatter specified * fixed mermaid samples * removed obsolete css files * changed default version of mermaid cdn * renamed mermaidURL to customMermaidURL and removed css link * improved mermaid configuration description Co-authored-by: Arthur Ferdinand Lindner <Arthur-Ferdinand.Lindner@Telekom.de> Co-authored-by: Arthur Ferdinand Lindner <arthur.lindner@outlook.de> 2020-09-11 13:57:25 +00:00			`disableMermaid = false`
Add the titleSeparator parameter. (#448) * Add the titleSeparator parameter * Add a description for the titleSeparator parameter 2020-09-11 08:31:22 +00:00			`titleSeparator = "::"`
theme: default color for code block fallback - fix 2021-10-12 15:15:56 +00:00			`themeVariant = "relearn"`
sitemap: turn off indexing of hidden pages in exampleSite #85 2021-09-09 22:17:58 +00:00			`disableSeoHiddenPages = true`
feat: mermaid #53 + archetypes + move doc + expand 2017-07-30 16:02:07 +00:00
			`[outputs]`
docs: add hint for search in config.toml 2021-09-28 19:35:59 +00:00			`home = ["HTML", "RSS", "JSON"] # add JSON to the home page to support lunr search`
theme: prepare for new hugo theme registration #13 2021-07-04 18:59:17 +00:00
code highligher: switch to standard hugo highlighter #32 Since a while, Hugo has its own mechanism for code highlightning. We remove the old highlightning code provided by the client-side javascript library highlight.js and all its related files. This also solves issues introduced by Hugos own highlightning because in our theme we are currently highlighting the code twice leading to unpredictiable results. This will also fix an issue were light code highlightning themes weren't displayed correctly because our styles are overwriting color information. Another advantage is the huge list of supported languages which by far exceeds our current list. On the downside, this is a breaking change because our current color theme isn't supported by Hugo. 2021-07-25 23:05:46 +00:00			`[markup]`
			`[markup.highlight]`
theme: default color for code block fallback - fix 2021-10-12 15:15:56 +00:00			`style = "base16-snazzy" # choose a color theme or create your own`
clarify caveats for mermaid code fences 2021-10-07 21:01:04 +00:00			`guessSyntax = false # if set to true, avoid unstyled code if no language was given but mermaid code fences will not work anymore`
code highligher: switch to standard hugo highlighter #32 Since a while, Hugo has its own mechanism for code highlightning. We remove the old highlightning code provided by the client-side javascript library highlight.js and all its related files. This also solves issues introduced by Hugos own highlightning because in our theme we are currently highlighting the code twice leading to unpredictiable results. This will also fix an issue were light code highlightning themes weren't displayed correctly because our styles are overwriting color information. Another advantage is the huge list of supported languages which by far exceeds our current list. On the downside, this is a breaking change because our current color theme isn't supported by Hugo. 2021-07-25 23:05:46 +00:00
expand: add unsafe html to config to allow nested shortcodes 2021-07-16 21:15:04 +00:00			`[markup.goldmark.renderer]`
			`unsafe= true`

feat: add 'more' section in left menu 2017-08-02 21:39:49 +00:00			`[Languages]`
theme: prepare for new hugo theme registration #13 2021-07-04 18:59:17 +00:00			`[Languages.en]`
			`title = "Documentation for Hugo Relearn Theme"`
			`weight = 1`
			`languageName = "English"`
theme: generate correct links if theme served from subdirectory #120 2021-10-17 21:03:41 +00:00			`landingPageURL = "/"`
theme: prepare for new hugo theme registration #13 2021-07-04 18:59:17 +00:00			`landingPageName = "<i class='fas fa-home'></i> Home"`

			`[[Languages.en.menu.shortcuts]]`
			`name = "<i class='fab fa-fw fa-github'></i> GitHub repo"`
			`identifier = "ds"`
			`url = "https://github.com/McShelby/hugo-theme-relearn"`
			`weight = 10`

			`[[Languages.en.menu.shortcuts]]`
			`name = "<i class='fas fa-fw fa-camera'></i> Showcases"`
exampleSite: make configuration work from subfolder and canonifyURLs=false #163 2022-02-06 00:55:07 +00:00			`url = "showcase/"`
theme: prepare for new hugo theme registration #13 2021-07-04 18:59:17 +00:00			`weight = 11`

			`[[Languages.en.menu.shortcuts]]`
			`name = "<i class='fas fa-fw fa-bookmark'></i> Hugo Documentation"`
			`identifier = "hugodoc"`
			`url = "https://gohugo.io/"`
			`weight = 20`

			`[[Languages.en.menu.shortcuts]]`
			`name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"`
exampleSite: make configuration work from subfolder and canonifyURLs=false #163 2022-02-06 00:55:07 +00:00			`url = "credits/"`
theme: prepare for new hugo theme registration #13 2021-07-04 18:59:17 +00:00			`weight = 30`
docs: showcase multilang feature #87 Arrr, Pirrrate trrranslat'n 2021-09-11 13:46:14 +00:00
docs: adjust docs to config.toml 2021-10-24 09:53:09 +00:00			`[[Languages.en.menu.shortcuts]]`
			`name = "<i class='fas fa-fw fa-tags'></i> Tags"`
exampleSite: make configuration work from subfolder and canonifyURLs=false #163 2022-02-06 00:55:07 +00:00			`url = "tags/"`
docs: adjust docs to config.toml 2021-10-24 09:53:09 +00:00			`weight = 40`

docs: rename english pirate translation to avoid crash on rendering #90 2021-09-20 20:04:35 +00:00			`[Languages.pir]`
docs: showcase multilang feature #87 Arrr, Pirrrate trrranslat'n 2021-09-11 13:46:14 +00:00			`title = "Documentat'n fer Cap'n Hugo Relearrrn Theme"`
			`weight = 1`
			`languageName = "Arrr! Pirrrates"`
theme: generate correct links if theme served from subdirectory #120 2021-10-17 21:03:41 +00:00			`landingPageURL = "/pir/"`
docs: showcase multilang feature #87 Arrr, Pirrrate trrranslat'n 2021-09-11 13:46:14 +00:00			`landingPageName = "<i class='fas fa-home'></i> Arrr! Home"`

docs: rename english pirate translation to avoid crash on rendering #90 2021-09-20 20:04:35 +00:00			`[[Languages.pir.menu.shortcuts]]`
docs: showcase multilang feature #87 Arrr, Pirrrate trrranslat'n 2021-09-11 13:46:14 +00:00			`name = "<i class='fab fa-fw fa-github'></i> GitHub repo"`
			`identifier = "ds"`
			`url = "https://github.com/McShelby/hugo-theme-relearn"`
			`weight = 10`

docs: rename english pirate translation to avoid crash on rendering #90 2021-09-20 20:04:35 +00:00			`[[Languages.pir.menu.shortcuts]]`
docs: showcase multilang feature #87 Arrr, Pirrrate trrranslat'n 2021-09-11 13:46:14 +00:00			`name = "<i class='fas fa-fw fa-camera'></i> Showcases"`
exampleSite: make configuration work from subfolder and canonifyURLs=false #163 2022-02-06 00:55:07 +00:00			`url = "showcase/"`
docs: showcase multilang feature #87 Arrr, Pirrrate trrranslat'n 2021-09-11 13:46:14 +00:00			`weight = 11`

docs: rename english pirate translation to avoid crash on rendering #90 2021-09-20 20:04:35 +00:00			`[[Languages.pir.menu.shortcuts]]`
docs: showcase multilang feature #87 Arrr, Pirrrate trrranslat'n 2021-09-11 13:46:14 +00:00			`name = "<i class='fas fa-fw fa-bookmark'></i> Cap'n Hugo Documentat'n"`
			`identifier = "hugodoc"`
			`url = "https://gohugo.io/"`
			`weight = 20`

docs: rename english pirate translation to avoid crash on rendering #90 2021-09-20 20:04:35 +00:00			`[[Languages.pir.menu.shortcuts]]`
docs: showcase multilang feature #87 Arrr, Pirrrate trrranslat'n 2021-09-11 13:46:14 +00:00			`name = "<i class='fas fa-fw fa-bullhorn'></i> Crrredits"`
exampleSite: make configuration work from subfolder and canonifyURLs=false #163 2022-02-06 00:55:07 +00:00			`url = "credits/"`
docs: showcase multilang feature #87 Arrr, Pirrrate trrranslat'n 2021-09-11 13:46:14 +00:00			`weight = 30`
docs: adjust docs to config.toml 2021-10-24 09:53:09 +00:00
			`[[Languages.pir.menu.shortcuts]]`
			`name = "<i class='fas fa-fw fa-tags'></i> Arrr! Tags"`
exampleSite: make configuration work from subfolder and canonifyURLs=false #163 2022-02-06 00:55:07 +00:00			`url = "tags/"`
docs: adjust docs to config.toml 2021-10-24 09:53:09 +00:00			`weight = 40`