BrianArfi

Animated Readme — Documentation skill for Claude Code

Documentation community

Write or rewrite this project's README with animated GIFs (hero, before and after, how it works) rendered from HTML.

How to install Animated Readme

Installs to ~/.claude/skills/brianarfi-animated-readme-animated-readme/SKILL.md

Terminal

mkdir -p ~/.claude/skills/brianarfi-animated-readme-animated-readme && curl -fsSL https://raw.githubusercontent.com/BrianArfi/animated-readme/HEAD/commands/animated-readme.md -o ~/.claude/skills/brianarfi-animated-readme-animated-readme/SKILL.md

Restart Claude Code, or start a new session, for it to be picked up.

What Animated Readme does

description: Write or rewrite this project's README with animated GIFs (hero, before and after, how it works) rendered from HTML argument-hint: "[optional: what to focus on, or 'render' to only re-render the GIFs]"

Follow the `animated-readme` skill (`.claude/skills/animated-readme/SKILL.md`).

With no argument: run the full loop, from reading the project to showing the user the README.
With render: skip the writing. Run render.py --check and render.py on the existing `readm

Alternatives in Documentation

Doc Co-authoring — Guide users through structured workflow for co-authoring documentation 94.1k ★
Docs Serve — Build the HTML documentation and then serve it locally so it can be viewed in a browser 1.1k ★
Xiaohu Wechat Format — Claude Code 公众号一键排版+发布技能 Markdown → 微信兼容 HTML → 推送草稿箱 30 套主题 + 可视化画廊 428 ★