Categorrry :: Howto

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

A

• Accessibility

  What the theme does to be usable by everyone

• Adding Scripts

  Add further code to your site

• Attachments

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

• Available Output Formats

  What formats can a page be displayed in

B

• Badge

  Marker badges t' display 'n yer text

• Brrrand'n

  Learn how to customize your site's colors

• Button

  Clickable buttons

C

• Callout

  Boxes to help you structure your page

• Cards

  Show rrrambl'n 'n carrrds

• Children

  List th' child planks on a plank

• Content Security Policy

  Serving your site with a strict Content Security Policy

D

• Deployment Scenarios

  Options for specific deployment needs

• Details

  Expand'ble/collaps'ble sections of text

• Developin'

  How t' set up, 'n how th' theme 'n its tacklin' be split

E

• Expand

  Expand'ble/collaps'ble sections of text

H

• Header & Footer

  Configure the header and footer

• Headings

  Configuring heading anchors

• Hidden Pages

  Learn about the hidden pages feature

• Highlight

  Render code with a syntax highlighter

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

• Maintaining

  What to know as a maintainer

• Marrrkdown Rules

  Reference of CommonMark and Markdown extensions

• Math

  Beaut'fl math and chemical formulae

• Menus

  Configure all things menus

• Merrrmaid

  Generrrat'n o' diagrrram an' flowcharrrt frrrom text

• Meta Information

  What page meta information are available

• Meta Information

  What site-wide meta information can be set

• Module Theming

  Colors of syntax highlighting and 3rd-party modules

• Multilingual

  How to set up a multilingual site

N

• Notice

  Boxes to help you structure your page

O

• OpenAPI

  UI fer yer OpenAPI / Swaggerrr Specificat'ns

• Output Formats

  Adding Custom Output Formats

P

• Page Designs

  How to vary layouts by using page designs

• Page Designs

  Using and extending page designs

• Page Meta Information

  Display page meta information with your content

• Pages

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

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

• Tabs

  Show rrrambl'n 'n tabbed views

• Taxonomies

  How to display custom taxonomies on your pages

• Taxonomy / Term Pages

  How to adjust taxonomy and term pages

• Testin'

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

• Titles & Breadcrumbs

  Configuring titles and breadcrumbs to your needs

• Topbarrr

  Configure the topbar

• Tree

  Display text as a tree

V

• Versioning

  How to keep older versions of your site

• VS Code Front Matter CMS

  Use the shortcodes from inside the VS Code Front Matter CMS extension

W

• Width

  Changing the content area width

• Width

  Changing the width of the sidebar