Skip to main content
skill CX Codex

verifying-markdown-formatting — Claude Code skill: check Markdown

Walks a Markdown file through a formatting checklist and fixes what it finds: headings, lists, links, code blocks, spacing. Useful before committing a README or docs.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add spencerpauly/awesome-cursor-skills --skill verifying-markdown-formatting -a claude-code
Open on GitHub

What verifying-markdown-formatting does

The skill reads the target file and goes down a checklist. Structure: exactly one # H1 at the top, heading levels that step by one, a blank line before and after every heading, code block, list and blockquote, and a single trailing newline.

Lists keep one marker throughout, nested items indent by 2 or 4 spaces, and the first top-level item gets a blank line above it. Links with empty display text and bare URLs outside code blocks get flagged. Fenced blocks must use triple backticks and carry a language identifier; bold is **text**, italic is *text*, no trailing whitespace. Tables and horizontal rules are on the list too.

Then the agent applies exact string replacements, re-reads the file and reports what changed and what was already fine. It is formatting-only: content accuracy, broken links and spelling stay out of scope. Your section order is preserved, and when list markers are mixed it follows whichever style the file already uses most.

What it helps with

  • bring a README to one heading and list style
  • strip trailing whitespace and stray blank lines
  • add a language to every fenced code block
  • catch links with empty text and bare URLs
  • align tables and horizontal rules

Example prompts for the agent

  • check the formatting in docs/setup.md and fix what you find
  • run the skill's checklist over README.md
  • clean up the Markdown in CHANGELOG.md, leave the structure alone

How to install verifying-markdown-formatting

1Skills CLI (Vercel)

npx skills add spencerpauly/awesome-cursor-skills --skill verifying-markdown-formatting -a claude-code

2Manually: put the files in place

~/.claude/skills/verifying-markdown-formatting/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/verifying-markdown-formatting/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about verifying-markdown-formatting

How do I install verifying-markdown-formatting in Claude?

Run npx skills add spencerpauly/awesome-cursor-skills --skill verifying-markdown-formatting -a claude-code. The skill lands in ~/.claude/skills/verifying-markdown-formatting/SKILL.md.

What does verifying-markdown-formatting do?

It checks a Markdown file against a checklist: headings, lists, links and images, code blocks, tables, horizontal rules, whitespace. Issues are fixed with exact string replacements, then the file is re-read.

Does it check content or only formatting?

Formatting only. It does not validate content accuracy, broken links or spelling, and it keeps the author's section structure as is.

Source text

SKILL.md · CC0-1.0
---
name: verifying-markdown-formatting
description: Verify that a Markdown file has correct formatting — headings, lists, links, code blocks, spacing, and consistent style.
user-invocable: true
---

# Verifying Markdown Formatting

Check a Markdown file for formatting issues and fix them.

## What to Check

### Structure

- [ ] Exactly one `# H1` heading at the top of the file
- [ ] Headings increment by one level (no jumping from `##` to `####`)
- [ ] Blank line before and after every heading
- [ ] Blank line before and after every code block, list, and blockquote
- [ ] File ends with a single trailing newline

### Lists

- [ ] Consistent marker style within each list (`-` not mixed with `*` or `+`)
- [ ] Nested items indented with 2 or 4 spaces (consistent throughout)
- [ ] Blank line before the first item in a top-level list
- [ ] No blank lines between items in a tight list (or all items separated — pick one)

### Links & Images

- [ ] All links have non-empty display text: `[text](url)` not `[](url)`
- [ ] No bare URLs outside of code blocks — wrap in `<url>` or `[text](url)`
- [ ] Reference-style links have matching definitions
- [ ] Image alt text is present: `![alt](src)` not `![](src)`

### Code Blocks

- [ ] Fenced code blocks use triple backticks, not tildes
- [ ] Language identifier is present on every fenced block (` ```python `, ` ```bash `, etc.)
- [ ] Inline code uses single backticks for short references
- [ ] No indented code blocks (use fenced instead for clarity)

### Formatting

- [ ] Bold uses `**text**` not `__text__`
- [ ] Italic uses `*text*` not `_text_`
- [ ] No trailing whitespace on any line
- [ ] Lines under 120 characters where practical (prose, not tables)
- [ ] Consistent use of ATX-style headings (`# Heading`, not underline style)

### Tables

- [ ] Header row has separator row with `---` in each column
- [ ] Cell content is trimmed (no excessive padding)
- [ ] Column alignment markers (`:---`, `:---:`, `---:`) used consistently if present

### Horizontal Rules

- [ ] Use `---` on its own line with blank lines above and below
- [ ] Consistent style (don't mix `---`, `***`, `___`)

## Workflow

1. Read the target Markdown file
2. Walk through each check above
3. Fix any issues found using exact string replacements
4. Re-read the file to confirm all fixes applied cleanly
5. Report what was fixed and what was already correct

## Notes

- This skill is formatting-only — it does not validate content accuracy, broken links, or spelling
- Preserve the author's intended structure; don't reorganize sections
- When fixing list markers, match whatever style the file already uses most

© spencerpauly · CC0-1.0 · spencerpauly/awesome-cursor-skills

Similar skills

Everything for Writing and docs →

From the same set60

parallel-test-fixing The skill runs your test suite and assigns each failing test file to a separate subagent for parallel fixes. It helps when multiple test files break simultaneously across a codebase. CX Codex +1 412installs profiling-performance This skill profiles web application CPU performance using browser MCP tools. It captures call stacks and pinpoints slow functions causing interface lag. CX Codex +1 410installs python-tdd-with-uv Runs your agent through red-green-refactor in Python and sets the project up on uv. Useful when tests come before the code. CX Codex +1 409installs recording-browser-flow-as-test Walks through browser interactions step by step via MCP and outputs a clean Playwright test based on accessibility tree selectors. CX Codex +1 406installs exporting-to-png Teaches the agent to render code snippets, Mermaid diagrams, terminal logs, and SVG files into PNG images via CLI utilities or headless browsers. CX Codex +1 401installs parallel-ci-triage Splits failed GitHub Actions jobs across parallel subagents, each fixing its own slice. Useful when CI breaks in several places at once. CX Codex +1 403installs screenshotting-changelog Builds a visual changelog for a pull request: captures pages before and after your UI edits and drops the image pairs into the PR body. CX Codex +1 401installs updating-npm-package Updates npm dependencies safely by checking npmjs.com and adapting to the version jump. It runs tests on minor updates and finds migration guides for major ones. CX Codex +1 398installs

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor