hugo-theme-relearn/exampleSite/config/_default/hugo.toml

245 lines
8.5 KiB
TOML
Raw Normal View History

2022-02-11 00:49:03 +00:00
# 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/'
# 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
2024-02-24 13:03:23 +00:00
relativeURLs = true # true -> rewrite all site-relative URLs (those with a leading slash) to be relative to the current content
2024-02-24 12:49:46 +00:00
# if you set uglyURLs to false, this theme will append 'index.html' to any page bundle link
# so your site can be also served from the file system; if you don't want that,
# set disableExplicitIndexURLs=true in the [params] section
2023-11-20 23:59:46 +00:00
uglyURLs = false # true -> basic/index.html -> basic.html
2022-02-11 00:49:03 +00:00
# the directory where Hugo reads the themes from; this is specific to your
# installation and most certainly needs be deleted or changed
themesdir = '../..'
2022-02-11 00:49:03 +00:00
# yeah, well, obviously a mandatory setting for your site, if you want to
# use this theme ;-)
theme = 'hugo-theme-relearn'
2022-02-11 00:49:03 +00:00
# make sure your defaultContentLanguage is the first one in the [languages]
# array below, as the theme needs to make assumptions on it
defaultContentLanguage = 'en'
2022-02-11 00:49:03 +00:00
# if you want to get rrrid o' ourrr pirrrates nonsense uncomment th' next line
# disableLanguages = ['pir']
2022-02-11 00:49:03 +00:00
# the site's title of this showcase; you should change this ;-)
title = 'Hugo Relearn Theme'
# Don't use any auto-generated summaries
summaryLength = 10
[outputs]
# add `print` to home, section and page to activate the feature to print whole
# chapters
home = ['html', 'rss', 'print']
section = ['html', 'rss', 'print']
page = ['html', 'rss', 'print']
[markup]
[markup.highlight]
# line numbers in a table layout will shift if code is wrapping, so better
# not use it; visually both layouts have the same look and behavior
lineNumbersInTable = false
2024-04-12 15:30:16 +00:00
# the shipped variants come with their own modified chroma syntax highlighting
# stylesheets which are linked in your generated HTML pages; you can use Hugo to generate
# own stylesheets to your liking and use them in your variant;
# if you want to use Hugo's internal styles instead of the shipped stylesheets:
# - remove `noClasses` or set `noClasses = true`
# - set `style` to a predefined style name
# note: with using the internal styles, the `--CODE-theme` setting in your variant
# stylesheet will be ignored and the internal style is used for all variants and
# even print
2022-02-10 23:59:40 +00:00
noClasses = false
# style = 'tango'
2022-02-10 23:59:40 +00:00
[markup.goldmark]
# this is required for the themes exampleSite to make the piratify shortcode work
duplicateResourceFiles = true
2022-02-10 23:59:40 +00:00
# activated for this showcase to use HTML and JavaScript; decide on your own needs;
# if in doubt, remove this line
renderer.unsafe = true
2022-02-10 23:59:40 +00:00
[markup.goldmark.extensions]
strikethrough = false
# use Markdown extensions for this showcase
[markup.goldmark.extensions.extras]
[markup.goldmark.extensions.extras.delete]
enable = true
[markup.goldmark.extensions.extras.insert]
enable = true
[markup.goldmark.extensions.extras.mark]
enable = true
[markup.goldmark.extensions.extras.subscript]
enable = true
[markup.goldmark.extensions.extras.superscript]
enable = true
[markup.goldmark.extensions.passthrough]
enable = true
[markup.goldmark.extensions.passthrough.delimiters]
# the settings chosen here match the default initialization
# of the MathJax library chosen by the theme;
# if you want to adjust to different values you also need
# to set them in `[params] mathJaxInitialize`
inline = [['\(', '\)'], ['$', '$']]
block = [['\[', '\]'], ['$$', '$$']]
2022-02-10 23:59:40 +00:00
# showcase of the menu shortcuts; you can use relative URLs linking
2024-04-12 15:30:16 +00:00
# to your content or use fully-qualified URLs to link outside of
2022-02-10 23:59:40 +00:00
# your project
[languages]
[languages.en]
title = 'Hugo Relearn Theme'
weight = 1
languageCode = 'en'
languageName = 'English'
2024-04-12 15:30:16 +00:00
# Language dependent settings:
# Use case https://gohugo.io/content-management/multilingual/#translation-by-content-directory
#contentDir = 'content/en'
[languages.en.params]
landingPageName = '<i class="fa-fw fas fa-home"></i> Home'
[[languages.en.menu.shortcuts]]
name = '<i class="fa-fw fab fa-github"></i> GitHub Repo'
identifier = 'ds'
url = 'https://github.com/McShelby/hugo-theme-relearn'
weight = 10
[[languages.en.menu.shortcuts]]
name = '<i class="fa-fw fas fa-camera"></i> Showcases'
pageRef = '/showcase'
weight = 20
[[languages.en.menu.shortcuts]]
name = '<i class="fa-fw fas fa-bullhorn"></i> Credits'
pageRef = '/more/credits'
weight = 30
[[languages.en.menu.shortcuts]]
name = '<i class="fa-fw fas fa-tags"></i> Tags'
pageRef = '/tags'
2021-10-24 09:53:09 +00:00
weight = 40
2023-10-29 23:20:37 +00:00
[[languages.en.menu.shortcuts]]
name = '<i class="fa-fw fas fa-layer-group"></i> Categories'
pageRef = '/categories'
2023-10-29 23:20:37 +00:00
weight = 50
2022-02-11 00:49:03 +00:00
# this is ourrr way t' showcase th' multilang settings by
2022-02-10 23:59:40 +00:00
# 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:
2022-07-02 12:01:24 +00:00
# NOT MEANT FER PRRRODUCTION! ARRR!
2022-02-11 00:49:03 +00:00
[languages.pir]
title = "Cap'n Hugo Relearrrn Theme"
weight = 2
2024-04-30 20:08:04 +00:00
# It would be more standard compliant to have the language key also
# named art-x-pir but that would require to rename all files
languageCode = 'art-x-pir'
languageDirection = 'rtl'
languageName = 'Arrr! ☠ Pirrratish ☠'
2024-04-12 15:30:16 +00:00
# Language dependent settings:
# Use case https://gohugo.io/content-management/multilingual/#translation-by-content-directory
#contentDir = 'content/pir'
[languages.pir.params]
landingPageName = '<i class="fa-fw fas home"></i> Arrr! Home'
[[languages.pir.menu.shortcuts]]
name = '<i class="fa-fw fab fa-github"></i> GitHub Repo'
identifier = 'ds'
url = 'https://github.com/McShelby/hugo-theme-relearn'
weight = 10
[[languages.pir.menu.shortcuts]]
name = '<i class="fa-fw fas fa-camera"></i> Showcases'
pageRef = '/showcase'
weight = 20
[[languages.pir.menu.shortcuts]]
name = '<i class="fa-fw fas fa-bullhorn"></i> Crrredits'
pageRef = '/more/credits'
weight = 30
2021-10-24 09:53:09 +00:00
[[languages.pir.menu.shortcuts]]
name = '<i class="fa-fw fas fa-tags"></i> Arrr! Tags'
pageRef = '/tags'
2021-10-24 09:53:09 +00:00
weight = 40
2023-10-29 23:20:37 +00:00
[[languages.pir.menu.shortcuts]]
name = '<i class="fa-fw fas fa-layer-group"></i> Categorrries'
pageRef = '/categories'
2023-10-29 23:20:37 +00:00
weight = 50
2024-04-19 15:58:38 +00:00
# mounts are only needed in this showcase to access the publicly available screenshots and CHANGELOG;
2023-01-24 22:58:16 +00:00
# remove this section if you don't need further mounts
[module]
[[module.mounts]]
source = 'archetypes'
target = 'archetypes'
[[module.mounts]]
source = 'assets'
target = 'assets'
2024-04-12 15:30:16 +00:00
# Language dependent settings:
# Use case https://gohugo.io/content-management/multilingual/#translation-by-filename
2023-01-24 22:58:16 +00:00
[[module.mounts]]
source = 'content'
target = 'content'
# Use case https://gohugo.io/content-management/multilingual/#translation-by-content-directory
#[[module.mounts]]
# lang = 'en'
# source = 'content/en'
# target = 'content'
#[[module.mounts]]
# lang = 'pir'
# source = 'content/pir'
# target = 'content'
2023-01-24 22:58:16 +00:00
[[module.mounts]]
source = 'data'
target = 'data'
[[module.mounts]]
source = 'i18n'
target = 'i18n'
[[module.mounts]]
source = 'layouts'
target = 'layouts'
[[module.mounts]]
source = 'static'
target = 'static'
# just for this documentation to expose our config in the docs
[[module.mounts]]
source = 'config'
target = 'assets/config'
# just for this documentation to expose the GitHub hero image in the docs
[[module.mounts]]
source = '../images'
target = 'assets/images'
2024-04-19 15:58:38 +00:00
# just for this documentation to expose the CHANGELOG.md in the docs
[[module.mounts]]
source = '../CHANGELOG.md'
target = 'assets/CHANGELOG.md'
2024-04-23 22:24:35 +00:00
# just for this documentation to expose the README.md in the docs
[[module.mounts]]
source = '../README.md'
target = 'assets/README.md'
2023-01-24 22:58:16 +00:00
[taxonomies]
category = 'categories'
tag = 'tags'
frontmatter = 'frontmatter'
option = 'options'
[params]
# Demo setting for displaying the siteparam shortcode the docs.
siteparam.test.text = 'A **nested** option <b>with</b> formatting'
# Extension to the image effects only for the docs.
imageEffects.bg-white = true