Eriksen Labs Support
Documentation

Describe it for screen readers

v2.10.0Updated

Use Alt text for screen readers in the editor to describe the diagram. It holds up to 250 characters. Describe what the diagram shows rather than naming it.

For example, write "Order flow from request through approval to shipment" rather than "Order diagram".

Screen readers on the page read it out. Without it, they say "Mermaid diagram". The same text describes the diagram's picture in Word and PDF exports.

Where an export or an email shows the diagram's text as code, the alt text comes just above it.

Keyboard users reach the toolbar and linked boxes with Tab. If you color boxes yourself, keep dark text on light fills.

In the editor, Tab indents the diagram source. To move on to the alt text, press Esc, then Tab. Ctrl+M (Shift+Alt+M on a Mac) makes Tab move on until you press it again.