markdown-accessibility

Audit and fix Markdown accessibility issues including links, images, headings, tables, emoji, diagrams, and anchors.

Updated Jan 29, 2025

Search Tags:#documentation #markdown #accessibility #WCAG #auditing #fixing

Ready to run

npx skills add https://github.com/ryan0122/a11ypros --skill markdown-accessibility-ryan0122

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: markdown-accessibility
Source: https://github.com/ryan0122/a11ypros/tree/main/.github/skills/markdown-accessibility
Command: npx skills add https://github.com/ryan0122/a11ypros --skill markdown-accessibility-ryan0122

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses common accessibility issues found in Markdown documentation, ensuring content is usable by everyone, including those using assistive technologies.

Core Features & Use Cases

Auditing and Fixing: Identifies and helps correct accessibility barriers in Markdown files.
Comprehensive Checks: Covers links, images, headings, tables, emoji usage, diagrams, and more.
Use Case: Before publishing a project's README, use this Skill to scan it for accessibility issues like ambiguous links or missing image alt text, and then apply suggested fixes.

Quick Start

Scan the markdown file 'README.md' for accessibility issues and provide a report.

Frequently Asked Questions about markdown-accessibility

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I audit markdown documentation for accessibility issues?▼

To audit markdown documentation for accessibility, scan the file to identify and correct barriers like ambiguous links, missing image alt text, and heading structure issues. This process utilizes pattern libraries and severity scoring to generate a comprehensive accessibility report.

What are common markdown accessibility issues and how are they fixed?▼

Common markdown accessibility issues include ambiguous links, missing image alt text, improper heading structure, and inaccessible tables. Fixing these involves applying pattern libraries to correct emoji handling, diagram descriptions, and anchor link validation to ensure WCAG compliance.

Can I check markdown table accessibility and heading structure before publishing?▼

Yes, you can check markdown table accessibility and heading structure before publishing. The audit scans files to validate heading hierarchy and table formatting, ensuring documentation is usable by everyone, including those relying on assistive technologies.

Does markdown accessibility auditing validate diagram descriptions and anchor links?▼

Markdown accessibility auditing does validate diagram descriptions and anchor links. It checks these elements alongside image alt text and emoji handling, utilizing severity scoring to prioritize and apply necessary fixes for documentation compliance.

What is the best way to ensure markdown files meet WCAG accessibility standards?▼

The best way to ensure markdown files meet WCAG accessibility standards is to run a comprehensive audit covering links, images, headings, and tables. This identifies specific barriers and helps apply suggested fixes using established pattern libraries.

Are there limitations when fixing ambiguous links and emoji handling in markdown?▼

Fixing ambiguous links and emoji handling in markdown depends on the pattern libraries utilized by the audit. While it can identify and suggest corrections for these accessibility barriers, complex custom diagrams may require manual descriptive text input to achieve full compliance.