rumdl 0.1.51

A fast Markdown linter written in Rust (Ru(st) MarkDown Linter)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

# MD045 - Add Descriptive Text to Images

Aliases: `no-alt-text`

## What this rule does

Ensures all images include alternative text (alt text) that describes the image content for accessibility and fallback display.

## Why this matters

- **Accessibility**: Screen readers need alt text to describe images to visually impaired users
- **Broken images**: Alt text displays when images fail to load
- **SEO benefits**: Search engines use alt text to understand and index images
- **Professional quality**: Missing alt text looks like an oversight

## Examples

### ✅ Correct

```markdown
![Company logo](images/logo.png)

![Graph showing 40% increase in sales](charts/q4-sales.png)

![Screenshot of the login page with username and password fields](screenshots/login.png)

![Team photo from the 2024 company retreat](photos/team-retreat-2024.jpg)
```

### ❌ Incorrect  

```markdown
![](images/logo.png)                <!-- Empty alt text -->

![ ](charts/q4-sales.png)           <!-- Just spaces -->

![  ](screenshots/login.png)        <!-- Still just spaces -->

![](photos/team-retreat-2024.jpg)   <!-- No description at all -->
```

## No automatic fix

This rule is diagnostic-only and does not offer auto-fix. Meaningful alt text requires human judgment — automated placeholders are harmful for accessibility because screen readers would read fabricated text to users.

## Writing good alt text

- Be concise but descriptive
- Describe the content, not just "image of..."
- Include relevant data from charts or graphs
- Mention important text shown in screenshots

## Special cases

- Decorative images might use empty alt text in HTML, but Markdown requires some text
- The rule only checks Markdown image syntax, not HTML `<img>` tags
- Reference-style images are also checked

## Learn more

- [WebAIM alt text guide](https://webaim.org/techniques/alttext/)
- [W3C alt text decision tree](https://www.w3.org/WAI/tutorials/images/decision-tree/)
- [CommonMark specification for images](https://spec.commonmark.org/0.31.2/#images)

## Related rules

- [MD033](md033.md) - Control HTML usage in Markdown
- [MD042](md042.md) - Avoid empty links
- [MD052](md052.md) - Validate reference links and images