initial commit
This commit is contained in:
65
themes/hugo-theme-relearn/docs/config/_default/hugo.toml
Normal file
65
themes/hugo-theme-relearn/docs/config/_default/hugo.toml
Normal file
@@ -0,0 +1,65 @@
|
||||
# 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 to be set to `true` to serve this page from a webserver AND the file system;
|
||||
# if you set this value to `true`, `baseURL` must not contain a subdirectory;
|
||||
# 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 site-relative URLs (those with a leading slash) to be relative to the current content
|
||||
|
||||
# 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,
|
||||
# if st to `true`, adjusting the link is not necessary, so `disableExplicitIndexURLs` has
|
||||
# no effect
|
||||
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'
|
||||
|
||||
# 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']
|
||||
|
||||
# don't use any auto-generated summaries
|
||||
summaryLength = 10
|
||||
|
||||
# add showcase-specific output formats
|
||||
[outputs]
|
||||
# `print` - activate the themes feature to print whole chapters or leaf pages
|
||||
home = ['html', 'rss', 'print']
|
||||
section = ['html', 'rss', 'print']
|
||||
page = ['html', 'rss', 'print']
|
||||
|
||||
# add two showcase specific taxonomies for the parameter documentation;
|
||||
# the standard taxonomies must be repeated if they should be available
|
||||
# in such a case
|
||||
[taxonomies]
|
||||
category = 'categories'
|
||||
tag = 'tags'
|
||||
frontmatter = 'frontmatter'
|
||||
option = 'options'
|
||||
|
||||
# Showcase-specific non-standard theme parameter that should be not
|
||||
# contained in the defauzlt params.toml; delete it!
|
||||
[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
|
||||
# This is for support of the variantgenerator in the docs, you don't need this!
|
||||
variantgenerator.force = true
|
||||
|
||||
[params.relearn]
|
||||
[params.relearn.dependencies]
|
||||
# This is for support of the variantgenerator in the docs, you don't need this!
|
||||
[params.relearn.dependencies.variantgenerator]
|
||||
name = 'VariantGenerator'
|
||||
181
themes/hugo-theme-relearn/docs/config/_default/languages.toml
Normal file
181
themes/hugo-theme-relearn/docs/config/_default/languages.toml
Normal file
@@ -0,0 +1,181 @@
|
||||
# showcase of the menu shortcuts; you can use relative URLs linking
|
||||
# to your content or use fully-qualified URLs to link outside of
|
||||
# your project
|
||||
[en]
|
||||
title = 'Hugo Relearn Theme'
|
||||
weight = 1
|
||||
languageCode = 'en'
|
||||
languageName = 'English'
|
||||
# Language dependent settings:
|
||||
# Use case https://gohugo.io/content-management/multilingual/#translation-by-content-directory
|
||||
#contentDir = 'content/en'
|
||||
[en.params]
|
||||
landingPageName = '<i class="fa-fw fas fa-home"></i> Home'
|
||||
errorignore = ['exampleSite', 'images/hero.zip']
|
||||
|
||||
[[en.menu.shortcuts]]
|
||||
pre = '<i class="fa-fw fas fa-anchor"></i> '
|
||||
name = 'Example Site'
|
||||
url = 'exampleSite/about/index.html'
|
||||
weight = 1
|
||||
[[en.menu.shortcuts]]
|
||||
pre = '<i class="fa-fw fab fa-github"></i> '
|
||||
name = 'GitHub Repo'
|
||||
url = 'https://github.com/McShelby/hugo-theme-relearn'
|
||||
weight = 10
|
||||
[[en.menu.shortcuts]]
|
||||
name = 'Showcases'
|
||||
pageRef = '/showcase'
|
||||
weight = 20
|
||||
[[en.menu.shortcuts]]
|
||||
name = 'Credits'
|
||||
pageRef = '/more/credits'
|
||||
weight = 30
|
||||
[[en.menu.shortcuts]]
|
||||
pre = '<i class="fa-fw fas fa-tags"></i> '
|
||||
name = 'Tags'
|
||||
pageRef = '/tags'
|
||||
weight = 40
|
||||
[[en.menu.shortcuts]]
|
||||
pre = '<i class="fa-fw fas fa-layer-group"></i> '
|
||||
name = 'Categories'
|
||||
pageRef = '/categories'
|
||||
weight = 50
|
||||
|
||||
[[en.menu.devshortcuts]]
|
||||
identifier = 'devshortcuts'
|
||||
name = 'Dev Shortcuts'
|
||||
[[en.menu.devshortcuts]]
|
||||
parent = 'devshortcuts'
|
||||
pre = '<i class="fa-fw fab fa-hackerrank"></i> '
|
||||
name = 'Hugo'
|
||||
url = 'https://gohugo.io/documentation/'
|
||||
weight = 1
|
||||
[[en.menu.devshortcuts]]
|
||||
parent = 'devshortcuts'
|
||||
pre = '<i class="fa-fw fas fa-puzzle-piece"></i> '
|
||||
identifier = 'theme'
|
||||
name = 'Theme'
|
||||
weight = 2
|
||||
[[en.menu.devshortcuts.params]]
|
||||
alwaysopen = true
|
||||
[[en.menu.devshortcuts]]
|
||||
parent = 'theme'
|
||||
pre = '<i class="fa-fw fas fa-gears"></i> '
|
||||
identifier = 'configoptions'
|
||||
pageRef = 'configuration/reference'
|
||||
weight = 1
|
||||
[[en.menu.devshortcuts]]
|
||||
parent = 'theme'
|
||||
pre = '<i class="fa-fw fab fa-markdown"></i> '
|
||||
identifier = 'frontmatter'
|
||||
title = 'Front Matter Reference'
|
||||
pageRef = 'authoring/frontmatter/reference#annotated-front-matter'
|
||||
weight = 2
|
||||
[[en.menu.devshortcuts]]
|
||||
parent = 'theme'
|
||||
pre = '<i class="fa-fw fas fa-image"></i> '
|
||||
identifier = 'screenshotframe'
|
||||
title = 'Screenshot Frame'
|
||||
pageRef = 'images/hero.zip'
|
||||
weight = 3
|
||||
[[en.menu.devshortcuts]]
|
||||
parent = 'theme'
|
||||
pre = '<i class="fa-fw fas fa-wand-magic-sparkles"></i> '
|
||||
title = 'Maaagic Download'
|
||||
pageRef = 'images/magic.gif?download'
|
||||
weight = 4
|
||||
|
||||
# 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!
|
||||
|
||||
[pir]
|
||||
title = "Cap'n Hugo Relearrrn Theme"
|
||||
weight = 2
|
||||
# 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' # you can explicitly override the reading direction here, otherwise the translation file contains a default
|
||||
languageName = 'Arrr! ☠ Pirrratish ☠'
|
||||
# Language dependent settings:
|
||||
# Use case https://gohugo.io/content-management/multilingual/#translation-by-content-directory
|
||||
#contentDir = 'content/pir'
|
||||
[pir.params]
|
||||
landingPageName = '<i class="fa-fw fas home"></i> Arrr! Home'
|
||||
errorignore = ['exampleSite', 'images/hero.zip', '.*']
|
||||
|
||||
[[pir.menu.shortcuts]]
|
||||
pre = '<i class="fa-fw fas fa-anchor"></i> '
|
||||
name = 'Example Site'
|
||||
url = '../exampleSite/pir/about/index.html'
|
||||
weight = 1
|
||||
[[pir.menu.shortcuts]]
|
||||
pre = '<i class="fa-fw fab fa-github"></i> '
|
||||
name = 'GitHub Repo'
|
||||
url = 'https://github.com/McShelby/hugo-theme-relearn'
|
||||
weight = 10
|
||||
[[pir.menu.shortcuts]]
|
||||
pre = '<i class="fa-fw fas fa-camera"></i> '
|
||||
name = 'Showcases'
|
||||
pageRef = '/showcase'
|
||||
weight = 20
|
||||
[[pir.menu.shortcuts]]
|
||||
name = 'Crrredits'
|
||||
pageRef = '/more/credits'
|
||||
weight = 30
|
||||
[[pir.menu.shortcuts]]
|
||||
name = 'Arrr! Tags'
|
||||
pageRef = '/tags'
|
||||
weight = 40
|
||||
[[pir.menu.shortcuts]]
|
||||
pre = '<i class="fa-fw fas fa-layer-group"></i> '
|
||||
name = 'Categorrries'
|
||||
pageRef = '/categories'
|
||||
weight = 50
|
||||
|
||||
[[pir.menu.devshortcuts]]
|
||||
identifier = 'devshortcuts'
|
||||
name = 'Dev Shortcuts'
|
||||
[[pir.menu.devshortcuts]]
|
||||
parent = 'devshortcuts'
|
||||
pre = '<i class="fa-fw fab fa-hackerrank"></i> '
|
||||
name = "Cap'n Hugo"
|
||||
url = 'https://gohugo.io/documentation/'
|
||||
weight = 1
|
||||
[[pir.menu.devshortcuts]]
|
||||
parent = 'devshortcuts'
|
||||
pre = '<i class="fa-fw fas fa-puzzle-piece"></i> '
|
||||
identifier = 'theme'
|
||||
name = "Th' Theme"
|
||||
weight = 2
|
||||
[[pir.menu.devshortcuts.params]]
|
||||
alwaysopen = true
|
||||
[[pir.menu.devshortcuts]]
|
||||
parent = 'theme'
|
||||
pre = '<i class="fa-fw fas fa-gears"></i> '
|
||||
identifier = 'configoptions'
|
||||
pageRef = 'configuration/reference'
|
||||
weight = 1
|
||||
[[pir.menu.devshortcuts]]
|
||||
parent = 'theme'
|
||||
pre = '<i class="fa-fw fab fa-markdown"></i> '
|
||||
identifier = 'frontmatter'
|
||||
title = 'Front Matter Reference'
|
||||
pageRef = 'authoring/frontmatter/reference#annotated-front-matter'
|
||||
weight = 2
|
||||
[[pir.menu.devshortcuts]]
|
||||
parent = 'theme'
|
||||
pre = '<i class="fa-fw fas fa-image"></i> '
|
||||
identifier = 'screenshotframe'
|
||||
title = 'Screenshot Frame'
|
||||
pageRef = 'images/hero.zip'
|
||||
weight = 3
|
||||
[[pir.menu.devshortcuts]]
|
||||
parent = 'theme'
|
||||
pre = '<i class="fa-fw fas fa-wand-magic-sparkles"></i> '
|
||||
title = 'Maaagic Download'
|
||||
pageRef = 'images/magic.gif?download'
|
||||
weight = 4
|
||||
50
themes/hugo-theme-relearn/docs/config/_default/markup.toml
Normal file
50
themes/hugo-theme-relearn/docs/config/_default/markup.toml
Normal file
@@ -0,0 +1,50 @@
|
||||
[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
|
||||
|
||||
# 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
|
||||
noClasses = false
|
||||
# style = 'tango'
|
||||
|
||||
[goldmark]
|
||||
# this is required for the themes docs to make the piratify shortcode work
|
||||
duplicateResourceFiles = true
|
||||
|
||||
# activated for this showcase to use HTML and JavaScript; decide on your own needs;
|
||||
# if in doubt, remove this line
|
||||
renderer.unsafe = true
|
||||
|
||||
[goldmark.extensions]
|
||||
strikethrough = false
|
||||
|
||||
# use Markdown extensions for this showcase
|
||||
[goldmark.extensions.extras]
|
||||
[goldmark.extensions.extras.delete]
|
||||
enable = true
|
||||
[goldmark.extensions.extras.insert]
|
||||
enable = true
|
||||
[goldmark.extensions.extras.mark]
|
||||
enable = true
|
||||
[goldmark.extensions.extras.subscript]
|
||||
enable = true
|
||||
[goldmark.extensions.extras.superscript]
|
||||
enable = true
|
||||
|
||||
[goldmark.extensions.passthrough]
|
||||
enable = true
|
||||
[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 = [['\[', '\]'], ['$$', '$$']]
|
||||
50
themes/hugo-theme-relearn/docs/config/_default/module.toml
Normal file
50
themes/hugo-theme-relearn/docs/config/_default/module.toml
Normal file
@@ -0,0 +1,50 @@
|
||||
# mounts are only needed in this showcase to access the publicly available screenshots and CHANGELOG;
|
||||
# remove this section if you don't need further mounts
|
||||
[[mounts]]
|
||||
source = 'archetypes'
|
||||
target = 'archetypes'
|
||||
[[mounts]]
|
||||
source = 'assets'
|
||||
target = 'assets'
|
||||
# Language dependent settings:
|
||||
# Use case https://gohugo.io/content-management/multilingual/#translation-by-filename
|
||||
[[mounts]]
|
||||
source = 'content'
|
||||
target = 'content'
|
||||
# Use case https://gohugo.io/content-management/multilingual/#translation-by-content-directory
|
||||
#[[mounts]]
|
||||
# lang = 'en'
|
||||
# source = 'content/en'
|
||||
# target = 'content'
|
||||
#[[mounts]]
|
||||
# lang = 'pir'
|
||||
# source = 'content/pir'
|
||||
# target = 'content'
|
||||
[[mounts]]
|
||||
source = 'data'
|
||||
target = 'data'
|
||||
[[mounts]]
|
||||
source = 'i18n'
|
||||
target = 'i18n'
|
||||
[[mounts]]
|
||||
source = 'layouts'
|
||||
target = 'layouts'
|
||||
[[mounts]]
|
||||
source = 'static'
|
||||
target = 'static'
|
||||
# just for this documentation to expose our config in the docs
|
||||
[[mounts]]
|
||||
source = 'config'
|
||||
target = 'assets/config'
|
||||
# just for this documentation to expose the GitHub hero image in the docs
|
||||
[[mounts]]
|
||||
source = '../images'
|
||||
target = 'assets/images'
|
||||
# just for this documentation to expose the CHANGELOG.md in the docs
|
||||
[[mounts]]
|
||||
source = '../CHANGELOG.md'
|
||||
target = 'assets/CHANGELOG.md'
|
||||
# just for this documentation to expose the README.md in the docs
|
||||
[[mounts]]
|
||||
source = '../README.md'
|
||||
target = 'assets/README.md'
|
||||
625
themes/hugo-theme-relearn/docs/config/_default/params.toml
Normal file
625
themes/hugo-theme-relearn/docs/config/_default/params.toml
Normal file
@@ -0,0 +1,625 @@
|
||||
# Theme-specific options;
|
||||
# For a detailed explanation and many more options see
|
||||
# https://mcshelby.github.io/hugo-theme-relearn/configuration/reference/index.html#annotated-configuration-options
|
||||
|
||||
# If an option value is said to be not set, you can achieve the same behavior
|
||||
# by giving it an empty string value.
|
||||
|
||||
###############################################################################
|
||||
# Hugo
|
||||
# These options usually apply to other themes as well.
|
||||
|
||||
# The title to be used for links to the main page
|
||||
# Default: not set
|
||||
# This name will be used for the link to the main page in the upper section
|
||||
# of the menu. If not set, `title` from the Hugo settings will be used.
|
||||
linkTitle = 'Relearn'
|
||||
|
||||
# The author of your site.
|
||||
# Default: not set
|
||||
# This will be used in HTML meta tags, the opengraph protocol and twitter
|
||||
# cards.
|
||||
# You can also set `author.email` if you want to publish this information.
|
||||
author.name = 'Sören Weber'
|
||||
|
||||
# The social media image of your site.
|
||||
# Default: not set
|
||||
# This is used for generating social media meta information for the opengraph
|
||||
# protocol and twitter cards.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
images = [ 'images/hero.png' ]
|
||||
|
||||
# Admin options for social media.
|
||||
# Default: not set
|
||||
# Configuration for the Open Graph protocol and Twitter Cards adhere to Hugo's
|
||||
# implementation. See the Hugo docs for possible values.
|
||||
social.facebook_admin = ''
|
||||
social.twitter = ''
|
||||
|
||||
###############################################################################
|
||||
# Relearn Theme
|
||||
# These options are specific to the Relearn theme.
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Branding
|
||||
# These options set your overall visual appearance.
|
||||
|
||||
# Used color variants.
|
||||
# Default: 'auto'
|
||||
# This sets one or more color variants, available to your readers to choose
|
||||
# from. You can
|
||||
# - set a single value eg. 'zen-light'
|
||||
# - an array like [ 'neon', 'learn' ]
|
||||
# - an array with options like [ { identifier = 'neon' },{ identifier = 'learn' } ]
|
||||
# The last form allows to set further options for each variant.
|
||||
# The `identifier` is mandatory. You can also set `name` which overrides the
|
||||
# value displayed in the variant selector.
|
||||
# If the array has more than one entry, a variant selector
|
||||
# is shown in the lower part of the menu. The first entry in the array is the
|
||||
# default variant, used for first time visitors.
|
||||
# The theme ships with the following variants: 'relearn-bright',
|
||||
# 'relearn-light', 'relearn-dark', 'zen-light', 'zen-dark', 'neon', 'learn',
|
||||
# 'blue', 'green', 'red'. In addition you can use auto mode variants. See the
|
||||
# docs for a detailed explanation.
|
||||
# You can also define your own variants. See the docs how this works. Also,
|
||||
# the docs provide an interactive theme generator to help you with this task.
|
||||
themeVariant = [
|
||||
{ identifier = 'relearn-auto', name = 'Relearn Light/Dark', auto = [ 'relearn-light', 'relearn-dark' ] },
|
||||
{ identifier = 'relearn-dark' },
|
||||
{ identifier = 'relearn-light' },
|
||||
{ identifier = 'relearn-bright' },
|
||||
{ identifier = 'zen-auto', name = 'Zen Light/Dark', auto = [ 'zen-light', 'zen-dark' ] },
|
||||
{ identifier = 'zen-dark' },
|
||||
{ identifier = 'zen-light' },
|
||||
{ identifier = 'retro-auto', name = 'Retro Learn/Neon', auto = [ 'learn', 'neon' ] },
|
||||
{ identifier = 'neon' },
|
||||
{ identifier = 'learn' },
|
||||
{ identifier = 'blue' },
|
||||
{ identifier = 'green' },
|
||||
{ identifier = 'red' }
|
||||
]
|
||||
|
||||
# Minify theme assets.
|
||||
# Default: not set
|
||||
# If set to `true`, further theme asset files besides the generated HTML files
|
||||
# will be minified during build. If no value is set, the theme will avoid
|
||||
# minification if you have started with `hugo server` and otherwise will minify.
|
||||
minify = ""
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# General
|
||||
# These options are defining general, non visual behavior.
|
||||
|
||||
# Avoid new asset URLs on build.
|
||||
# Default: false
|
||||
# By default JavaScript-files and CSS-files get a unique ID on each rebuild.
|
||||
# This makes sure, the user always has the latest version and not some stale
|
||||
# copy of his browser cache. Anyways, it can be desireable to turn this
|
||||
# off in certain circumstances. For example if you have Hugo's dev server
|
||||
# running. Also some proxies dislike this optimization.
|
||||
disableAssetsBusting = false
|
||||
|
||||
# Avoid generator meta tags.
|
||||
# Default: false
|
||||
# Set this to true if you want to disable generation for generator meta tags
|
||||
# of Hugo and the theme in your HTML head. In this case also don't forget to
|
||||
# set Hugo's disableHugoGeneratorInject=true. Otherwise Hugo will generate a
|
||||
# meta tag into your home page anyways.
|
||||
disableGeneratorVersion = false
|
||||
|
||||
# Avoid unique IDs.
|
||||
# Default: false
|
||||
# In various situations the theme generates non stable unique ids to be used
|
||||
# in HTML fragment links. This can be undesirable for example when testing
|
||||
# the output for changes. If you disable the random id generation, the theme
|
||||
# may not function correctly anymore.
|
||||
disableRandomIds = false
|
||||
|
||||
# Conditionally ignore errorlevel settings
|
||||
# Default: []
|
||||
# The theme supports checking referenced address (e.g. with
|
||||
# link.errorlevel, image.errorlevel, etc. see below). Sometimes checks lead
|
||||
# to console output due to false negatives. You can turn off the checks
|
||||
# for individual referenced addresses by defining regular expressions here.
|
||||
# The referenced address will be checked against all regexes of this array.
|
||||
# If it matches at least one, no output will be written to the console.
|
||||
# This array can be expanded in the page's frontmatter.
|
||||
errorignore = []
|
||||
|
||||
# Additional code dependencies.
|
||||
# Default: See hugo.toml of the theme
|
||||
# The theme provides a mechanism to load further JavaScript and CSS
|
||||
# dependencies on demand only if they are needed. This comes in handy if you
|
||||
# want to add own shortcodes that depend on additional code to be loaded.
|
||||
# See the docs how this works.
|
||||
# [relearn.dependencies]
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Topbar
|
||||
# These options modify the topbar appearance.
|
||||
|
||||
# Hide the table of contents button.
|
||||
# Default: false
|
||||
# If the TOC button is hidden, also the keyboard shortcut is disabled.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
disableToc = false
|
||||
|
||||
# Hide the breadcrumbs.
|
||||
# Default: false
|
||||
# If the breadcrumbs are hidden, the title of the displayed page will still be
|
||||
# shown in the topbar.
|
||||
disableBreadcrumb = false
|
||||
|
||||
# Hide the Markdown button.
|
||||
# Default: false
|
||||
# This hides the Markdown button if you activated the Markdown output format.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
disableMarkdownButton = false
|
||||
|
||||
# Hide the Source button.
|
||||
# Default: false
|
||||
# This hides the Source button if you activated the Source output format.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
disableSourceButton = false
|
||||
|
||||
# Hide the Print button.
|
||||
# Default: false
|
||||
# This hides the print button if you activated the print output format.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
disablePrintButton = false
|
||||
|
||||
# Hide Next and Previous navigation buttons.
|
||||
# Default: false
|
||||
# If the navigation buttons are hidden, also the keyboard shortcuts are
|
||||
# disabled.
|
||||
disableNextPrev = false
|
||||
|
||||
# The URL prefix to edit a page.
|
||||
# Default: not set
|
||||
# If set, an edit button will be shown in the topbar. If the button is hidden,
|
||||
# also the keyboard shortcuts are disabled. The value can contain the macro
|
||||
# `${FilePath}` which will be replaced by the file path of your displayed page.
|
||||
# If no `${FilePath}` is given in the value, the value is treated as if the
|
||||
# `${FilePath}` was appended at the end of the value. This can be overridden
|
||||
# in the pages frontmatter. This is useful if you want to give the opportunity
|
||||
# for people to create merge request for your content.
|
||||
editURL = 'https://github.com/McShelby/hugo-theme-relearn/edit/main/docs/content/${FilePath}'
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Search
|
||||
# These options modify various aspects of the search functionality.
|
||||
|
||||
# Disable the search.
|
||||
# Default: false
|
||||
# If the search is disabled, no search box will be displayed in the menu,
|
||||
# nor in-page search, search popup or dedicated search page will be available.
|
||||
# This will also cause the keyboard shortcut to be disabled.
|
||||
disableSearch = false
|
||||
|
||||
# Disable the search index generation.
|
||||
# Default: false
|
||||
# `disableSearch=false` must be set to let the generation of the search index
|
||||
# file to be affected by this option. If the search index is disabled, no
|
||||
# search popup or dedicated search page will be available.
|
||||
disableSearchIndex = false
|
||||
|
||||
# URL of the search index file relative to the language home.
|
||||
# Default: 'searchindex.js'
|
||||
# You have to set this option if your page already has a content file named
|
||||
# `searchindex.js` in the language home.
|
||||
searchIndexURL = 'searchindex.js'
|
||||
|
||||
# Disable the dedicated search page.
|
||||
# Default: false
|
||||
# `disableSearch=false` and `disableSearchIndex=false` must be set to let the
|
||||
# generation of the dedicated search page to be affected by this option.
|
||||
disableSearchPage = false
|
||||
|
||||
# URL of the dedicated search page relative to the language home.
|
||||
# Default: 'search'
|
||||
# In its basic form the search page URL is named the same for all languages
|
||||
# but you are free to override it in each language options to localised the
|
||||
# URL. You also need to set this option if your page already has a content
|
||||
# page named `search`.
|
||||
searchPageURL = 'search'
|
||||
|
||||
# Multilanguage content.
|
||||
# Default: not set
|
||||
# If the search index is enabled and your pages contain further languages
|
||||
# besides the main one used, add all those auxiliary languages here. This
|
||||
# will create a search index with support for all used languages of your site.
|
||||
# This is handy for example if you are writing in Spanish but have lots of
|
||||
# source code on your page which typically uses English terminology.
|
||||
additionalContentLanguage = [ 'en' ]
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Menu
|
||||
# These options modify the menu appearance.
|
||||
|
||||
# Hide the Home entry.
|
||||
# Default: false
|
||||
# If shown, a Home button will appear below the search bar and the main menu.
|
||||
# It links to your the home page of the current language.
|
||||
disableLandingPageButton = true
|
||||
|
||||
# Hide the language switcher.
|
||||
# Default: false
|
||||
# If you have more than one language configured, a language switcher is
|
||||
# displayed in the lower part of the menu. This option lets you explicitly
|
||||
# turn this behavior off.
|
||||
disableLanguageSwitchingButton = false
|
||||
|
||||
# Shows checkmarks for visited pages of the main menu.
|
||||
# Default: false
|
||||
# This also causes the display of the `Clear History` entry in the lower part
|
||||
# of the menu to remove all checkmarks. The checkmarks will also been removed
|
||||
# if you regenerate your site as the ids are not stable.
|
||||
showVisitedLinks = true
|
||||
|
||||
# The order of main menu submenus.
|
||||
# Default: 'weight'
|
||||
# Submenus can be ordered by 'weight', 'title', 'linktitle', 'modifieddate',
|
||||
# 'expirydate', 'publishdate', 'date', 'length' or 'default' (adhering to
|
||||
# Hugo's default sort order). This can be overridden in the pages frontmatter.
|
||||
ordersectionsby = 'weight'
|
||||
|
||||
# The initial expand state of submenus.
|
||||
# Default: not set
|
||||
# This controls whether submenus will be expanded (true), or collapsed (false)
|
||||
# in the menu. If not set, the first menu level is set to false, all others
|
||||
# levels are set to true. This can be overridden in the page's frontmatter.
|
||||
# If the displayed page has submenus, they will always been displayed expanded
|
||||
# regardless of this option.
|
||||
alwaysopen = ''
|
||||
|
||||
# Shows expander for submenus.
|
||||
# Default: false
|
||||
# If set to true, a submenu in the sidebar will be displayed in a collapsible
|
||||
# tree view and a clickable expander is set in front of the entry.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
collapsibleMenu = true
|
||||
|
||||
# Hide heading above the shortcuts menu.
|
||||
# Default: false
|
||||
# If a sidebar menu with identifier `shortcuts` is configured (see below),
|
||||
# this is the easy way to remove the heading;
|
||||
# The title for the heading can be overwritten in your i18n files. See Hugo's
|
||||
# documentation how to do this.
|
||||
disableShortcutsTitle = false
|
||||
|
||||
# Define your own sidebar menus.
|
||||
# Default: the value used below
|
||||
# The sidebar menus are built from this parameter. If not set, it contains
|
||||
# the below default.
|
||||
# Menus are written from the sidebar's top to buttom in the order given in
|
||||
# this array.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
# Each entry can contain the following keys:
|
||||
# - `type` is mandatory. Either `page` in case it should generate a tre from
|
||||
# the page structure or `menu` in case it should generate a tree from a
|
||||
# defined menu.
|
||||
# - `identifier` is mandatory. In case of `type=page`, anything can be used,
|
||||
# in case of `type=menu` the `identifier` key must be identical to the
|
||||
# key of the menu definition.
|
||||
# - `main`, boolean. If `true`, the first tree level is spaced more generous
|
||||
# and the text is emphasized. Default: `true` for `type=page` and `false`
|
||||
# for `type=menu`
|
||||
# - `disableTitle`, boolean. If `true`, there is no title above the tree.
|
||||
# Default: `true` for `type=page` and `false` for `type=menu`. If a title
|
||||
# should be used, in case of `type=page` it will be taken from the page's
|
||||
# `menuTitle` front matter and if not set, from the translation files, using
|
||||
# the menu `identifier` as key. In case of `type=menu` it will be taken
|
||||
# from the menu `title` according to Hugo's documentation and if not set
|
||||
# from the menu `name` and if this is not set form the page's `linkTitle`.
|
||||
# - `pageRef`, optional. In case of `type=page` this is the starting page's
|
||||
# path. If not set, the home page will be used.
|
||||
sidebarmenus = [
|
||||
{ type = 'page', identifier = 'home', main = true, disableTitle = true, pageRef = '' },
|
||||
{ type = 'menu', identifier = 'shortcuts', main = false, disableTitle = false },
|
||||
]
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Hidden pages
|
||||
# These options configure how hidden pages are treated.
|
||||
# A page flagged as hidden, is only removed from the main menu if you are
|
||||
# currently not on this page or the hidden page is not part of current page's
|
||||
# ancestors. For all other functionality in Hugo a hidden page behaves like any
|
||||
# other page if not otherwise configured.
|
||||
|
||||
# Hide hidden pages from search.
|
||||
# Default: false
|
||||
# Hides hidden pages from the suggestions of the search box and the dedicated
|
||||
# search page.
|
||||
disableSearchHiddenPages = false
|
||||
|
||||
# Hide hidden pages for web crawlers.
|
||||
# Default: false
|
||||
# Avoids hidden pages from showing up in the sitemap and on Google (et all),
|
||||
# otherwise they may be indexed by search engines
|
||||
disableSeoHiddenPages = true
|
||||
|
||||
# Hide hidden pages for taxonomies.
|
||||
# Default: false
|
||||
# Hides hidden pages from showing up on the taxonomy and terms pages. If this
|
||||
# reduces term counters to zero, an empty but not linked term page will be
|
||||
# created anyhow.
|
||||
disableTagHiddenPages = false
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Content
|
||||
# These options modify how your content is displayed.
|
||||
|
||||
# Title separator.
|
||||
# Default: '::'
|
||||
# Changes the title separator used when concatenating the page title with the
|
||||
# site title. This is consistently used throughout the theme.
|
||||
titleSeparator = '::'
|
||||
|
||||
# Breadcrumb separator.
|
||||
# Default: '>'
|
||||
# Changes the breadcrumb separator used in the topbars breadcrumb area and for
|
||||
# search results and term pages.
|
||||
breadcrumbSeparator = '>'
|
||||
|
||||
# Hide the root breadcrumb.
|
||||
# Default: false
|
||||
# The root breadcrumb is usually the home page of your site. Because this is
|
||||
# always accessible by clicking on the logo, you may want to reduce clutter
|
||||
# by removing this from your breadcrumb.
|
||||
disableRootBreadcrumb = true
|
||||
|
||||
# Hide breadcrumbs term pages.
|
||||
# Default: false
|
||||
# If you have lots of taxonomy terms, the term pages may seem cluttered with
|
||||
# breadcrumbs to you, so this is the option to turn off breadcrumbs on term
|
||||
# pages. Only the page title will then be shown on the term pages.
|
||||
disableTermBreadcrumbs = false
|
||||
|
||||
# Disable copying heading links to clipboard
|
||||
# Default: false
|
||||
# If set to true, this disables the copying of anchor links to the clipboard;
|
||||
# if also `disableAnchorScrolling=true` then no anchor link will be visible
|
||||
# when hovering a heading.
|
||||
disableAnchorCopy = false
|
||||
|
||||
# Disable scrolling to heading link on click
|
||||
# Default: false
|
||||
# If set to true, this disables the scrolling to the beginning of the heading
|
||||
# when clicked; if also `disableAnchorCopy=true` then no anchor link will
|
||||
# be visible when hovering a heading.
|
||||
disableAnchorScrolling = false
|
||||
|
||||
# User-defined styles for shortcodes
|
||||
# Default: not set
|
||||
# Besides the predefined `style` values, you are able to define your own. The
|
||||
# `style` parameter of the shortcode must match the `identifier` defined here.
|
||||
# The title for the style will be determined from the `title`. If no `title`
|
||||
# but a `i18n` is set, the title will be taken from the translation files by
|
||||
# that key. The `title` may be empty in which case, the box does not contain a
|
||||
# default title. `icon` and `color` are working similar.
|
||||
boxStyle = [
|
||||
{ identifier = 'magic', i18n = '', title = 'Magic', icon = 'rainbow', color = 'gold' }
|
||||
]
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Highlight
|
||||
# These options configure how code is displayed.
|
||||
|
||||
# Hide copy-to-clipboard for inline code.
|
||||
# Default: false
|
||||
# This removes the copy-to-clipboard button from your inline code.
|
||||
disableInlineCopyToClipBoard = true
|
||||
|
||||
# Always show copy-to-clipboard for block code.
|
||||
# Default: false
|
||||
# The theme only shows the copy-to-clipboard button if you hover over the code
|
||||
# block. Set this to true to disable the hover effect and always show the
|
||||
# button.
|
||||
disableHoverBlockCopyToClipBoard = false
|
||||
|
||||
# Wrap for code blocks.
|
||||
# Default: true
|
||||
# By default lines of code blocks wrap around if the line is too long to be
|
||||
# displayed on screen. If you dislike this behavior, you can reconfigure it
|
||||
# here.
|
||||
# Note that lines always wrap in print mode regardless of this option.
|
||||
# This can be overridden in the page's frontmatter or given as a parameter to
|
||||
# individual code blocks.
|
||||
highlightWrap = true
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Include
|
||||
# These options configure how the include shortcode works.
|
||||
|
||||
# What to do when path is not resolved.
|
||||
# Default: ''
|
||||
# You can control what should happen if a path can not be resolved to as
|
||||
# a resource or via the file system. If not set, no output will be written
|
||||
# for the unresolved path. If set to `warning` the same happens and an additional
|
||||
# warning is printed. If set to `error` an error message is printed and the build
|
||||
# is aborted.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
include.errorlevel = 'warning'
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Images
|
||||
# These options configure how images are displayed.
|
||||
|
||||
# What to do when local image link is not resolved.
|
||||
# Default: ''
|
||||
# You can control what should happen if a local image can not be resolved to as
|
||||
# a resource. If not set, the unresolved link is written as given into the resulting
|
||||
# output. If set to `warning` the same happens and an additional warning is
|
||||
# printed. If set to `error` an error message is printed and the build is
|
||||
# aborted.
|
||||
# Please note that this can not resolve files inside of your `static` directory.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
image.errorlevel = 'warning'
|
||||
|
||||
# Image effects.
|
||||
# See the documentation for how you can even add your own arbitrary effects to
|
||||
# the list.
|
||||
# All effects can be overridden in the page's frontmatter or through URL parameter
|
||||
# given to the image. See the documentation for details.
|
||||
|
||||
# Default: false
|
||||
imageEffects.border = true
|
||||
# Default: false
|
||||
imageEffects.dataurl = false
|
||||
# Default: false
|
||||
imageEffects.inlinecontent = false
|
||||
# Default: true
|
||||
imageEffects.lazy = true
|
||||
# Default: true
|
||||
imageEffects.lightbox = true
|
||||
# Default: false
|
||||
imageEffects.shadow = false
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Links
|
||||
# These options configure how links are displayed.
|
||||
|
||||
# Wether to use Hugo's default relref shortcode implementation
|
||||
# Default: false
|
||||
# Since the theme provides a link render hook, the usage of the relref shortcode
|
||||
# is obsolete. If a site still uses that shortcode, it fails to generate a
|
||||
# correct links if the baseURL is configured with a subdirectory and relativeURLs=false.
|
||||
# The theme provides an overriden relref shortcode that also works in the
|
||||
# above setup but must manually be activated by setting this option to true.
|
||||
# See discussion in https://github.com/McShelby/hugo-theme-relearn/discussions/862
|
||||
disableDefaultRelref = false
|
||||
|
||||
# Generate link URLs the Hugo way.
|
||||
# Default: false
|
||||
# If set to true, the theme behaves like a standard Hugo installation and
|
||||
# appends no index.html to prettyURLs. As a trade off, your build project will
|
||||
# not be servable from the file system.
|
||||
disableExplicitIndexURLs = false
|
||||
|
||||
# How to open external links.
|
||||
# Default: '_blank'
|
||||
# For external links you can define how they are opened in your browser. All
|
||||
# values for the HTML `target` attribute of the `a` element are allowed. The
|
||||
# default value opens external links in a separate browser tab. If you want
|
||||
# to open those links in the same tab, use '_self'.
|
||||
# If you want to set the default behavior for all links, use link effects.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
externalLinkTarget = '_self'
|
||||
|
||||
# What to do when local page link is not resolved.
|
||||
# Default: ''
|
||||
# You can control what should happen if a local link can not be resolved to a
|
||||
# page. If not set, the unresolved link is written as given into the resulting
|
||||
# output. If set to `warning` the same happens and an additional warning is
|
||||
# printed. If set to `error` an error message is printed and the build is
|
||||
# aborted.
|
||||
# Please note that with Hugo < 0.123.0 + `uglyURLs=true` this can lead to false
|
||||
# negatives.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
link.errorlevel = 'warning'
|
||||
|
||||
# Link effects.
|
||||
# See the documentation for how you can even add your own arbitrary effects to
|
||||
# the list.
|
||||
# All effects can be overridden in the page's frontmatter or through URL parameter
|
||||
# given to the link. See the documentation for details.
|
||||
|
||||
# Default: false
|
||||
linkEffects.download = false
|
||||
# Default: false
|
||||
linkEffects.target = false
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# MathJax
|
||||
# These options configure how math formulae are displayed.
|
||||
|
||||
# Initialization options for MathJax.
|
||||
# Default: not set
|
||||
# A JSON value. See the MathJaxdocumentation for possible parameter.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
mathJaxInitialize = '{}'
|
||||
|
||||
# Force load Math on every page.
|
||||
# Default: false
|
||||
# If a, Math shortcode or codefence is found, the option will be ignored and
|
||||
# Math will be loaded regardlessly. This option is useful in case you
|
||||
# are using passthrough configuration to render your math. In this case no shortcode or
|
||||
# codefence is involved and the library is not loaded by default so you can
|
||||
# force loading it by setting `math=true`.
|
||||
# This option has an alias `math.force`.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
math = false
|
||||
|
||||
# URL for external MathJax library.
|
||||
# Default: not set
|
||||
# Specifies the remote location of the MathJax library. By default the shipped
|
||||
# version will be used.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
customMathJaxURL = '' # 'https://unpkg.com/mathjax/es5/tex-mml-chtml.js'
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Mermaid
|
||||
# These options configure how Mermaid graphs are displayed.
|
||||
|
||||
# Make graphs panable and zoomable
|
||||
# Default: false
|
||||
# For huge graphs it can be helpful to make them zoomable. Zoomable graphs come
|
||||
# with a reset button for the zoom.
|
||||
# This can be overridden in the page's frontmatter or given as a parameter to
|
||||
# individual graphs.
|
||||
mermaidZoom = true
|
||||
|
||||
# Initialization options for Mermaid.
|
||||
# Default: not set
|
||||
# A JSON value. See the Mermaid documentation for possible parameter.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
mermaidInitialize = '{ "securityLevel": "loose" }'
|
||||
|
||||
# Force load Mermaid on every page.
|
||||
# Default: false
|
||||
# If a Mermaid shortcode or codefence is found, the option will be ignored and
|
||||
# Mermaid will be loaded regardlessly. This option is useful in case you
|
||||
# are using scripting to render your graph. In this case no shortcode or
|
||||
# codefence is involved and the library is not loaded by default so you can
|
||||
# force loading it by setting `mermaid.force=true`.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
mermaid.force = false
|
||||
|
||||
# URL for external Mermaid library.
|
||||
# Default: not set
|
||||
# Specifies the remote location of the Mermaid library. By default the shipped
|
||||
# version will be used.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
customMermaidURL = '' # 'https://unpkg.com/mermaid/dist/mermaid.min.js'
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# OpenApi
|
||||
# These options configure how OpenAPI specifications are displayed.
|
||||
|
||||
# Force load OpenAPI on every page.
|
||||
# Default: false
|
||||
# If a, OpenAPI shortcode or codefence is found, the option will be ignored and
|
||||
# OpenAPI will be loaded regardlessly. This option is useful in case you
|
||||
# are using scripting to render your spec. In this case no shortcode or
|
||||
# codefence is involved and the library is not loaded by default so you can
|
||||
# force loading it by setting `openapi.force=true`.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
openapi.force = false
|
||||
|
||||
# URL for external OpenAPI library.
|
||||
# Default: not set
|
||||
# Specifies the remote location of the OpenAPI library. By default the shipped
|
||||
# version will be used.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
customOpenapiURL = '' # 'https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js'
|
||||
|
||||
# What to do when a local OpenAPI spec link is not resolved.
|
||||
# Default: ''
|
||||
# You can control what should happen if a local OpenAPI spec link can not be resolved
|
||||
# to a resource. If not set, the unresolved link is written as given into the resulting
|
||||
# output. If set to `warning` the same happens and an additional warning is
|
||||
# printed. If set to `error` an error message is printed and the build is
|
||||
# aborted.
|
||||
# Please note that this can not resolve files inside of your `static` directory.
|
||||
# This can be overridden in the page's frontmatter.
|
||||
openapi.errorlevel = 'warning'
|
||||
Reference in New Issue
Block a user