From 8a4b9277fed78745653f1acb21361327dbcba732 Mon Sep 17 00:00:00 2001 From: Frankie Roberto Date: Mon, 15 Jul 2024 21:28:04 +0100 Subject: [PATCH] Add documentation for image alt text and captions --- docs/generate-a-page-of-screenshots.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/generate-a-page-of-screenshots.md b/docs/generate-a-page-of-screenshots.md index 2f3109f..b5523eb 100644 --- a/docs/generate-a-page-of-screenshots.md +++ b/docs/generate-a-page-of-screenshots.md @@ -86,7 +86,7 @@ screenshots: --- ``` -If you want to change the name of any images, you can use the `src` value to tell the screenshots component what filename to look for, for example: +If you want to change the title of any image, add a caption, or set more detailed alternative text, you can do that by setting the `text`, `src`, `alt` and `caption`: ```yaml title: Submit personal details @@ -95,6 +95,11 @@ screenshots: items: - text: "Index page" src: a-different-index-page-image.jpg + alt: Screenshot of page with the title 'Index page' and 5 posts listed + caption: | + You can include captions with each image, and + each caption can include markdown. This is a + screenshot of the [index page](/). - "Personal details" - "Check your answers" - "Confirmation"