markdown-author

Enforce markdown linting and spelling standards with markdownlint-cli2 and cspell.

1|1|Updated Jan 3, 2026
One-click install
npx skills add https://github.com/mcj-coder/development-skills --skill markdown-author-mcj-coder
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-author
Source: https://github.com/mcj-coder/development-skills/tree/main/skills/markdown-author
Command: npx skills add https://github.com/mcj-coder/development-skills --skill markdown-author-mcj-coder

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill proactively enforces markdown linting rules and spelling standards as you write, preventing common errors before they are committed and saving you from tedious manual corrections.

Core Features & Use Cases

  • Proactive Linting: Catches and auto-fixes issues like line length, heading hierarchy, and trailing spaces as you type.
  • Spelling Enforcement: Integrates with cspell to catch and correct typos in real-time.
  • Blocking Violations: Prompts for necessary decisions on code fence languages, duplicate headings, or missing image alt text.
  • Use Case: When writing documentation or README files, this skill ensures consistency and correctness, making your markdown professional and error-free from the start.

Quick Start

Use the markdown-author skill to help you write and validate your markdown content.

Frequently Asked Questions about markdown-author

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

FAQPage Schema
How do I enforce markdown linting rules and spelling standards while writing documentation?

To enforce markdown linting and spelling standards during content creation, you can use a skill that integrates markdownlint-cli2 and cspell to proactively catch formatting issues and typos as you type. This prevents common errors before they are committed, saving you from tedious manual corrections and ensuring consistent documentation quality.

What is the best way to auto-fix markdown formatting issues like line length and heading hierarchy?

The best way to auto-fix markdown formatting issues like line length, heading hierarchy, and trailing spaces is through proactive linting with markdownlint-cli2. This mechanism catches and automatically corrects common structural errors as you write, ensuring your README files remain professional and error-free from the start.

How does cspell integration work for real-time spelling enforcement in markdown files?

Cspell integration works by checking your text against dictionary standards in real-time as you write markdown content. It catches and highlights typos immediately, allowing you to correct spelling errors proactively before committing your documentation, which maintains professional writing quality without manual proofreading.

How do I handle missing image alt text and duplicate headings when validating markdown?

To handle missing image alt text, duplicate headings, or undefined code fence languages during markdown validation, the skill uses blocking violations to prompt you for necessary decisions. This ensures critical structural requirements are met before the content is finalized, preventing accessibility and structural errors.

Do I need any external dependencies to use markdownlint-cli2 and cspell for documentation validation?

No external dependencies are required to use this markdown validation skill. It operates independently with internal scripts and references to manage configuration verification, enforce linting rules, and run spelling checks without requiring you to install or configure separate external tools in your environment.

When should I use an automated markdown linter instead of manually checking documentation?

You should use an automated markdown linter instead of manual checks whenever you are writing documentation or README files that require strict consistency. It proactively enforces project standards, auto-fixes common formatting issues, and blocks critical structural violations, making it ideal for maintaining professional quality across large or collaborative projects.