Skip t' th' main rrreadin'
Prrrevious plank
Next plank
Edit plank
Show source code
Show Marrrkd'n
Prrrint whole chapterrr

Categorrries

Th' categories follow th' Diátaxis documentat'n framework, which sorts each plank by what th' reader needs: learn'n, solv'n a task, understand'n or look'n someth'n up.

This taxonmy plank an' their term planks be configured differently 'n comparison t' th' default. See th' docs fer what’s poss'ble.

  • Explanat’ns give ye th’ background on how th’ns work an’ why they be th’ way they be.
  • How-to guides show ye th’ steps t’ solve a specific task ye already have ’n mind.
  • References describe th’ns completely an’ precisely, fer ye t’ look up while ye work.
  • Tutorials be lessons that take ye step by step t’ a work’n result, so ye learn by do’n.

Subsct'ns o' Categorrries

Categorrry :: Explanation

Explanat'ns give ye th' background on how th'ns work an' why they be th' way they be.

A

B

  • Brrrand'n

    Learn how to customize your site's colors

C

D

G

H

I

L

M

O

P

S

  • SBOM

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

  • Scrrrenshootin'

    Recipe t' create various documentat'n scrrreenshots

T

  • Taxonomies

    How to display custom taxonomies on your pages

  • Testin'

    How t' rrrun 'n extend th' automated test suite

  • Topbarrr

    How to extend the topbar

W

Categorrry :: Howto

How-to guides show ye th' steps t' solve a specific task ye already have 'n mind.

A

B

  • Badge

    Marker badges t' display 'n yer text

  • Brrrand'n

    Learn how to customize your site's colors

  • Button

    Clickable buttons

C

D

E

  • Expand

    Expand'ble/collaps'ble sections of text

H

I

  • Icon

    Nice ay'cons fer yer plank

  • Image Effects

    How to extend image effects

  • Include

    Displays content from other Marrrkdown files

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 Rrresources shorrrtcode contained in a plank bundle

S

  • SBOM

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

  • Scrrrenshootin'

    Recipe t' create various documentat'n scrrreenshots

  • Search

    Configure search and the search form

  • SiteParam

    Get value o' ship parrrams

  • 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

Categorrry :: Reference

References describe th'ns completely an' precisely, fer ye t' look up while ye work.

A

  • Attachments

    Th' Attachments shorrrtcode displays a list o' files attached t' a plank

B

  • Badge

    Marker badges t' display 'n yer text

  • Brrrand'n

    Change colors and logos of your site

  • Button

    Clickable buttons

C

  • Callout

    Boxes to help you structure your page

  • Cards

    Show rrrambl'n 'n carrrds

  • Changelog

    The detailed changelog

  • Children

    List th' child planks on a plank

  • Configurrrat'n

    Find out how t' configure an' cust'mize yer ship. Ship Management Get yourself familiar wit' th' general structure o' yer website Brand'n Change colors an' logos o' yer ship Sidebar Configure all th'ns sidebar Rrrambl'n Configure th' rrrambl'n area o' yer ship Customizat'n Cust'mize files fer advanced usage Publish'n Serve yer ship t' yer readers Opt'ns Reference All configurat'n options fer th' Relearrrn theme

  • Content

    Configure the content area of your site

  • Customization

    Customize files for advanced usage

D

  • Details

    Expand'ble/collaps'ble sections of text

  • Development

    This chapter contains informat'n only needed fer development an' maintain'n th' theme.

E

  • Expand

    Expand'ble/collaps'ble sections of text

F

H

  • Highlight

    Render code with a syntax highlighter

I

  • Icon

    Nice ay'cons fer yer plank

  • Include

    Displays content from other Marrrkdown files

K

L

M

  • Marrrkdown Rules

    Reference of CommonMark and Markdown extensions

  • Math

    Beaut'fl math and chemical formulae

  • Merrrmaid

    Generrrat'n o' diagrrram an' flowcharrrt frrrom text

N

  • Notice

    Boxes to help you structure your page

O

  • OpenAPI

    UI fer yer OpenAPI / Swaggerrr Specificat'ns

  • Options Reference

    All configuration options for the Relearn theme

P

  • Pages

    Group, order 'n list th' planks o' yer ship

  • Publishing

    Serve your site to your readers

R

  • Rambl'n

    Learrrn how t' create an' org'nize yer rrrambl'n planks. Directory Structure Yer content's directory structure Front Matter All th'ns front matter Meta Informat'n What plank meta informat'n be avail'ble Marrrkdown Rules Reference o' CommonMark an' Marrrkdown extensions Link'n How t' link yer rrrambl'n Taxonomy / Term Planks How t' adjust taxonomy an' term planks

  • Reference

    All front matter for the Relearn theme

  • Resources

    List Rrresources shorrrtcode contained in a plank bundle

S

  • Shorrrtcodes

    Cap'n Hugo uses Marrrkdown as its rrrambl'n format. However, there be a lot o' th'ns that Marrrkdown doesn’t support well. T' overcome those limitat'ns, Cap'n Hugo created th' concept o' shorrrtcodes.

  • Sidebar

    Configure all things sidebar

  • Site Management

    Get yourself familiar with the general structure of your website

  • SiteParam

    Get value o' ship parrrams

T

  • Tabs

    Show rrrambl'n 'n tabbed views

  • Taxonomies

    How to display custom taxonomies on your pages

  • Topbarrr

    How to extend the topbar

  • Tree

    Display text as a tree

Categorrry :: Tutorial

Tutorials be lessons that take ye step by step t' a work'n result, so ye learn by do'n.

G

S

U

  • Upgrade

    How to upgrade your Relearn site