Markdown Docs Analyzer skill for Claude and Codex
Maps a Markdown file into structured JSON: the heading tree, every external link, the languages used in code blocks, and the URLs that look broken, so you can…
Install it once and Claude or Codex runs it for you. When your request matches, your AI loads the skill, asks for anything it is missing, and works through the template itself. Prefer to fill it in by hand? See the full prompt template.
Download the skill (.zip) · View SKILL.md
When it is used
Use when a Markdown file needs a structural inventory as JSON: heading tree, link list, code block languages, and suspect URLs. Do not use for a pass or fail lint report, or rewriting the document itself. Related topics: coding, markdown.
What it will ask you for
- Document (longer free text)
- Include heading hierarchy (choose one: Yes, No)
- List external links (choose one: Yes, No)
- Flag broken links (choose one: Yes, No)
- Code block languages to count (choose any: JavaScript, Python, HTML, CSS, Other)
- Output depth (choose one: Summary, Detailed, Full)
How it works
- Parse every heading with its level and line number and build the tree, noting skipped levels.
- Collect inline, reference, and bare URLs with their type (internal or external) and the line they sit on.
- Mark links as broken when an anchor has no matching heading or a URL is malformed, and label unfetched external links as unverified.
- Count fenced code blocks per language tag, folding unselected languages into Other and untagged fences into their own count.
- Emit one JSON object with the keys headings, links, broken_links, code_blocks, and summary, sized to the chosen output depth.
What you get
A single JSON object with keys headings (array), links (array), broken_links (array), code_blocks (object of language to count), and summary (string), with detail scaled to the selected depth.
What it watches out for
- Claiming an external URL is live when nothing fetched it; only anchors and malformed URLs can be judged from the text.
- Reading a # inside a fenced code block as a heading, which corrupts the tree.
- Dropping reference-style links because only the inline syntax was searched for.
How to install
Claude.ai and the Claude desktop app
- Download the skill .zip.
- Open Settings, then Capabilities, and find Skills.
- Choose Upload skill and select the .zip.
- Ask Claude for help with the task. It loads the skill when your request matches.
Claude Code
- Download the skill .zip.
- Unzip it into ~/.claude/skills/ (or .claude/skills/ inside a project).
- Start a new session. Claude Code loads the skill when your request matches.
Codex
- Download the skill .zip.
- Unzip it into ~/.agents/skills/ (or .agents/skills/ inside a project).
- Codex picks it up on its own. Type $ and the skill name to use it, or just ask for the task.
Cursor
- Download the Cursor rule (.mdc).
- Save it in .cursor/rules/ inside your project.
- Cursor's agent applies the rule when your request matches its description.
AGENTS.md (Codex, Cursor, and other coding agents)
- Copy the AGENTS.md section.
- Paste it into AGENTS.md at the root of your repository, creating the file if needed.
- Coding agents that read AGENTS.md follow it when your request fits.