Options Reference

params:
  math: true

params:
  alwaysopen: ''
  author:
    emailname: ''
    name: Sören Weber
  boxStyle:
  - ay'con: fa-fw fab fa-hackerrank
    identifier: hugo
    style: magenta
  - identifier: breaking
    style: warning
    title: ' '
  - identifier: change
    style: note
    title: ' '
  - ay'con: plus-circle
    identifier: new
    style: info
    title: ' '
  - ay'con: gears
    identifier: option
    style: green
  - ay'con: fa-fw fab fa-markdown
    identifier: frontmatter
    style: yellow
  - ay'con: bars
    identifier: hugomenu
    style: magenta
  - color: darkgray
    ay'con: fa-fw fab fa-github
    identifier: gfm
  - color: rgb(136, 140, 196)
    ay'con: fa-fw fab fa-php
    identifier: php
  - color: darkorange
    ay'con: lightbulb
    identifier: pants
  - color: rgb(124, 58, 237)
    ay'con: fa-fw far fa-gem
    identifier: obsidian
  - color: rgb(66, 185, 131)
    ay'con: fa-fw fas fa-display
    identifier: mpe
  - color: orangered
    ay'con: fa-fw fas fa-code
    identifier: html
  - color: rgb(125, 201, 3)
    ay'con: fa-fw fas fa-puzzle-piece
    identifier: relearn
  - ay'con: eye
    identifier: example
    style: code
    title: Result
  - color: violet
    i18n: ''
    ay'con: hand-sparkles
    identifier: magic
    title: Magic
  breadcrumbSeparator: '>'
  collapsibleMenu: true
  dateFormat: :date_medium
  disableAnchorCopy: false
  disableAnchorScroll'n: false
  disableAssetsBust'n: false
  disableBreadcrumb: false
  disableDefaultRelref: false
  disableExplicitIndexURLs: false
  disableGeneratorVersion: false
  disableHoverBlockCopyToClipBoard: false
  disableInlineCopyToClipBoard: true
  disableLandingPageButton: true
  disableLanguageSwitchingButton: false
  disableMarkdownButton: false
  disableNextPrev: false
  disablePrintButton: false
  disableRandomIds: false
  disableRootBreadcrumb: true
  disableSearchHiddenPages: false
  disableSeoHiddenPages: true
  disableShortcutsTitle: false
  disableSourceButton: false
  disableTagHiddenPages: false
  disableTermBreadcrumbs: false
  disableToc: false
  disableVersioningWarn'n: false
  editURL: vscode://file/${BaseDir}/${FilePath}
  enableSubresourceIntegrity: false
  externalLinkTarget: _self
  hideAuthorDate: false
  hideAuthorEmail: false
  hideAuthorName: false
  highlightWrap: true
  image:
    errorlevel: warning
  imageEffects:
    border: true
    dataurl: false
    height: ''
    inlinecontent: false
    lazy: true
    lightbox: true
    rounded: true
    shadow: false
    width: ''
  images:
  - images/hero.png
  include:
    errorlevel: warning
  link:
    errorlevel: warning
    underline: false
  linkEffects:
    download: false
    target: false
  linkTitle: Relearrrn
  logo:
    layout: sidebar-row
    src: /images/logo.svg?inlinecontent
  math:
    force: false
    toMath:
      output: mathml
  mermaid:
    force: false
  mermaidInitialize: '{ "securityLevel": "loose" }'
  mermaidZoom: true
  minify: ''
  openapi:
    errorlevel: warning
    force: false
  ordersectionsby: weight
  search:
    adapter:
      identifier: ''
      params:
        additionalContentLanguage:
        - en
    dis'ble: ''
    index:
      URL: ''
      dis'ble: ''
      json: true
      template: ''
    plank:
      URL: ''
      dis'ble: ''
      outputs: ''
      type: ''
  showVisitedLinks: true
  sidebarfootermenus: ''
  sidebarheadermenus: ''
  sidebarmenus: ''
  table:
    sortable: false
  themeVariant:
  - name: Relearrrn
    type: divider
  - auto:
    - relearn-light
    - relearn-dark
    identifier: relearn-auto
    name: Relearrrn Light/Dark
  - identifier: relearn-dark
  - identifier: relearn-light
  - name: Zen
    type: divider
  - auto:
    - zen-light
    - zen-dark
    identifier: zen-auto
    name: Zen Light/Dark
  - identifier: zen-dark
  - identifier: zen-light
  - name: Contrast
    type: divider
  - auto:
    - contrast-light
    - contrast-dark
    identifier: contrast-auto
    name: Contrast Light/Dark
  - identifier: contrast-dark
  - identifier: contrast-light
  - name: Tome
    type: divider
  - auto:
    - tome-light
    - tome-dark
    identifier: tome-auto
    name: Tome Light/Dark
  - identifier: tome-dark
    print: tome-light
  - identifier: tome-light
    print: tome-light
  - name: Retro
    type: divider
  - auto:
    - learn
    - neon
    identifier: retro-auto
    name: Retro Learn/Neon
  - identifier: neon
    params:
      logo:
        src: /images/magic.gif
  - identifier: learn
  - name: Colors
    type: divider
  - identifier: blue
  - identifier: green
  - identifier: red
  titleSeparator: '::'
  topbarend:
  - type: prevbutton
  - type: nextbutton
  - type: morebutton
  topbarmiddle: ''
  topbarmore:
  - titleonwidthl: show
    titleonwidthm: show
    type: editbutton
  - titleonwidthl: show
    titleonwidthm: show
    type: sourcebutton
  - titleonwidthl: show
    titleonwidthm: show
    type: markdownbutton
  - titleonwidthl: show
    titleonwidthm: show
    type: printbutton
  topbarstart: ''
  urlExternalCheck: true
  urlIgnoreCheck:
  - exampleSite
  - 'images/hero\.zip'
  - http://localhost:1313
  - vscode://
  - 'https://github\.com/McShelby/hugo-theme-relearn/settings'
  - 'https://github\.com/McShelby/hugo-theme-relearn/archive/main\.zip'
  - 'https://github\.com/McShelby/hugo-theme-relearn/edit/main/docs/introduction/releasenotes'

params:
  # Theme-specific options;
  # For a detailed explanat'n an' many more options see
  # https://mcshelby.github.io/hugo-theme-relearn/configuration/reference/index.html#annotated-configuration-options

  # If an option value be said t' be not set, ye can achieve th' same behavior
  # by giv'n it an empty str'n value.

  ###############################################################################
  # Cap'n Hugo
  # These options usually apply t' other themes as well.

  # Th' author o' yer ship.
  # Default: not set
  # This will be used 'n HTML meta tags, th' open graph protocol an' twitter
  # cards.
  author:
    name: Sören Weber

    # Th' author's email address o' yer ship.
    # Default: not set
    # This will be used 'n HTML meta tags, th' open graph protocol an' twitter
    # cards.
    emailname: ''

  # Th' social media image o' yer ship.
  # Default: not set
  # This be used fer generat'n social media meta informat'n fer th' opengraph
  # protocol an' twitter cards.
  # This can be overridden 'n th' page's frontmatter.
  images:
    - images/hero.png

  ###############################################################################
  # Relearrrn Theme
  # These options be specific t' th' Relearrrn theme.

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # Brand'n
  # These options set yer overall visual appearance.

  # Th' title t' be used fer links 'n th' upper left corner
  # Default: not set
  # This name will be used fer th' link t' th' main plank 'n th' upper section
  # o' th' menu. If not set, `title` from th' Cap'n Hugo sett'ns will be used.
  # If th' title be t' long t' fit on a single line it be automatically wrapped.
  # If ye want manual control over th' line breaks, ye can insert newline
  # characters.
  linkTitle: Relearrrn

  # Th' title logo t' be used 'n th' upper left corner
  # Default: not set
  # If th' value be not set or empty, th' theme searches fer a global resource
  # `/images/logo.<TYPE>`. Sett'n th' `src` sub-field will override th'
  # default logo (see logo parameter). If `src` be set t' str'n contain'n all
  # whitespace, no logo will be displayed fer that variant regardless o' th'
  # default logo. A logo will only be printed if ye haven't overwritten
  # layouts/partials/logo.html.
  # If ye als print a `linkTitle` ye can set th' `layout` sub-field t' either
  # `sidebar-row` or `sidebar-column` t' arrange logo an' title accordingly.
  logo:
    src: /images/logo.svg?inlinecontent
    layout: sidebar-row

  # Used color variants.
  # Default: 'auto'
  # This sets one or more color variants, avail'ble t' yer readers t' choose
  # from. Ye can
  # - set a single value eg. 'zen-light'
  # - an array like [ 'neon', 'learn' ]
  # - an array wit' options like [ { identifier: neon }, { identifier: learn } ]
  # Th' last form allows t' set further options fer each variant.
  # Th' `identifier` be mandatory. Ye can also set `name` which overrides th'
  # value displayed 'n th' variant selector.
  # Sett'n `params` overrides some o' th' site's params while th' variant be
  # active. Sett'n its `logo` field an' th' `src` sub-field will override th'
  # default logo (see logo parameter). If `src` be set t' str'n contain'n all
  # whitespace, no logo will be displayed fer that variant regardless o' th'
  # default logo. A logo will only be printed if ye haven't overwritten
  # layouts/partials/logo.html.
  # If th' array has more than one entry, a variant selector
  # be shown 'n th' lower part o' th' menu. Th' first entry 'n th' array be th'
  # default variant, used fer first time visitors. An entry
  # `{ type: divider }` instead o' a variant draws a line between th' entries
  # o' th' variant selector. Wit' a `name` set, it labels th' group follow'n it
  # instead.
  # Th' theme ships wit' th' follow'n variants:
  # 'relearn-light', 'relearn-dark', 'zen-light', 'zen-dark', 'contrast-light',
  # 'contrast-dark', 'tome-light', 'tome-dark', 'neon', 'learn',
  # 'blue', 'green', 'red'. In addit'n ye can use auto mode variants. See th'
  # docs fer a detailed explanat'n.
  # Ye can also define yer own variants. See th' docs how this works. Also,
  # th' docs provide an interactive theme generator t' help ye wit' this task.
  themeVariant:
    - type: divider
      name: Relearrrn
    - identifier: relearn-auto
      name: Relearrrn Light/Dark
      auto:
        - relearn-light
        - relearn-dark
    - identifier: relearn-dark
    - identifier: relearn-light
    - type: divider
      name: Zen
    - identifier: zen-auto
      name: Zen Light/Dark
      auto:
        - zen-light
        - zen-dark
    - identifier: zen-dark
    - identifier: zen-light
    - type: divider
      name: Contrast
    - identifier: contrast-auto
      name: Contrast Light/Dark
      auto:
        - contrast-light
        - contrast-dark
    - identifier: contrast-dark
    - identifier: contrast-light
    - type: divider
      name: Tome
    - identifier: tome-auto
      name: Tome Light/Dark
      auto:
        - tome-light
        - tome-dark
    - identifier: tome-dark
      print: tome-light
    - identifier: tome-light
      print: tome-light
    - type: divider
      name: Retro
    - identifier: retro-auto
      name: Retro Learn/Neon
      auto:
        - learn
        - neon
    - identifier: neon
      params:
        logo:
          src: /images/magic.gif
    - identifier: learn
    - type: divider
      name: Colors
    - identifier: blue
    - identifier: green
    - identifier: red

  # Minify theme assets.
  # Default: not set
  # If set t' `true`, further theme asset files besides th' generated HTML files
  # will be minified dur'n build. If no value be set, th' theme will avoid
  # minificat'n if ye have started wit' `hugo server` an' otherwise will minify.
  minify: ''

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # General
  # These options be defin'n general, non visual behavior.

  # Avoid new asset URLs on build.
  # Default: false
  # By default JavaScript-files an' CSS-files get a unique ID on each rebuild.
  # This makes sure, th' user always has th' latest version an' not some stale
  # copy o' his browser cache. Anyways, it can be desire'ble t' turn this
  # off 'n certain circumstances. For example if ye have Hugo's dev server
  # runn'n. Also some proxies dislike this optimizat'n.
  disableAssetsBust'n: false

  # Avoid generator meta tags.
  # Default: false
  # Set this t' true if ye want t' dis'ble generat'n fer generator meta tags o'
  # Cap'n Hugo an' th' theme 'n yer HTML head. In this case also don't forget t' set
  # Hugo's `disableHugoGeneratorInject` t' `true`. Otherwise Cap'n Hugo will generate a
  # meta tag into yer home plank anyways.
  disableGeneratorVersion: false

  # Avoid unique IDs.
  # Default: false
  # In various situat'ns th' theme generates non stable unique ids t' be used
  # 'n HTML fragment links. This can be undesir'ble fer example when test'n
  # th' output fer changes. If ye dis'ble th' random id generat'n, th' theme
  # may not funct'n correctly anymore.
  disableRandomIds: false

  # Check th' theme's scripts an' stylesheets fer tamper'n.
  # Default: false
  # Adds a subresource integrity hash t' each script an' stylesheet th' theme
  # links, so a browser refuses a file that changed after th' build. A browser
  # can not check such a hash fer a plank opened from th' file system an' refuses
  # th' file instead, so leave this off if yer ship must work that way.
  enableSubresourceIntegrity: false

  # Conditionally ignore errorlevel sett'ns
  # Default: []
  # Th' theme supports check'n referenced address (e.g. wit'
  # link.errorlevel, image.errorlevel, etc. see below). Sometimes checks lead
  # t' console output due t' false negatives. Ye can turn off th' checks
  # fer individual referenced addresses by defin'n regular expressions here.
  # Th' referenced address will be checked against all regexes o' this array.
  # If it matches at least one, no output will be written t' th' console.
  # This array can be expanded 'n th' page's frontmatter.
  urlIgnoreCheck:
    - exampleSite
    - images/hero\.zip
    - http://localhost:1313
    - vscode://
    - https://github\.com/McShelby/hugo-theme-relearn/sett'ns
    - https://github\.com/McShelby/hugo-theme-relearn/archive/main\.zip
    - https://github\.com/McShelby/hugo-theme-relearn/edit/main/docs/introduction/releasenotes

  # Check external URLs
  # Default: false
  # If `true` th' theme checks dur'n build if an external URL be reach'ble.
  # If it fails, it write errors accord'n t' th' errorlevel sett'ns. A check
  # be omitted if th' URL be found 'n th' `urlIgnoreCheck` list.
  # This can be overridden 'n th' page's frontmatter.
  urlExternalCheck: true

  # Additional code dependencies.
  # Default: See hugo.yaml o' th' theme
  # Th' theme provides a mechanism t' board further JavaScript an' CSS
  # dependencies on demand only if they be needed. This comes 'n handy if ye
  # want t' add own shorrrtcodes that depend on additional code t' be boarded.
  # See th' docs how this works.
  # relearn:
  #   dependencies:

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # Version'n
  # These options control version'n o' yer ship. Th' versions themselves be
  # configured wit' Hugo's `versions` option.

  # Hide deprecated version warning
  # Default: false
  # If ye want t' hide th' deprecat'n warning, vis'ble on all planks that t' not
  # belong t' th' default version o' th' ship, set this t' `true`.
  disableVersioningWarn'n: false

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # Topbar
  # These options modify th' topbar appearance.

  # Hide th' table o' contents button.
  # Default: false
  # If th' TOC button be hidden, also th' keyboard shortcut be disabled.
  # This can be overridden 'n th' page's frontmatter.
  disableToc: false

  # Hide th' breadcrumbs.
  # Default: false
  # If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be
  # shown 'n th' topbar.
  disableBreadcrumb: false

  # Hide th' Marrrkdown button.
  # Default: false
  # This hides th' Marrrkdown button if ye activated th' Marrrkdown output format.
  # This can be overridden 'n th' page's frontmatter.
  disableMarkdownButton: false

  # Hide th' Source button.
  # Default: false
  # This hides th' Source button if ye activated th' Source output format.
  # This can be overridden 'n th' page's frontmatter.
  disableSourceButton: false

  # Hide th' Print button.
  # Default: false
  # This hides th' print button if ye activated th' print output format.
  # This can be overridden 'n th' page's frontmatter.
  disablePrintButton: false

  # Hide Next an' Previous navigat'n buttons.
  # Default: false
  # If th' navigat'n buttons be hidden, also th' keyboard shortcuts be
  # disabled.
  disableNextPrev: false

  # Th' URL prefix t' edit a plank.
  # Default: not set
  # If set, an edit button will be shown 'n th' topbar. If th' button be hidden,
  # also th' keyboard shortcuts be disabled. Th' value can contain th' macro
  # `${FilePath}` which will be replaced by th' file path o' yer displayed plank.
  # If no `${FilePath}` be given 'n th' value, th' value be treated as if th'
  # `${FilePath}` was appended at th' end o' th' value. Th' value can also
  # contain th' macro `${BaseDir}` which will be replaced by th' directory
  # `${FilePath}` be resolved against dur'n build, written wit' forward slashes
  # an' without a lead'n slash; joined wit' `${FilePath}` this be th' locat'n
  # o' th' plank on yer disk, which lets ye open it 'n a local editor, e.g.
  # `vscode://file/${BaseDir}/${FilePath}`. This can be overridden
  # 'n th' planks frontmatter. This be useful if ye want t' give th' opportunity
  # fer people t' create merge request fer yer rrrambl'n.
  editURL: vscode://file/${BaseDir}/${FilePath}

  # Define yer own topbar elements.
  # Elements be written from th' area's start t' end 'n th' order given 'n
  # these arrays.
  # This can be overridden 'n th' page's frontmatter.
  # Each entry can contain th' follow'n keys:
  # - `type` be mandatory. Th' type o' th' element, either one o' th' theme's
  #    predefined elements `sidebarbutton`, `tocbutton`, `breadcrumbs`,
  #    `editbutton`, `sourcebutton`, `markdownbutton`, `printbutton`,
  #    `prevbutton`, `nextbutton` an' `morebutton` or th' name o' yer own
  #    element template 'n `layouts/partials/topbar/element`.
  # - `onwidths`, `onwidthm`, `onwidthl`, optional. What t' do wit' th' element
  #    'n th' small (mobile), medium an' large layout: `show`, `hide` or
  #    `area-<NAME>` t' move it into another area. Default: depend'n on th'
  #    element.
  # - `titleonwidths`, `titleonwidthm`, `titleonwidthl`, optional. Whether th'
  #    title o' a button be displayed next t' its ay'con 'n th' small (mobile),
  #    medium an' large layout, wherever th' button be: `show` or `hide`.
  #    Default: `hide` fer th' theme's elements.
  # - `onempty`, optional. For buttons wit' an overlay, what t' do if th'
  #    overlay be empty: `disable` or `hide`. Default: depend'n on th' element.
  # Th' area o' yer own area button be filled by th' option `topbar<AREA>`,
  # like th' more area be filled by `topbarmore`.

  # Th' elements o' th' topbar's start area.
  # Default: see notes
  # - th' sidebar button 'n mobile layout
  # - th' table o' contents button
  topbarstart: ''

  # Th' elements o' th' topbar's middle area.
  # Default: see notes
  # - th' breadcrumb or th' plank title if th' breadcrumb be disabled
  topbarmiddle: ''

  # Th' elements o' th' topbar's end area.
  # Default: see notes
  # - th' edit, source, markdown an' print buttons if configured
  # - th' previous an' next buttons
  # - th' more button show'n th' more area
  topbarend:
    - type: prevbutton
    - type: nextbutton
    - type: morebutton

  # Th' elements o' th' topbar's more area.
  # Default: empty
  # Other elements may still move into this area depend'n on th' screen width.
  topbarmore:
    - type: editbutton
      titleonwidthm: show
      titleonwidthl: show
    - type: sourcebutton
      titleonwidthm: show
      titleonwidthl: show
    - type: markdownbutton
      titleonwidthm: show
      titleonwidthl: show
    - type: printbutton
      titleonwidthm: show
      titleonwidthl: show

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # Search
  # These options modify various aspects o' th' search functionality.

  # Dis'ble th' search.
  # Default: false
  # If th' search be disabled, no search box will be displayed 'n th' menu,
  # nor in-page search, search popup or dedicated search plank will be avail'ble.
  # This will also cause th' keyboard shortcut t' be disabled.
  search:
    dis'ble: ''

    # Dis'ble th' search index generat'n.
    # Default: false
    # If th' search index be disabled, no search popup or dedicated search
    # plank will be avail'ble.
    index:
      dis'ble: ''

      # URL o' th' search index file relative t' th' language home.
      # Default: 'searchindex.js'
      # Ye have t' set this option if yer plank already has a rrrambl'n file named
      # `searchindex.js` 'n th' language home. Otherwise ignore it or leave empty
      # t' let th' default apply.
      URL: ''

      # Template fer creat'n o' th' search index.
      # Default: '/_relearn_searchindex.json'
      # Ye can switch th' template fer generat'n th' index by sett'n this
      # parameter t' a differnt rrrambl'n view. If not set,
      # `/_relearn_searchindex.json` be used. Th' template must have an
      # implementat'n 'n `assets/[YOUR-INDEXTEMPLATE]` an' return th' index
      # as JSON.
      template: ''

      # Publish th' search index as JSON.
      # Default: false
      # Besides th' search index used by th' search popup, a plain JSON file
      # o' th' same data be written. Its URL be th' one o' th' search index
      # wit' th' extension `.json`, fer example `searchindex.en.json`.
      json: true

    # Dis'ble th' dedicated search plank.
    # Default: false
    # Search an' search index must be enabled t' let th'
    # generat'n o' th' dedicated search plank t' be affected by this option.
    plank:
      dis'ble: ''

      # URL o' th' dedicated search plank relative t' th' language home.
      # Default: 'search'
      # In its default form th' search plank URL be named th' same fer all
      # languages but ye be free t' override it 'n each language options t'
      # localise th' URL. Ye also need t' set this option if yer ship already
      # has a rrrambl'n plank named `search`.
      URL: ''

      # Rrrambl'n view fer dedicated search plank.
      # Default: '_relearn_searchpage'
      # Ye can switch th' layout o' th' dedicated search plank by sett'n this
      # parameter t' a differnt rrrambl'n view. If not set, `_relearn_searchpage` be
      # used. Th' rrrambl'n view must have an implementat'n 'n
      # `layouts/[YOUR-VIEWNAME]/article.html`.
      type: ''

      # Output formats o' th' dedicated search plank.
      # Default: see notes
      # Th' same as th' `outputs` front matter o' a plank. If not set, th' search
      # plank be written as `html` an' can be printed if yer home plank has th'
      # `print` output format. Set it t' `[ 'html' ]` t' never offer print'n th'
      # search results, or t' `[ 'html', 'print' ]` t' always offer it.
      outputs: ''

    # Adapter fer th' search engine.
    # Default: 'lunr'
    # Th' theme can use different search engines. T' glue both together, a
    # search adapter needs t' be written fer each engine. If not set, defaults
    # t' `lunr`. Th' theme ships wit' an additional `orama` adapter wit' no
    # usage limitat'ns an' an experimental `orama-esm' adapater not us'ble
    # fer headless server deployments but identical 'n functionality t' th'
    # `orama` adapter.
    # Each adapter may have futher specific paramters t' that adapter 'n
    # search.adapter.params.
    adapter:
      identifier: ''

      # Multilanguage rrrambl'n fer Lunr.
      # Default: not set
      # Specific t' th' Lunr search adapter.
      # If th' search index be enabled an' yer planks contain further languages
      # besides th' main one used, add all those auxiliary languages here. This
      # will create a search index wit' support fer all used languages o' yer
      # ship.
      # This be handy fer example if ye be writ'n 'n Spanish but have lots o'
      # source code on yer plank which typically uses English terminology.
      params:
        additionalContentLanguage:
          - en

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # Menu
  # These options modify th' menu appearance.

  # Hide th' Home entry.
  # Default: false
  # If shown, a Home button will appear below th' search bar an' th' main menu.
  # It links t' yer th' home plank o' th' current language.
  disableLandingPageButton: true

  # Hide th' language switcher.
  # Default: false
  # If ye have more than one language configured, a language switcher be
  # displayed 'n th' lower part o' th' menu. This option lets ye explicitly
  # turn this behavior off.
  disableLanguageSwitchingButton: false

  # Shows checkmarks fer visited planks o' th' main menu.
  # Default: false
  # This also causes th' display o' th' `Clear History` entry 'n th' lower part
  # o' th' menu t' remove all checkmarks. Th' checkmarks will also been removed
  # if ye regenerate yer ship as th' ids be not stable.
  showVisitedLinks: true

  # Th' order o' main menu submenus.
  # Default: 'weight'
  # Submenus can be ordered by 'weight', 'title', 'linktitle', 'lastmod',
  # 'expirydate', 'publishdate', 'date', 'length' or 'default' (adher'n t'
  # Hugo's default sort order). This can be overridden 'n th' planks frontmatter.
  ordersectionsby: weight

  # Th' initial expand state o' submenus.
  # Default: not set
  # This controls whether submenus will be expanded (true), or collapsed (false)
  # 'n th' menu. If not set, th' first menu level be set t' false, all others
  # levels be set t' true. This can be overridden 'n th' page's frontmatter.
  # If th' displayed plank has submenus, they will always been displayed expanded
  # regardless o' this option.
  alwaysopen: ''

  # Shows expander fer submenus.
  # Default: false
  # If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble
  # tree view an' a click'ble expander be set 'n front o' th' entry.
  # Avast that if set t' `true` can have a major performance impact on build
  # fer sites wit' many planks.
  # This can be overridden 'n th' page's frontmatter.
  collapsibleMenu: true

  # Hide head'n above th' shortcuts menu.
  # Default: false
  # If a sidebar menu wit' identifier `shortcuts` be configured (see below),
  # this be th' easy way t' remove th' head'n;
  # Th' title fer th' head'n can be overwritten 'n yer i18n files. See Hugo's
  # documentat'n how t' do this.
  disableShortcutsTitle: false

  # Define yer own sidebar menus.
  # Menus be written from th' sidebar's top t' buttom 'n th' order given 'n
  # these arrays.
  # This can be overridden 'n th' page's frontmatter.
  # Each entry can contain th' follow'n keys:
  # - `type` be mandatory. Either `page` 'n case it should generate a tree from
  #    th' plank structure, `menu` 'n case it should generate a tree from a
  #    defined menu, `custom` fer arbitrary HTML snippets or `divider` fer a
  #    horizontal ruler.
  # - `identifier` be mandatory. In case o' type `page`, anyth'n can be used,
  #    'n case o' type `menu` th' `identifier` key must be identical t' th'
  #    key o' th' menu definit'n.
  # - `main`, boolean. If `true`, th' first tree level be spaced more generous
  #    an' th' text be emphasized. Default: `true` fer type `page` an' `false`
  #    fer type `menu` an' type `custom`
  # - `disableTitle`, boolean. If `true`, there be no title above th' tree.
  #    Default: `true` fer type `page` an' `false` fer type `menu`. If a title
  #    should be used, 'n case o' type `page` it will be taken from th' page's
  #    `linkTitle` front matter an' if not set, from th' translat'n files, us'n
  #    th' menu `identifier` as key. In case o' type `menu` it will be taken
  #    from th' menu `title` accord'n t' Hugo's documentat'n an' if not set
  #    from th' menu `name` an' if this be not set form th' page's `linkTitle`.
  # - `pageRef`, optional. In case o' type `page` this be th' start'n page's
  #    path. If not set, th' home plank will be used.
  # - `elements`, optional. In case o' type `custom` th' list o' elements t'
  #    display. Th' theme shipps wit' th' follow'n predefined snippets which
  #    all accept th' `icon` parameter t' overwrite th' default ay'con
  #    - languageswitcher: will display th' language switcher
  #    - variantswitcher: will display th' variant switcher
  #    - versionswitcher: will display th' version switcher
  #    - historyclearer: will display a button t' clear th' history o' visited
  #       links

  # Th' sidebar header menu.
  # Default: see notes
  # If not given, defaults t'
  # - a home button if configured; if ye redefine this, use a Cap'n Hugo menu an' a
  #    type=menu t' replicate this
  # - a divider t' separate from th' sidebarmenus (depend'n on th' configurat'n
  #    o' th' theme variant)
  sidebarheadermenus: ''

  # Th' main sidebar header.
  # Default: see notes
  # - th' main plank menu based on yer rrrambl'n structure
  # - th' shortcuts menu includ'n th' title if configured
  sidebarmenus: ''

  # Th' main sidebar header.
  # Default: see notes
  # - a divider t' separate from th' sidebarmenus if any o' th' follow'n be
  #    configured
  # - th' language switcher if multilingual be configured
  # - th' variant switcher if multiple variants be configured
  # - th' history clearer if ye configured t' mark visited planks
  sidebarfootermenus: ''

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # Hidden planks
  # These options configure how hidden planks be treated.
  # A plank flagged as hidden, be only removed from th' main menu if ye be
  # currently not on this plank or th' hidden plank be not part o' current page's
  # ancestors. For all other functionality 'n Hugo a hidden plank behaves like any
  # other plank if not otherwise configured.

  # Hide hidden planks from search.
  # Default: false
  # Hides hidden planks from th' suggest'ns o' th' search box an' th' dedicated
  # search plank.
  disableSearchHiddenPages: false

  # Hide hidden planks fer web crawlers.
  # Default: false
  # Avoids hidden planks from show'n up 'n th' sitemap an' on Google (et all),
  # otherwise they may be indexed by search engines
  disableSeoHiddenPages: true

  # Hide hidden planks fer taxonomies.
  # Default: false
  # Hides hidden planks from show'n up on th' taxonomy an' terms planks. If this
  # reduces term counters t' zero, an empty but not linked term plank will be
  # created anyhow.
  disableTagHiddenPages: false

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # Rrrambl'n
  # These options modify how yer rrrambl'n be displayed.

  # Title separator.
  # Default: '::'
  # Changes th' title separator used when concatenat'n th' plank title wit' th'
  # ship title. This be consistently used throughout th' theme.
  titleSeparator: '::'

  # Breadcrumb separator.
  # Default: '>'
  # Changes th' breadcrumb separator used 'n th' topbars breadcrumb area an' fer
  # search results an' term planks.
  breadcrumbSeparator: '>'

  # Hide th' root breadcrumb.
  # Default: false
  # Th' root breadcrumb be usually th' home plank o' yer ship. Because this be
  # always access'ble by click'n on th' logo, ye may want t' reduce clutter
  # by remov'n this from yer breadcrumb.
  disableRootBreadcrumb: true

  # Hide breadcrumbs term planks.
  # Default: false
  # If ye have lots o' taxonomy terms, th' term planks may seem cluttered wit'
  # breadcrumbs t' ye, so this be th' option t' turn off breadcrumbs on term
  # planks. Only th' plank title will then be shown on th' term planks.
  disableTermBreadcrumbs: false

  # Dis'ble copy'n head'n links t' clipboard
  # Default: false
  # If set t' true, this disables th' copy'n o' anchor links t' th' clipboard;
  # if `disableAnchorScrolling` be also `true` then no anchor link will be vis'ble
  # when hover'n a head'n.
  disableAnchorCopy: false

  # Dis'ble scroll'n t' head'n link on click
  # Default: false
  # If set t' true, this disables th' scroll'n t' th' beginn'n o' th' head'n
  # when clicked; if `disableAnchorCopy` be also `true` then no anchor link will
  # be vis'ble when hover'n a head'n.
  disableAnchorScroll'n: false

  # User-defined styles fer shorrrtcodes
  # Default: not set
  # Besides th' predefined `style` values, ye be able t' define yer own. Th'
  # `style` parameter o' th' shortcode must match th' `identifier` defined here.
  # Th' title fer th' style will be determined from th' `title`. If a `i18n` be
  # set, th' title will be taken from th' translat'n files by that key instead
  # an' th' `title` be only used if no translat'n be found. Th' `title` may be
  # empty 'n which case, th' box does not contain a default title. `icon` an'
  # `color` be work'n similar.
  # Ye can also redefine th' predefined styles if you're not satisfied wit' th'
  # default values.
  # If ye define an optional `style` attribute, this be whar' all default values
  # be taken from. Ye can reference predefined styles as also yer own styles
  # if they be defined beforehand 'n this array.
  boxStyle:
    - identifier: hugo
      style: magenta
      ay'con: fa-fw fab fa-hackerrank
    - identifier: breaking
      style: warning
      title: ' '
    - identifier: change
      style: note
      title: ' '
    - identifier: new
      style: info
      title: ' '
      ay'con: plus-circle
    - identifier: option
      style: green
      ay'con: gears
    - identifier: frontmatter
      style: yellow
      ay'con: fa-fw fab fa-markdown
    - identifier: hugomenu
      style: magenta
      ay'con: bars
    - identifier: gfm
      color: darkgray
      ay'con: fa-fw fab fa-github
    - identifier: php
      color: rgb(136, 140, 196)
      ay'con: fa-fw fab fa-php
    - identifier: pants
      color: darkorange
      ay'con: lightbulb
    - identifier: obsidian
      color: rgb(124, 58, 237)
      ay'con: fa-fw far fa-gem
    - identifier: mpe
      color: rgb(66, 185, 131)
      ay'con: fa-fw fas fa-display
    - identifier: html
      color: orangered
      ay'con: fa-fw fas fa-code
    - identifier: relearn
      color: rgb(125, 201, 3)
      ay'con: fa-fw fas fa-puzzle-piece
    - identifier: example
      style: code
      title: Result
      ay'con: eye
    - identifier: magic
      i18n: ''
      title: Magic
      color: violet
      ay'con: hand-sparkles

  # Hide th' authors name an' email addresses
  # Default: false
  # If th' standard content-footer finds author name informat'n, ye can
  # dis'ble th' output o' this an' th' accord'n email address by sett'n this
  # parameter t' `true`.
  hideAuthorName: false

  # Hide th' authors email addresses
  # Default: false
  # If th' standard content-footer finds an authors email address, ye can
  # dis'ble th' output by sett'n this parameter t' `true`.
  hideAuthorEmail: false

  # Hide th' author'n date
  # Default: false
  # If th' standard content-footer finds an author'n date, ye can
  # dis'ble th' output by sett'n this parameter t' `true`.
  hideAuthorDate: false

  # Date format
  # Default: ':date_medium'
  # Th' date format used fer th' date 'n th' standard content-footer, when
  # display'n a planks meta informat'n. See
  # https://gohugo.io/functions/time/format/#localizat'n fer poss'ble values.
  dateFormat: ':date_medium'

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # Highlight
  # These options configure how code be displayed.

  # Hide copy-to-clipboard fer inline code.
  # Default: false
  # This removes th' copy-to-clipboard button from yer inline code.
  disableInlineCopyToClipBoard: true

  # Always show copy-to-clipboard fer block code.
  # Default: false
  # Th' theme only shows th' copy-to-clipboard button if ye hover over th' code
  # block. Set this t' true t' dis'ble th' hover effect an' always show th'
  # button.
  disableHoverBlockCopyToClipBoard: false

  # Wrap fer code blocks.
  # Default: true
  # By default lines o' code blocks wrap around if th' line be too long t' be
  # displayed on screen. If ye dislike this behavior, ye can reconfigure it
  # here.
  # Avast that lines always wrap 'n print mode regardless o' this option.
  # This can be overridden 'n th' page's frontmatter or given as a parameter t'
  # individual code blocks.
  highlightWrap: true

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # Include
  # These options configure how th' include shortcode works.

  # What t' do when path be not resolved.
  # Default: ''
  # Ye can control what should happen if a path can not be resolved t' as a
  # resource or via th' file system. If not set, no output will be written fer th'
  # unresolved path. If set t' `warning` th' same happens an' an additional
  # warning be printed. If set t' `error` an error message be printed an' th'
  # build be aborted.
  # This can be overridden 'n th' page's frontmatter.
  include:
    errorlevel: warning

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # Images
  # These options configure how images be displayed.

  # What t' do when local image link be not resolved.
  # Default: ''
  # Ye can control what should happen if a local image can not be resolved t' as
  # a resource. If not set, th' unresolved link be written as given into th'
  # result'n output. If set t' `warning` th' same happens an' an additional
  # warning be printed. If set t' `error` an error message be printed an' th'
  # build be aborted.
  # Please note that this can not resolve files inside o' yer `static` directory.
  # This can be overridden 'n th' page's frontmatter.
  image:
    errorlevel: warning

  # Image effects.
  # See th' documentat'n fer how ye can even add yer own arbitrary effects t'
  # th' list.
  # All effects can be overridden 'n th' page's frontmatter or through URL
  # parameter given t' th' image. See th' documentat'n fer details.

  # Default: false
  imageEffects:
    border: true
    # Default: false
    dataurl: false
    # Default: ''
    # Th' height o' th' image as a CSS value.
    height: ''
    # Default: false
    inlinecontent: false
    # Default: true
    lazy: true
    # Default: true
    lightbox: true
    # Default: true
    rounded: true
    # Default: false
    shadow: false
    # Default: ''
    # Th' width o' th' image as a CSS value.
    width: ''

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # Links
  # These options configure how links be displayed.

  # Wether t' use Hugo's default relref shortcode implementat'n
  # Default: false
  # Since th' theme provides a link render hook, th' usage o' th' relref shortcode
  # be obsolete. If a ship still uses that shortcode, it fails t' generate a
  # correct links if th' baseURL be configured wit' a subdirectory an'
  # `relativeURLs` set t' `false`.
  # Th' theme provides an overriden relref shortcode that also works 'n th'
  # above setup but must manually be activated by sett'n this option t' true.
  # See discussion 'n
  # https://github.com/McShelby/hugo-theme-relearn/discussions/862
  disableDefaultRelref: false

  # Generate link URLs th' Cap'n Hugo way.
  # Default: false
  # If set t' true, th' theme behaves like a standard Cap'n Hugo installat'n an'
  # appends no index.html t' prettyURLs. As a trade off, yer build project will
  # not be serv'ble from th' file system.
  disableExplicitIndexURLs: false

  # How t' open external links.
  # Default: ''
  # For external links ye can define how they be opened 'n yer browser. All
  # values fer th' HTML `target` attribute o' th' `a` element be allowed. Th'
  # default value will not add any target attribute opens external links 'n
  # th' same browser tab.
  # If ye want t' explicitly open those links 'n th' same
  # tab, use '_self'.
  # If ye want t' set th' default behavior fer all links, use link effects.
  # This can be overridden 'n th' page's frontmatter.
  externalLinkTarget: _self

  # What t' do when local plank link be not resolved.
  # Default: ''
  # Ye can control what should happen if a local link can not be resolved t' a
  # plank. If not set, th' unresolved link be written as given into th' result'n
  # output. If set t' `warning` th' same happens an' an additional warning be
  # printed. If set t' `error` an error message be printed an' th' build be
  # aborted.
  # Please note that wit' Cap'n Hugo < 0.123.0 an' `uglyURLs` set t' `true` this can
  # lead t' false negatives.
  # This can be overridden 'n th' page's frontmatter.
  link:
    errorlevel: warning

    # Underline links 'n th' rrrambl'n.
    # Default: false
    # By default links 'n th' rrrambl'n be only told apart from th' text around
    # them by their color. If set t' true, they be underlined as well, which
    # helps readers who can not distinguish th' colors.
    underline: false

  # Link effects.
  # See th' documentat'n fer how ye can even add yer own arbitrary effects t'
  # th' list.
  # All effects can be overridden 'n th' page's frontmatter or through URL
  # parameter given t' th' link. See th' documentat'n fer details.

  # Default: false
  linkEffects:
    download: false
    # Default: false
    target: false

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # Math
  # These options configure how math formulae be displayed.

  # Output o' th' rendered formulae.
  # Default: 'mathml'
  # `mathml` be styled by th' browser alone. `html` an' `htmlAndMathml` look th'
  # same 'n every browser but need th' KaTeX stylesheet an' fonts, which be
  # linked t' planks contain'n math.
  # Any other option o' Hugo's `transform.ToMath` funct'n can be set 'n
  # `toMath` besides `output`, like `macros`, `throwOnError` or `strict`. Give
  # `macros` as a list o' name an' definit'n pairs, as Cap'n Hugo lowercases th'
  # names o' a map.
  # This can be overridden 'n th' page's frontmatter.
  math:
    toMath:
      output: mathml

    # Force board th' KaTeX stylesheet on every plank.
    # Default: false
    # Th' stylesheet be linked t' every plank that contains math, if th' `output`
    # needs it. This option be only useful if ye write KaTeX's HTML yourself. In
    # this case no formula be rendered by th' theme so ye can force link'n it by
    # sett'n `math.force` t' `true`.
    # This option has an alias, `math` set t' `true`, which can't be combined wit'
    # other `math.*` options.
    # This can be overridden 'n th' page's frontmatter.
    force: false

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # Merrrmaid
  # These options configure how Merrrmaid graphs be displayed.

  # Make graphs pan'ble an' zoom'ble
  # Default: false
  # For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come
  # wit' a reset button fer th' zoom.
  # This can be overridden 'n th' page's frontmatter or given as a parameter t'
  # individual graphs.
  mermaidZoom: true

  # Initializat'n options fer Merrrmaid.
  # Default: not set
  # A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter.
  # This can be overridden 'n th' page's frontmatter.
  mermaidInitialize: '{ "securityLevel": "loose" }'

  # Force board Merrrmaid on every plank.
  # Default: false
  # If a Merrrmaid shortcode or codefence be found, th' option will be ignored an'
  # Merrrmaid will be boarded regardlessly. This option be useful 'n case ye
  # be us'n script'n t' render yer graph. In this case no shortcode or
  # codefence be involved an' th' library be not boarded by default so ye can
  # force loading it by sett'n `mermaid.force` t' `true`.
  # This can be overridden 'n th' page's frontmatter.
  mermaid:
    force: false

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # OpenApi
  # These options configure how OpenAPI specificat'ns be displayed.

  # Force board OpenAPI on every plank.
  # Default: false
  # If a OpenAPI shortcode or codefence be found, th' option will be ignored an'
  # OpenAPI will be boarded regardlessly. This option be useful 'n case ye
  # be us'n script'n t' render yer spec. In this case no shortcode or
  # codefence be involved an' th' library be not boarded by default so ye can
  # force loading it by sett'n `openapi.force` t' `true`.
  # This can be overridden 'n th' page's frontmatter.
  openapi:
    force: false

    # What t' do when a local OpenAPI spec link be not resolved.
    # Default: ''
    # Ye can control what should happen if a local OpenAPI spec link can not be
    # resolved t' a resource. If not set, th' unresolved link be written as given
    # into th' result'n output. If set t' `warning` th' same happens an' an
    # additional warning be printed. If set t' `error` an error message be printed
    # an' th' build be aborted.
    # Please note that this can not resolve files inside o' yer `static`
    # directory.
    # This can be overridden 'n th' page's frontmatter.
    errorlevel: warning

  #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  # Tables
  # These options configure how tables be displayed.

  # Make tables sortable.
  # Default: false
  # If set t' true, readers can sort tables by their columns. A single table
  # can be excluded by th' class `nosortable` or included by th' class
  # `sortable`.
  # This can be overridden 'n th' page's frontmatter.
  table:
    sortable: false