dev-markdown_check

Validate and correct Markdown syntax, structure, and links with Python scripts.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/LannieYoo/gangwon-business-portal --skill dev-markdown-check
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dev-markdown_check
Source: https://github.com/LannieYoo/gangwon-business-portal/tree/main/.agent/skills/dev-markdown_check
Command: npx skills add https://github.com/LannieYoo/gangwon-business-portal --skill dev-markdown-check

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill addresses the common issues of syntax errors, structural inconsistencies, and formatting problems in Markdown files, ensuring documents are readable, maintainable, and adhere to best practices.

Core Features & Use Cases

  • Syntax Validation: Checks for common Markdown syntax errors.
  • Structure Verification: Ensures proper heading hierarchy and list formatting.
  • Link & Image Checks: Validates the existence and correctness of internal links and image paths.
  • Formatting Fixes: Automatically corrects issues like trailing whitespace and inconsistent list markers.
  • Use Case: After generating a README file for a new project, use this Skill to automatically check for and fix any formatting errors, broken links, or structural issues before committing.

Quick Start

Run the quick fix script on the 'README.md' file to automatically correct common markdown formatting issues.

Frequently Asked Questions about dev-markdown_check

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

FAQPage Schema
How do I fix markdown formatting errors like trailing whitespace and inconsistent list markers?

To fix markdown formatting errors, run the quick fix script to automatically correct issues like trailing whitespace and inconsistent list markers. This ensures your documents maintain proper syntax and adhere to best practices.

How do I check markdown heading hierarchy and structure before committing?

Check markdown heading hierarchy and structure by using the validation scripts to verify proper formatting. This ensures structural consistency in your documents, making them readable and maintainable before you commit changes.

How do I validate internal links and image paths in a markdown file?

Validate internal links and image paths by running the link and image checks. This functionality verifies the existence and correctness of references within your markdown files to prevent broken navigation.

Can I use markdown validation for PDF conversion quality assurance?

Yes, you can use markdown validation for PDF conversion quality assurance. The scripts support integration with PDF conversion workflows to check syntax and structure post-conversion.

What is the best way to automate markdown linting for a project README?

The best way to automate markdown linting for a project README is to execute the quick fix script. It automatically detects and resolves syntax errors, broken links, and structural issues in the file.

Why does markdown syntax validation fail on broken links?

Markdown syntax validation fails on broken links because the validation process checks the existence and correctness of internal links and image paths. Fixing these references ensures document readability and prevents structural inconsistencies.