Explain how to set descriptive alt text as well as caption #11082
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jgm
reviewed
Aug 28, 2025
| paragraph, will be rendered as a figure with a caption. The | ||
| image's alt text will be used as the caption. | ||
| image's alt text will be used as the caption. To set alt text | ||
| as well as a caption, use the 'alt' link_attribute (see below). |
There was a problem hiding this comment.
I'd suggest using `alt` instead of 'alt'.
| Attributes can be set on links and images: | ||
|
|
||
| An inline {#id .class width=30 height=20px} | ||
| An inline {#id .class width=30 height=20px alt="Alt text"} |
There was a problem hiding this comment.
This is not a good example, because in this inline image, the alt text will be set from the image description. Thus, you can just do . You would only have a reason to use alt= when the image is by itself in a paragraph, when the implicit_figures extension is set.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ref discussion here: #11081