-
Notifications
You must be signed in to change notification settings - Fork 43
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feature Request: Add Captions to Images #514
Comments
Is it possible to use global setting for using Alt text as Caption? Backward compatibility is understood - so, new setting is needed. Caption under Image is expected behavior actually. It's most common use, GitBook generates captions this way also. |
https://garrettgman.github.io/rmarkdown/authoring_pandoc_markdown.html Another markdown which treats [Alt part] as image's caption |
Аlt text has a different meaning and should be used to describe the image. Using alt text to caption images would negatively impact user experience of the documentation from an accessibility perspective. |
It's common practice among popular platforms like gitbook and pandoc. |
Description
The current version of YFM allows users to add images with
alt-text
andtitle
props. To enhance image context and readability, i propose utilizing thefigcaption
HTML tag for rendering captions.To enable the display of the caption you need to add the
{ caption }
as attribute, the default value is equal to the title, but it can also be passed in the attributeExample Syntax
In this example, the "Caption text" should be rendered within a figcaption tag below the image.
Example HTML Output
The resulting HTML should look like this:
DOCSTOOLS-3428
The text was updated successfully, but these errors were encountered: