Images
Images live in the images/ folder next to the pages and are referenced relatively. Each language has its own images/ folder – so screenshots can show the matching interface language.
Screenshot
The alt text in square brackets describes what is shown. Screen readers read it out, and it appears if the image fails to load.
Image with caption
Markdown has no captions. An italic sentence directly below the image works well:
Figure 1: The toggle (1) activates the notice for all products.
Wide graphic
Wide graphics are scaled down to the content width:
Markers in screenshots
Numbered markers in the image (like the 1 above) are referenced in the text:
- Switch on Notice active.
- Enter the notice text.
- Apply with Save.
Tips for screenshots
- Use PNG for screenshots, SVG for graphics and diagrams.
- Maximum width 1600 px, show only the relevant part.
- Do not show real customer data.
- File names in lower case with hyphens:
create-product-notice.png.