Markdown Docs Builder skill for Claude and Codex
Assembles a project README from the pieces you already have (overview, install, usage, API, license) into one consistent Markdown file with a table of…
Install it once and Claude or Codex runs it for you. When your request matches, your AI loads the skill, asks for anything it is missing, and works through the template itself. Prefer to fill it in by hand? See the full prompt template.
Download the skill (.zip) · View SKILL.md
When it is used
Use when a project README needs assembling from an overview, install steps, usage examples, and an API list that already exist as rough text. Do not use for writing documentation from a bare outline, or auditing an existing README. Related topics: coding, markdown.
What it will ask you for
- Project name (free text, e.g. "MyProject")
- Overview (longer free text)
- Installation steps (longer free text)
- Usage examples (longer free text)
- API reference (longer free text)
- License type (choose one: MIT, Apache 2.0, GPLv3, Proprietary)
How it works
- Place the supplied pieces into the fixed section order: title, overview, table of contents, Installation, Usage, API Reference, License.
- Wrap every command and code sample in a tagged fenced block without altering the commands themselves.
- Convert the API reference into one H3 per item with its signature in a code span and a one-sentence description.
- Normalize heading levels, bullet style, and spacing so the README reads consistently, and add the license line.
- Return the whole file as one four-backtick fenced block tagged markdown with no commentary around it.
What you get
One fenced code block tagged markdown containing the complete README: H1, overview, table of contents, Installation, Usage, API Reference, License.
What it watches out for
- Rewriting install commands to what seems standard, which breaks the project's actual setup.
- Nesting a fenced block inside the outer markdown fence with the same backtick count, which ends the block early.
- Leaving the table of contents out of sync with the sections after reordering.
How to install
Claude.ai and the Claude desktop app
- Download the skill .zip.
- Open Settings, then Capabilities, and find Skills.
- Choose Upload skill and select the .zip.
- Ask Claude for help with the task. It loads the skill when your request matches.
Claude Code
- Download the skill .zip.
- Unzip it into ~/.claude/skills/ (or .claude/skills/ inside a project).
- Start a new session. Claude Code loads the skill when your request matches.
Codex
- Download the skill .zip.
- Unzip it into ~/.agents/skills/ (or .agents/skills/ inside a project).
- Codex picks it up on its own. Type $ and the skill name to use it, or just ask for the task.
Cursor
- Download the Cursor rule (.mdc).
- Save it in .cursor/rules/ inside your project.
- Cursor's agent applies the rule when your request matches its description.
AGENTS.md (Codex, Cursor, and other coding agents)
- Copy the AGENTS.md section.
- Paste it into AGENTS.md at the root of your repository, creating the file if needed.
- Coding agents that read AGENTS.md follow it when your request fits.