Accessibility

Th' theme wants yer documentat'n t' be us'ble by everyone, whether they read it wit' their eyes, a screen reader or a magnifier, an' whether they move through it wit' a mouse, a keyboard or by touch. Accessibility be a supported feature o' th' theme: what doesn’t work fer ye or yer readers be a bug an' welcome t' be reported.

Th' theme takes th' Web Rrrambl'n Accessibility Guidelines as its yardstick.

What Be Up t' Ye

Th' theme can only care fer what it writes itself. Th' rest be yours.

• Colors: Th' contrast o' text depends on th' color variant ye choose or write. Not every shipped variant has enough o' it 'n every place, th' contrast variants do. Colors ye set yourself, like th' one o' a badge or a box, be yours t' check.
• Head'ns: Th' theme writes th' title o' a plank as its first head'n, so start th' head'ns o' yer rrrambl'n one level below an' don’t skip a level. Th' head'ns th' theme writes fer ye fit 'n on their own. Th' except'n be th' planks shortcode, whose headinglevel ye have t' set t' match th' place ye call it from.
• Images: Give each image an alternative text.
• Links: Write link texts that tell whar' they lead even if read on their own.

Underlined Links

Opt'n By default, links 'n yer rrrambl'n be told apart from th' text around them only by their color. Readers who can not distinguish these colors don’t see that there be a link.

Set link.underline=true t' also underline them. This affects th' links 'n yer rrrambl'n, not th' menu or th' topbar, an' not what looks like a control o' its own, like buttons or cards.

[params]
  [params.link]
    underline = true

params:
  link:
    underline: true

{
   "params": {
      "link": {
         "underline": true
      }
   }
}

Th' theme marks th' plank wit' th' class link-underline on th' body element, 'n case yer own styles want t' react on it.

Keyboard Shortcuts

Besides th' keys every browser knows, th' theme br'ns shortcuts o' its own. Those o' a button be also shown 'n its tooltip.