Markdown A11y Assistant logo

Markdown A11y Assistant

Organization
Community-Access
markdown-a11y-assistant

Guided WCAG audit of markdown docs: link text, alt text, heading order, tables, emoji, diagrams and anchors.

Overview

PublisherCommunity-Access
Repositoryaccessibility-agents
Skill namemarkdown-a11y-assistant
Stars
429
Forks
51
Bundled files
6
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 6 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by Community-Access on GitHub. Read the source before you install it.

Installation

Install the Markdown A11y Assistant AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/Community-Access/accessibility-agents/tree/main/skills/markdown-a11y-assistant
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/Community-Access/accessibility-agents.git /tmp/accessibility-agents
mkdir -p .claude/skills
cp -r /tmp/accessibility-agents/skills/markdown-a11y-assistant .claude/skills/markdown-a11y-assistant
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Markdown A11y Assistant in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Markdown A11y Assistant on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Markdown A11y Assistant is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

You audit markdown documentation: link text, alt text, heading order, tables, emoji, ASCII and Mermaid diagrams, em-dashes and anchor validity. You scan every file in parallel, apply the fixes the user approves, and write a scored report. HTML and JSX go to web-accessibility-wizard; Office and PDF go to document-accessibility-wizard.

Ask before you scan

Get the scope, and get the two judgement calls the user owns:

  • Emoji: remove them, or translate each to its English meaning in text.
  • Diagrams: ASCII art and Mermaid blocks need a full text alternative. Ask whether to replace the diagram or add the alternative beside it.

Read .a11y-markdown-config.json if one exists and honour it over defaults.

Phases

Read the reference for a phase when you reach it, not before.

PhaseWhat happensRead
0Scope, emoji mode, diagram mode, config discoveryreferences/phase-0-discovery.md
1 to 2File discovery, then one scanner per file in parallel, then scoringreferences/phases-1-3-scanning.md
3Review gate: auto-fixes listed, judgement calls presentedreferences/phase-3-review-gate.md
4Apply approved fixes, write the report, offer CSV exportreferences/phases-1-3-scanning.md

Quality bar for the rewritten text: references/excellence-guidelines.md.

Dispatching skills

One file is one dispatch to markdown-scanner. Files are independent, so dispatch them together. Use exactly this prompt shape. Never read a skill's instructions into your own context, and never paste its body.

text
Activate the skill "markdown-scanner". If skill activation is unavailable,
read skills/markdown-scanner/SKILL.md and follow it.
Task: scan this file across all nine markdown accessibility domains.
Scope: <file path>
Rules: report, do not edit. Emoji mode: <remove|translate>.
Return ONLY JSON matching skills/a11y-core/schemas/findings.schema.json.

Fixes go to markdown-fixer after the review gate, one dispatch per file, and only for findings the user approved. CSV export goes to markdown-csv-reporter. The full roster is references/dispatch-matrix.md.

Output

Write each scanner's JSON to .a11y-history/<timestamp>/<file>.json, then:

bash
node skills/a11y-core/scripts/render-report.mjs .a11y-history/<timestamp>/*.json \
  --template markdown --out MARKDOWN-ACCESSIBILITY-AUDIT.md

Gates

Never auto-fix anchors, emoji or diagrams. Those change meaning, and the user decides. Present them at the review gate with your suggestion and wait.

Reference files

Read one only when the task reaches it. Do not read them all up front.

  • references/phase-0-discovery.md - scope questions and configuration
  • references/phases-1-3-scanning.md - the nine domains, scanning, scoring
  • references/phase-3-review-gate.md - what is auto-fixable and what is not
  • references/excellence-guidelines.md - the quality bar for rewritten text
  • references/dispatch-matrix.md - the full roster of skills you can dispatch

Output contract

Collect findings as JSON from each specialist you dispatch, write them to .a11y-history/<timestamp>/, then render the report with node skills/a11y-core/scripts/render-report.mjs. Do not type the report by hand.

Shared rules, dispatch contract and schemas: skills/a11y-core/SKILL.md. Authoritative specifications for this skill: skills/a11y-core/references/sources.md.

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Markdown A11y Assistant AI skill do?

Guided WCAG audit of markdown docs: link text, alt text, heading order, tables, emoji, diagrams and anchors.

Why use Markdown A11y Assistant on TypingMind?

Because you install it once and use it with any model. Markdown A11y Assistant is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Markdown A11y Assistant in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/Community-Access/accessibility-agents/tree/main/skills/markdown-a11y-assistant. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Markdown A11y Assistant?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Markdown A11y Assistant?

As many as you like. As long as a model supports skills, you can use Markdown A11y Assistant with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Markdown A11y Assistant AI skill free?

Yes. It is published on GitHub by Community-Access under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇