Accessibility

The theme wants your documentation to be usable by everyone, whether they read it with their eyes, a screen reader or a magnifier, and whether they move through it with a mouse, a keyboard or by touch. Accessibility is a supported feature of the theme: what doesn’t work for you or your readers is a bug and welcome to be reported.

The theme takes the Web Content Accessibility Guidelines as its yardstick.

What Is Up to You

The theme can only care for what it writes itself. The rest is yours.

• Colors: The contrast of text depends on the color variant you choose or write. Not every shipped variant has enough of it in every place, the contrast variants do. Colors you set yourself, like the one of a badge or a box, are yours to check.
• Headings: The theme writes the title of a page as its first heading, so start the headings of your content one level below and don’t skip a level. The headings the theme writes for you fit in on their own. The exception is the pages shortcode, whose headinglevel you have to set to match the place you call it from.
• Images: Give each image an alternative text.
• Links: Write link texts that tell where they lead even if read on their own.

Underlined Links

Option By default, links in your content are told apart from the text around them only by their color. Readers who can not distinguish these colors don’t see that there is a link.

Set link.underline=true to also underline them. This affects the links in your content, not the menu or the topbar, and not what looks like a control of its own, like buttons or cards.

[params]
  [params.link]
    underline = true

params:
  link:
    underline: true

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

The theme marks the page with the class link-underline on the body element, in case your own styles want to react on it.

Keyboard Shortcuts

Besides the keys every browser knows, the theme brings shortcuts of its own. Those of a button are also shown in its tooltip.