mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-23 15:57:57 +00:00
211 lines
7.9 KiB
TOML
211 lines
7.9 KiB
TOML
# 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/"
|
|
baseURL = "https://example.com/"
|
|
|
|
# canonicalization will only be used for the sitemap.xml and index.xml files;
|
|
# if set to false, a site served from a subdirectory will generate wrong links
|
|
# inside of the above mentioned files; if you serve the page from the servers root
|
|
# you are free to set the value to false as recommended by the official Hugo documentation
|
|
canonifyURLs = true # true -> all relative URLs would instead be canonicalized using baseURL
|
|
# required value to serve this page from a webserver AND the file system;
|
|
# if you don't want to serve your page from the file system, you can also set this value
|
|
# to false
|
|
relativeURLs = true # true -> rewrite all relative URLs to be relative to the current content
|
|
# if you set uglyURLs to false, this theme will append 'index.html' to any branch bundle link
|
|
# so your page can be also served from the file system; if you don't want that,
|
|
# set disableExplicitIndexURLs=true in the [params] section
|
|
uglyURLs = false # true -> basic/index.html -> basic.html
|
|
|
|
# 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"
|
|
# make sure your defaultContentLanguage is the first one in the [Languages]
|
|
# array below, as the theme needs to make assumptions on it
|
|
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"
|
|
|
|
# We disable this for testing the exampleSite; 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
|
|
disableHugoGeneratorInject = true
|
|
|
|
[outputs]
|
|
# add JSON to the home to support Lunr search; This is a mandatory setting
|
|
# for the search functionality
|
|
# add PRINT to home, section and page to activate the feature to print whole
|
|
# chapters
|
|
home = ["HTML", "RSS", "PRINT", "SEARCH", "SEARCHPAGE"]
|
|
section = ["HTML", "RSS", "PRINT"]
|
|
page = ["HTML", "RSS", "PRINT"]
|
|
|
|
[markup]
|
|
[markup.highlight]
|
|
# if `guessSyntax = true`, there will be no unstyled code even if no language
|
|
# was given BUT Mermaid and Math codefences will not work anymore! So this is a
|
|
# mandatory setting for your site if you want to use Mermaid or Math codefences
|
|
guessSyntax = false
|
|
|
|
# here in this showcase we use our own modified chroma syntax highlightning style
|
|
# which is imported in theme-relearn-light.css / theme-relearn-dark.css;
|
|
# if you want to use a predefined style instead:
|
|
# - remove the following `noClasses`
|
|
# - set the following `style` to a predefined style name
|
|
# - remove the `@import` of the self-defined chroma stylesheet from your CSS files
|
|
# (here eg.: theme-relearn-light.css / theme-relearn-dark.css)
|
|
noClasses = false
|
|
# style = "tango"
|
|
|
|
[markup.goldmark.renderer]
|
|
# activated for this showcase to use HTML and JavaScript; decide on your own needs;
|
|
# if in doubt, remove this line
|
|
unsafe = true
|
|
|
|
# allows `hugo server` to display this showcase in IE11; this is used for testing, as we
|
|
# are still supporting IE11 - although with degraded experience; if you don't care about
|
|
# `hugo server` or browsers of ancient times, fell free to remove this whole block
|
|
[server]
|
|
[[server.headers]]
|
|
for = "**.html"
|
|
[server.headers.values]
|
|
X-UA-Compatible = "IE=edge"
|
|
|
|
# showcase of the menu shortcuts; you can use relative URLs linking
|
|
# to your content or use fully-quallified URLs to link outside of
|
|
# your project
|
|
[Languages]
|
|
[Languages.en]
|
|
title = "Hugo Relearn Theme"
|
|
weight = 1
|
|
languageName = "English"
|
|
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 = "more/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 = "more/credits/"
|
|
weight = 30
|
|
|
|
[[Languages.en.menu.shortcuts]]
|
|
name = "<i class='fas fa-fw fa-tags'></i> Tags"
|
|
url = "tags/"
|
|
weight = 40
|
|
|
|
# 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 FER PRRRODUCTION! ARRR!
|
|
|
|
[Languages.pir]
|
|
title = "Cap'n Hugo Relearrrn Theme"
|
|
weight = 2
|
|
languageName = "Arrr! ☠ Pirrrates ☠"
|
|
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 = "more/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 = "more/credits/"
|
|
weight = 30
|
|
|
|
[[Languages.pir.menu.shortcuts]]
|
|
name = "<i class='fas fa-fw fa-tags'></i> Arrr! Tags"
|
|
url = "tags/"
|
|
weight = 40
|
|
|
|
# mounts are only needed in this showcase to access the publicly available screenshots;
|
|
# remove this section if you don't need further mounts
|
|
[module]
|
|
[[module.mounts]]
|
|
source = 'archetypes'
|
|
target = 'archetypes'
|
|
[[module.mounts]]
|
|
source = 'assets'
|
|
target = 'assets'
|
|
[[module.mounts]]
|
|
source = 'content'
|
|
target = 'content'
|
|
[[module.mounts]]
|
|
source = 'data'
|
|
target = 'data'
|
|
[[module.mounts]]
|
|
source = 'i18n'
|
|
target = 'i18n'
|
|
[[module.mounts]]
|
|
source = '../images'
|
|
target = 'content/images'
|
|
[[module.mounts]]
|
|
source = 'layouts'
|
|
target = 'layouts'
|
|
[[module.mounts]]
|
|
source = 'static'
|
|
target = 'static'
|
|
|
|
# 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"
|
|
author = "Sören Weber"
|
|
showVisitedLinks = true
|
|
collapsibleMenu = true
|
|
disableBreadcrumb = false
|
|
disableInlineCopyToClipBoard = true
|
|
disableNextPrev = false
|
|
disableLandingPageButton = true
|
|
titleSeparator = "::"
|
|
themeVariant = [ "auto", "relearn-bright", "relearn-light", "relearn-dark", "learn", "neon", "blue", "green", "red" ]
|
|
themeVariantAuto = [ "relearn-light", "relearn-dark" ]
|
|
disableSeoHiddenPages = true
|
|
# this is to index search for your native language in other languages, too (eg.
|
|
# pir in this showcase)
|
|
additionalContentLanguage = [ "en" ]
|
|
# this is for the stylesheet generator to allow for interactivity in Mermaid
|
|
# graphs; you usually will not need it and you should remove this for
|
|
# security reasons
|
|
mermaidInitialize = "{ \"securityLevel\": \"loose\" }"
|
|
mermaidZoom = true
|