Skip to main content

Categories

The categories follow the Diátaxis documentation framework, which sorts each page by what the reader needs: learning, solving a task, understanding or looking something up.

This taxonmy page and their term pages are configured differently in comparison to the default. See the docs for what’s possible.

  • Explanations give you the background on how things work and why they are the way they are.
  • How-to guides show you the steps to solve a specific task you already have in mind.
  • References describe things completely and precisely, for you to look up while you work.
  • Tutorials are lessons that take you step by step to a working result, so you learn by doing.

Subsections of Categories

Category :: Explanation

Explanations give you the background on how things work and why they are the way they are.

A

C

D

G

H

I

L

M

O

P

S

  • SBOM

    What the theme publishes with your site, as a CycloneDX SBOM

  • Screenshooting

    Recipe to create various documentation screenshots

T

  • Taxonomies

    How to display custom taxonomies on your pages

  • Testing

    How to run and extend the automated test suite

  • Topbar

    How to extend the topbar

W

Category :: Howto

How-to guides show you the steps to solve a specific task you already have in mind.

A

B

  • Badge

    Marker badges to display in your text

  • Button

    Clickable buttons

C

D

E

  • Expand

    Expandable/collapsible sections of text

H

I

L

  • Link Effects

    How to extend link effects

  • Linking

    What options are available for links and images

  • Linking

    What options are available for links and images

  • Logo & Title

    Provide your own logo, favicon and menu title

M

N

  • Notice

    Boxes to help you structure your page

O

P

R

  • Resources

    List resources contained in a page bundle

S

  • SBOM

    What the theme publishes with your site, as a CycloneDX SBOM

  • Screenshooting

    Recipe to create various documentation screenshots

  • Search

    Configure search and the search form

  • SiteParam

    Get value of site params

  • Stable Output

    How to make your generated HTML output stable

T

V

W

  • Width

    Changing the content area width

  • Width

    Changing the width of the sidebar

Category :: Reference

References describe things completely and precisely, for you to look up while you work.

A

  • Attachments

    List of files attached to a page

  • Authoring

    Learn how to create and organize your content pages. Directory Structure Your content's directory structure Front Matter All things front matter Meta Information What page meta information are available Markdown Syntax Reference of CommonMark and Markdown extensions Linking How to link your content Taxonomy / Term Pages How to adjust taxonomy and term pages

B

  • Badge

    Marker badges to display in your text

  • Branding

    Change colors and logos of your site

  • Button

    Clickable buttons

C

  • Callout

    Boxes to help you structure your page

  • Cards

    Show content in cards

  • Changelog

    The detailed changelog

  • Children

    List the child pages of a page

  • Configuration

    Find out how to configure and customize your site. Site Management Get yourself familiar with the general structure of your website Branding Change colors and logos of your site Sidebar Configure all things sidebar Content Configure the content area of your site Customization Customize files for advanced usage Publishing Serve your site to your readers Options Reference All configuration options for the Relearn theme

  • Content

    Configure the content area of your site

  • Customization

    Customize files for advanced usage

D

  • Details

    Expandable/collapsible sections of text

  • Development

    This chapter contains information only needed for development and maintaining the theme.

E

  • Expand

    Expandable/collapsible sections of text

F

H

  • Highlight

    Render code with a syntax highlighter

I

  • Icon

    Nice icons for your page

  • Include

    Displays content from other files

K

L

M

  • Markdown Syntax

    Reference of CommonMark and Markdown extensions

  • Math

    Beautiful math and chemical formulae

  • Mermaid

    Generate diagrams and flowcharts from text

N

  • Notice

    Boxes to help you structure your page

O

  • OpenAPI

    UI for your OpenAPI / Swagger specifications

  • Options Reference

    All configuration options for the Relearn theme

P

  • Pages

    Group, order and list pages of your site

  • Publishing

    Serve your site to your readers

R

  • Reference

    All front matter for the Relearn theme

  • Resources

    List resources contained in a page bundle

S

  • Shortcodes

    Hugo uses Markdown as its content format. However, there are a lot of things that Markdown doesn’t support well. To overcome those limitations, Hugo created the concept of shortcodes.

  • Sidebar

    Configure all things sidebar

  • Site Management

    Get yourself familiar with the general structure of your website

  • SiteParam

    Get value of site params

T

  • Tabs

    Show content in tabbed views

  • Taxonomies

    How to display custom taxonomies on your pages

  • Topbar

    How to extend the topbar

  • Tree

    Display text as a tree

Category :: Tutorial

Tutorials are lessons that take you step by step to a working result, so you learn by doing.

G

S

U

  • Upgrade

    How to upgrade your Relearn site