---
name: markdown-docs-builder
description: "Assembles a project README from the pieces you already have (overview, install, usage, API, license) into one consistent Markdown file with a table of contents, delivered as a single fenced block ready to paste. 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."
---

# Markdown Docs Builder

Assembles a project README from the pieces you already have (overview, install, usage, API, license) into one consistent Markdown file with a table of contents, delivered as a single fenced block ready to paste.

## When to use

Use this skill 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 it for writing documentation from a bare outline, or auditing an existing README.

## Workflow

1. Ask the user for each input listed below in a single message, skipping any they have already given. Where options are listed, offer them, but accept other answers too.
2. Place the supplied pieces into the fixed section order: title, overview, table of contents, Installation, Usage, API Reference, License.
3. Wrap every command and code sample in a tagged fenced block without altering the commands themselves.
4. Convert the API reference into one H3 per item with its signature in a code span and a one-sentence description.
5. Normalize heading levels, bullet style, and spacing so the README reads consistently, and add the license line.
6. Return the whole file as one four-backtick fenced block tagged markdown with no commentary around it.

## Inputs

- **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)

## Output

One fenced code block tagged markdown containing the complete README: H1, overview, table of contents, Installation, Usage, API Reference, License.

## Prompt template

Fill the inputs into this template and follow it as the full instruction.

### Markdown Docs Builder

Build my project README from these pieces.

- Project name: {{Project name}}
- Overview: {{Overview}}
- Installation steps: {{Installation steps}}
- Usage examples: {{Usage examples}}
- API reference: {{API reference}}
- License type: {{License type}}

Keep the author's facts and commands exactly as supplied; your job is structure and consistency, not invention. Lay the file out in this order: H1 with the project name, a one-paragraph overview, a table of contents, Installation, Usage, API Reference, License. Put every command in a fenced block tagged bash and every code sample in a block tagged with its language. Turn the API reference into one H3 per function or endpoint with its signature in a code span, then a sentence on what it does and a short parameter list. Normalize bullet style, heading levels, and spacing so the file reads as one voice. For the License section, name the license and state the one-line obligation it places on users (attribution, share-alike, or proprietary terms). Return the README as a single fenced code block tagged markdown and nothing else; use a four-backtick outer fence so the inner code blocks do not end it early.

## Pitfalls

- 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.
