Fix Markdown

Automates Markdown cleanup by removing emojis, fixing headings, lists, and image alt text.

Updated Nov 14, 2024
One-click install
npx skills add https://github.com/nickromney/n-dotfiles --skill fix-markdown
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Fix Markdown
Source: https://github.com/nickromney/n-dotfiles/tree/main/claude/.claude/skills/fix-markdown
Command: npx skills add https://github.com/nickromney/n-dotfiles --skill fix-markdown

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires markdownlint-cli2, uv, and includes scripts (resource) and references (resource) components.

What problem does it solve?

AI-generated markdown often contains excessive emojis, inconsistent headings, and fails linting standards. This skill automates the cleanup and standardization of markdown files, ensuring your documentation is professional, consistent, and compliant with best practices.

Core Features & Use Cases

  • Automated Cleanup: Remove excessive emojis, fix duplicate H1 headings, convert bold text to proper headings, and standardize ordered lists (MD029).
  • Markdownlint Integration: Automatically fixes common markdownlint issues (MD025, MD029, MD045) and generates detailed reports for remaining problems.
  • Pre-commit Hooks: Set up Git pre-commit hooks to prevent future markdown quality issues and emoji usage before they enter your codebase.
  • Use Case: You've just generated a large documentation set using an AI, and it's full of emojis and inconsistent formatting. Use this skill to instantly clean and standardize all files, making them ready for publication or review.

Quick Start

Fix all markdown issues in the 'documentation/' directory, removing emojis and standardizing headings.

Frequently Asked Questions about Fix Markdown

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

FAQPage Schema
How do I fix markdown formatting issues like excessive emojis and inconsistent headings?

Fix Markdown automates cleanup of markdown files by removing emojis, standardizing headings, converting bold text to proper H1/H2 structure, and fixing ordered list numbering. It integrates with markdownlint to identify and resolve common linting violations (MD025, MD029, MD045) across documentation repositories in batch.

Can I use markdownlint to clean up AI-generated documentation automatically?

Yes. Fix Markdown wraps markdownlint-cli2 to automatically fix AI-generated markdown issues: duplicate H1 headings, missing alt text on images, mis-numbered lists, and emoji overuse. It processes entire directories and generates detailed reports of remaining violations.

How do I prevent markdown quality issues from entering my git repository?

Fix Markdown sets up Git pre-commit hooks that run markdownlint checks before commits, catching heading inconsistencies, emoji usage, and linting failures before they reach your codebase. This enforces documentation standards automatically across your team's workflow.

Does this skill handle markdown with frontmatter in documentation files?

Yes. Fix Markdown is frontmatter-aware and normalizes H1 headings to H2 when frontmatter is present, ensuring consistent heading hierarchy across documentation files that use YAML or TOML metadata blocks.

What markdown linting rules does this skill fix automatically?

Fix Markdown automatically corrects MD025 (duplicate headings), MD029 (ordered list markers), and MD045 (missing image alt text). It also removes excessive emojis and standardizes heading levels, then reports any remaining linting issues for manual review.

Related Skills