markdownlint/doc-build/md045.md

25 lines
661 B
Markdown
Raw Normal View History

This rule is triggered when an image is missing alternate text (alt text) information.
Alternate text is commonly specified inline as:
```markdown
![Alternate text](image.jpg)
```
Or with reference syntax as:
```markdown
![Alternate text][ref]
...
[ref]: image.jpg "Optional title"
```
Guidance for writing alternate text is available from the [W3C](https://www.w3.org/WAI/alt/),
[Wikipedia](https://en.wikipedia.org/wiki/Alt_attribute), and
[other locations](https://www.phase2technology.com/blog/no-more-excuses).
Rationale: Alternate text is important for accessibility and describes the
content of an image for people who may not be able to see it.