Agent skill

Readme Beautifier

by hylarucoder in hylarucoder/hai-stack

Reformats and restructures a README or similar Markdown project document without changing its factual content, voice, or scope, then summarizes formatting-only edits.

Custom licenceAuto-check passedDevelopment

Install Readme Beautifier

skills CLI
$ npx skills add hylarucoder/hai-stack --skill readme-beautifier -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install hylarucoder/hai-stack readme-beautifier --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/hylarucoder/hai-stack.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/readme-beautifier .claude/skills/readme-beautifier && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
readme-beautifier
GitHub stars
382
Token cost
~1.8k tokens
SKILL.md length
938 words
Files
2 (incl. references)
Skills in repo
18
Repo updated
First seen
Licence
Custom licence

At a glance

Reformats and restructures a README or similar Markdown project document without changing its factual content, voice, or scope, then summarizes formatting-only edits.

  • Works in 10 steps: Heading hierarchy → One-line description → Section structure → …
  • The user asks to beautify
  • SKILL.md covers Overview, Core Principles, Workflow and Checklist, plus 4 more sections
  • Calls bash

What it does

Readme Beautifier is an agent skill from hylarucoder/hai-stack. Reformats and restructures a README or similar Markdown project document without changing its factual content, voice, or scope, then summarizes formatting-only edits. Use when the user asks to beautify, tidy, organize, or professionally format a README(README 美化、排版、格式化、太乱了). Use document-audit skills to judge correctness or consistency, and hai-rewrite-doc when meaning or claims must change.

Its SKILL.md is about 1.8k tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files, including reference files (for example `references/output-template.md`).

It sits in Development, covering Technical documentation.

When your agent uses it

  • The user asks to beautify
  • Professionally format a README(README 美化、排版、格式化、太乱了)

Example prompts

  • “Use the readme-beautifier skill to reformat and restructures a README or similar Markdown project document without changing its factual content…”
  • “/readme-beautifier”

Requirements

  • Docker

Workflow steps

10 steps, taken from the step headings in SKILL.md.

  1. Heading hierarchy
  2. One-line description
  3. Section structure
  4. List formatting
  5. Code blocks
  6. Tables
  7. Links and references
  8. Whitespace and separation
  9. Badges
  10. Table of contents (TOC)

What it can do on your machine

Read from SKILL.md and the folder at commit a6c7ed2. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • bash

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Readme Beautifier loads about 1.8k tokens when it runs, and up to ~2k if it reads all its reference files. Until then it costs about 103 tokens; SKILL.md has 938 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~103
When it runs · the whole SKILL.md, loaded when a task matches
~1.8k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~2k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 938 words (~1,750 tokens).

“Take a README whose structure is messy or whose formatting is inconsistent, and deliver a version with clear structure, consistent formatting, and a professional look.”

— opening of SKILL.md by hylarucoder, Custom licence
name
readme-beautifier

Read the full SKILL.md on GitHub

Files

SKILL.md and 1 other file (references) in skills/readme-beautifier of hylarucoder/hai-stack.

  • SKILL.md
  • references/output-template.md

Open the folder on GitHubat commit a6c7ed2

Compare with similar skills

Readme Beautifier next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Readme Beautifier compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Readme Beautifier this skillhylarucoder/hai-stack382—~1.8kAutomated safety check: PassCustom licence
Diagram Designcathrynlavery/diagram-design45k1 repos~7.5kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Get API Docs with chubandrewyng/context-hub14k2 repos~775Automated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.5kAutomated safety check: PassGPL-3.0

Similar skills

  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    45k GitHub starsUsed in 1 repo~7.5k tokens
    DevelopmentAuto-check passed
  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed
  • Get API Docs with chub

    andrewyng/context-hub

    Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.

    14k GitHub starsUsed in 2 repos~775 tokens
    DevelopmentAuto-check passed
  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed
  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.5k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 6 days ago
    DevelopmentAuto-check: notes

More from hylarucoder/hai-stack

All 18 skills in this repo
  • Verify a defined software change against requirements and produce a proportional, evidence-backed acceptance report with specification precedence, scope boundaries, requirement-to-evidence…

    382 GitHub stars~2.1k tokensUpdated 3 days ago
    Auto-check passed
  • Hai Ast Grep

    hylarucoder/hai-stack

    Produces a ready-to-run ast-grep command or reusable YAML lint/codemod rule, validated against positive and negative fixtures.

    382 GitHub stars~1.5k tokensUpdated 3 days ago
    Auto-check passed
  • Hai Visual Explainer

    hylarucoder/hai-stack

    Turns supplied content into self-contained HTML and PNG in two modes: card for one shareable frame(知识卡、信息卡、金句卡、封面、把要点做成一张图), report for multi-section documents(可视化报告、HTML 汇报页、PRD/计划/评审做成网页).

    382 GitHub stars~2k tokensUpdated 3 days ago
    Auto-check passed
  • Code Review And Quality

    hylarucoder/hai-stack

    Reviews a code change for correctness, security, maintainability, architecture, performance, and verification gaps, or performs a local code-smell review.

    382 GitHub stars~934 tokensUpdated 3 days ago
    Auto-check passed
  • Entity Model Auditor

    hylarucoder/hai-stack

    Audits an entity model field by field: what should exist, what exists now, where each value belongs (column, config, computed runtime value, or removal), and what must migrate.

    382 GitHub stars~1.5k tokensUpdated 3 days ago
    Auto-check passed
  • Geju

    hylarucoder/hai-stack

    Challenges an overly conservative, incremental, or compatibility-led proposal with a bold target model, a concrete kill/merge/split list, materially different options, and a falsifiable first proof…

    382 GitHub stars~1.8k tokensUpdated 3 days ago
    Auto-check passed

Categories

Questions about Readme Beautifier

What does Readme Beautifier do?

Reformats and restructures a README or similar Markdown project document without changing its factual content, voice, or scope, then summarizes formatting-only edits. Readme Beautifier is an agent skill from hylarucoder/hai-stack. Reformats and restructures a README or similar Markdown project document without changing its factual content, voice, or scope, then summarizes formatting-only edits.

When should I use Readme Beautifier?

Readme Beautifier fits situations like: the user asks to beautify; professionally format a README(README 美化、排版、格式化、太乱了).

How do I install Readme Beautifier in Claude Code?

Run `npx skills add hylarucoder/hai-stack --skill readme-beautifier -a claude-code`. Or copy the skill folder (skills/readme-beautifier in hylarucoder/hai-stack) into .claude/skills/readme-beautifier in your project. Claude Code loads it when a task matches its description.

How do I install Readme Beautifier in Codex?

Run `npx skills add hylarucoder/hai-stack --skill readme-beautifier -a codex`. Or copy the skill folder (skills/readme-beautifier in hylarucoder/hai-stack) into .agents/skills/readme-beautifier in your project. Codex loads it when a task matches its description.

Can I use Readme Beautifier in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add hylarucoder/hai-stack --skill readme-beautifier -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/readme-beautifier, .gemini/skills/readme-beautifier, .github/skills/readme-beautifier and .opencode/skills/readme-beautifier in your project.

What does Readme Beautifier need to run?

Going by SKILL.md and its folder, Readme Beautifier needs the command-line tools its instructions call (bash). Our summary lists: Docker.

Does Readme Beautifier access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Readme Beautifier safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Readme Beautifier use?

Readme Beautifier has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Readme Beautifier use?

About 1.8k tokens (SKILL.md is roughly 7k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 244 tokens, read only when the agent opens those files.

What are the alternatives to Readme Beautifier?

Skills that share tags, products or a category with Readme Beautifier: Diagram Design (cathrynlavery/diagram-design, 45k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Readme Beautifier?

hylarucoder (a GitHub user) maintains it in hylarucoder/hai-stack, which has 382 GitHub stars. The repository holds 18 skills in this directory. The repository was last updated on October 5, 2026.

Source: hylarucoder/hai-stack on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.