review-md

Check Markdown files for typos and textlint rule violations.

Updated Dec 5, 2020
One-click install
npx skills add https://github.com/yumechi/zenn-content --skill review-md
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-md
Source: https://github.com/yumechi/zenn-content/tree/main/.claude/skills/review-md
Command: npx skills add https://github.com/yumechi/zenn-content --skill review-md

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires textlint, and includes scripts (resource) components.

What problem does it solve?

This Skill automates the tedious process of proofreading Markdown files for typos, grammatical errors, and stylistic inconsistencies, ensuring high-quality content.

Core Features & Use Cases

  • Automated Proofreading: Detects and suggests corrections for typos, spelling mistakes, and grammatical errors.
  • Textlint Integration: Enforces consistent writing style and identifies rule violations using textlint.
  • Use Case: Before publishing a blog post on Zenn, use this skill to automatically scan it for errors and ensure it adheres to your preferred writing style.

Quick Start

Use the review-md skill to check the markdown file named my-article.md.

Frequently Asked Questions about review-md

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

FAQPage Schema
How do I proofread Markdown files for typos and style violations before publishing?

Markdown proofreading detects typos, spelling mistakes, and grammatical errors using textlint integration to enforce consistent writing style and identify rule violations in your article files.

Can I use textlint to automate typo checks for Zenn articles?

Yes, textlint automates typo checks and style enforcement for Zenn articles by scanning specified Markdown files to detect spelling mistakes and textlint rule violations before publication.

Do I need pnpm to run automated textlint checks on Markdown content?

Yes, pnpm is required to perform automated proofreading and style enforcement with textlint on specified article files, serving as the package manager for the textlint dependency.

What is the best way to check spelling errors in Markdown content automatically?

Automated proofreading with textlint is the best way to check spelling errors in Markdown content, applying rule-based style enforcement to ensure high-quality content creation and editing workflows.

Why does textlint rule enforcement fail on my Markdown files?

textlint rule enforcement may fail if pnpm is not properly configured or if the specified Markdown files contain syntax that prevents the textlint parser from scanning typos and rule violations correctly.