readme-beautifier

Restructures and reformats messy README files without changing their content.

Updated Jan 10, 2026
One-click install
npx skills add https://github.com/Rabbit-Ivan/Ivan-skills --skill readme-beautifier-rabbit-ivan
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-beautifier
Source: https://github.com/Rabbit-Ivan/Ivan-skills/tree/main/skills/readme-beautifier
Command: npx skills add https://github.com/Rabbit-Ivan/Ivan-skills --skill readme-beautifier-rabbit-ivan

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Messy READMEs with broken heading hierarchies, inconsistent lists, untagged code blocks, and sloppy whitespace make projects look unprofessional. This Skill fixes structure and formatting only — nothing added, nothing removed — so the document reads cleanly while the author's content and intent stay untouched. ## Core Features & Use Cases - Ten-point formatting checklist: Fixes heading hierarchy, one-line description placement, section structure, list formatting, code block language tags, tables, links, whitespace, badges, and table of contents. - Content-preserving guarantee: Never adds, deletes, translates, or rewrites technical content; only structure and formatting are adjusted. - Change summary output: Delivers the full beautified README plus a short summary of what changed and suggested follow-up additions. - Use Case: A user pastes a cluttered README and says "太乱了,帮我弄一下" — the Skill diagnoses every checklist item, applies minimal fixes, and returns a clean, professional README with a beautification summary. ## Quick Start Beautify and reformat my README.md file, fixing the heading structure, lists, and code blocks without changing any of the content.

Frequently Asked Questions about readme-beautifier

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

FAQPage Schema
How do I beautify a messy README file?▼

Provide the README content and ask for it to be beautified or tidied. The Skill runs a ten-item checklist covering headings, lists, code blocks, tables, links, and whitespace, then returns the full reformatted README plus a summary of changes.

How to fix README formatting without changing the content?▼

This Skill only adjusts structure and formatting — heading levels, list markers, code block language tags, spacing — and never adds, removes, translates, or rewrites content. The author's intent, tone, and technical details remain exactly as written.

Does README beautification work for Chinese or multilingual documents?▼

Yes, it handles Chinese and mixed-language READMEs, including consistent spacing between Chinese and English text based on the original's dominant style. It beautifies only the current file and never translates between languages.

What is the difference between beautifying and auditing a README?▼

Beautifying fixes formatting and structure only, never content correctness. To verify a README matches the actual code or config, use a docs-against-code audit skill; to check internal consistency of the docs themselves, use an internal docs audit skill.

When should a table of contents be added to a README?▼

A TOC is suggested only when the document has more than six sections; at six or fewer it is not added. If the original already has a TOC with broken anchor links, the anchors are repaired rather than the TOC being deleted.