markdown-a11y

What problem does it solve?

Ensures markdown documentation is readable and navigable for people using assistive technologies by identifying accessibility issues that are commonly overlooked in READMEs, docs, and profiles.

Core Features & Use Cases

• Descriptive links: Detects and recommends replacing generic link text like "here" with context-rich link labels.
• Image alt text guidance: Flags missing, empty, or filename-based alt text and suggests concise, meaningful alternatives.
• Heading hierarchy & lists: Identifies skipped heading levels, fake headings, and improper list markup to improve navigation for screen readers.
• Emoji and plain language: Flags excessive or meaning-bearing emoji and suggests clearer, plain-language rewrites.
• Prioritized fixes & tooling: Provides a ranked remediation list and practical linting commands (e.g., markdownlint) to validate changes.

Quick Start

Review README.md for markdown accessibility and return a prioritized list of actionable fixes for images, headings, links, lists, emoji, and plain language.