proofread

Identify and report quality issues in LaTeX, Quarto, Typst, and Markdown documents.

2|Updated Jan 27, 2026
One-click install
npx skills add https://github.com/clearsmog/claude-skills --skill proofread-clearsmog
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: proofread
Source: https://github.com/clearsmog/claude-skills/tree/main/proofread
Command: npx skills add https://github.com/clearsmog/claude-skills --skill proofread-clearsmog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The proofreading protocol identifies and reports quality issues in documents without modifying any source files, helping teams maintain clarity and consistency.

Core Features & Use Cases

  • Checks grammar, typos, overflow, and consistency across LaTeX, Quarto, Typst, and Markdown documents.
  • Produces detailed per-file quality reports that list issues with location, current text, and suggested fixes.
  • Saves reports to a dedicated quality_reports/ directory, preserving original sources for auditing and review.

Quick Start

Review a target document by running the proofreading pipeline to generate a report, then inspect quality_reports for results.

Frequently Asked Questions about proofread

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

FAQPage Schema
How do I check LaTeX and Quarto documents for grammar and typos without modifying the source files?

To check grammar and typos without modifying source files, run the proofreading pipeline on your LaTeX and Quarto documents. It scans the text and saves per-file quality reports to the quality_reports/ directory, leaving your original sources completely unchanged.

What is the best way to generate quality reports for Markdown and Typst academic writing projects?

Generating quality reports for Markdown and Typst academic writing is done by running the proofreading pipeline. It identifies consistency and overflow issues, then outputs detailed reports with suggested fixes into a dedicated quality_reports/ directory for easy review.

Can I use automated proofreading to detect text overflow and consistency issues across Slides and Quarto projects?

Yes, you can use automated proofreading to detect text overflow and consistency issues across Slides and Quarto projects. The pipeline checks these documents and produces detailed per-file reports highlighting location, current text, and suggested fixes.

Does the document quality checker support .tex, .qmd, .typ, and .md file formats?

Yes, the document quality checker supports .tex, .qmd, .typ, and .md file formats. It analyzes these files across your projects and generates corresponding markdown reports, such as FILENAME_report.md for .tex files and FILENAME_qmd_report.md for .qmd files.

How do I review suggested fixes after running a document proofreading scan?

To review suggested fixes after a document proofreading scan, navigate to the quality_reports/ directory. The pipeline saves detailed per-file markdown reports there, listing each issue's location, current text, and recommended corrections for your review.

Why should I use a non-destructive proofreading tool for academic writing and technical reports?

Using a non-destructive proofreading tool for academic writing preserves your original sources for auditing and review. It identifies grammar, typos, and consistency issues, generating separate per-file reports rather than directly editing your tracked documents.