
html-doc
Generates a polished, static HTML reading view from an existing Markdown PRD or technical design. Use when a user asks to render, present, visualize, or make a PRD or design document easier for humans to read in a browser.
- Installs
- 259
- Last 24h
- —
- Trending rank
- —
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/owainlewis/blueprint --skill html-doc- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads html-doc automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
HTML document
Turn one complete Markdown PRD or technical design into one verified static HTML page. Keep Markdown canonical. Change presentation, not meaning.
Boundaries
- Accept an existing Markdown file or exact inline Markdown.
- Support only
prdanddesigndocument kinds. - For
REQUIREMENTS.md, pass--kind prd. ForARCHITECTURE.mdorspec.md, pass--kind design. - Classify
prd.mdasprdanddesign.mdasdesign. For other names, use the request or ask if the kind is unclear. - Do not write requirements, settle design choices, summarize missing content, or edit the source.
- If the source is only a rough brief, use the appropriate authoring skill first.
- Do not hand-edit generated HTML. Change the template or renderer, then regenerate.
- Do not publish or host the result unless the user separately asks.
Requirements
Generation requires Python 3.11 or newer, Pandoc 3 or newer, Node.js 22.12 or newer, and npm. The skill directory contains a locked Mermaid dependency tree.
Before the first Mermaid render, run:
npm ci --prefix <skill-directory>
Use scripts/html_doc.py from this skill directory for all generation and lifecycle operations.
Workflow
1. Read and classify the source
Read the complete source. Confirm it is no larger than 2 MiB. Determine the document kind from the request or the basename mappings above.
Treat content problems separately from presentation problems. If the Markdown contradicts itself, omits a required decision, or contains an invalid diagram, report that source problem. Do not silently repair its meaning.
2. Create a candidate
For a file source:
python3 <skill-directory>/scripts/html_doc.py render <source.md> --kind <prd-or-design> --out <output.html>
--kind may be omitted only for exact prd.md and design.md basenames. --out may be omitted to create a sibling HTML file.
For exact inline Markdown, pipe it through standard input and provide both kind and output:
python3 <skill-directory>/scripts/html_doc.py render --inline --kind <prd-or-design> --out <output.html>
The command returns JSON containing candidate, output, and token. It does not replace the final output. Keep those exact values for verification and finalization.
If an output lock already exists, do not delete it automatically. It may represent another pending render. Report its path. Use discard --force-stale only when the state is known to be abandoned.
3. Verify the candidate in a real browser
Open the candidate as a local file. Do not treat source inspection as browser proof.
Check all of these:
- desktop at 1440 CSS pixels;
- tablet at 768 CSS pixels;
- mobile at 390 CSS pixels;
- A4 and US Letter print preview;
- table-of-contents links and section targets;
- keyboard order from skip link through navigation and document links;
- visible focus indicators;
- one
mainlandmark and a sensible heading outline; - unique DOM IDs;
- horizontal overflow, clipped text, code, tables, and diagrams;
- useful diagram alternatives and accessible disclosure controls;
- console errors and failed resource requests;
- operation with browser network access disabled.
Compare the canonical content inside main with the Markdown abstract syntax tree. Navigation, source metadata, and derived accessibility text are not canonical content. Each top-level source block must map to one ordered data-source-block node with its SHA-256 identity and nested content intact. A Mermaid block maps to one figure whose exact source appears once in its disclosure.
If a presentation defect comes from the shared renderer or styles, fix that source and regenerate. If it is a content defect, leave the source and candidate unchanged and report it.
4. Finalize or discard
Only after every check passes, atomically install the candidate:
python3 <skill-directory>/scripts/html_doc.py finalize --out <output.html> --token <token>
If any check fails, remove only this pending candidate:
python3 <skill-directory>/scripts/html_doc.py discard --out <output.html> --token <token>
Finalization performs one same-directory atomic replacement. It never deletes the previous output first. A failed render, check, or replacement must leave the previous verified output byte-for-byte unchanged.
Output standard
The final page must:
- preserve source wording and order;
- use canonical
prdordesignmachine metadata; - record the source path and SHA-256 hash;
- use semantic HTML, inline CSS, and no runtime JavaScript;
- contain no external runtime assets;
- use a restrained blue-grey visual system;
- remain readable without color, a mouse, a wide screen, or network access;
- include responsive and print styles;
- embed validated Mermaid SVG as a base64 image and retain the exact source in a disclosure.
Return
Stop when the verified candidate is finalized. Report the output path, source hash, and browser checks performed.
FAQ
What does the html-doc skill do?
Generates a polished, static HTML reading view from an existing Markdown PRD or technical design. Use when a user asks to render, present, visualize, or make a PRD or design document easier for humans to read in a browser.
How do I install html-doc?
Run npx skills add https://github.com/owainlewis/blueprint --skill html-doc in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/html-doc/ (personal) or .claude/skills/html-doc/ (project).
Which AI agents can use html-doc?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is html-doc safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains html-doc?
It is published by owainlewis in owainlewis/blueprint. It has 259 recorded installs.
More from owainlewis/blueprint
review
owainlewis/blueprint
Uses a fresh agent to review an implementation change without editing it. Checks behavior, security, regressions, complexity, tests, docs, and missing proof. Use for code, PR, diff, security, second-opinion, or pre-merge reviews.
plan
owainlewis/blueprint
Turns a reviewed spec or decided brief into ordered tasks for separate agent runs. Use for implementation tasks, tracker tickets, or useful milestones. Do not use for one coding task or its short execution outline.
task-to-pr
owainlewis/blueprint
Open the skill to read its SKILL.md instructions.
spec
owainlewis/blueprint
Open the skill to read its SKILL.md instructions.
refactor
owainlewis/blueprint
Improve the shape of existing code without changing behavior.
Popular frontend & design skills
setup-matt-pocock-skills
mattpocock/skills
Configure this repo for the engineering skills: set up its issue tracker, triage label vocabulary, and domain doc layout. Run once before first use of the other engineering skills.
frontend-design
anthropics/skills
Guidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.
hyperframes-animation
heygen-com/hyperframes
All animation knowledge for HyperFrames — atomic motion rules, multi-phase scene blueprints, scene transitions, broader motion-design techniques, AND the seven runtime adapters (GSAP default, plus Lottie, Three.js, Anime.js, CSS keyframes, Web Animations API, TypeGPU). Use for any motion or animation task: pick 2-4 rules and compose, or load a blueprint, or look up runtime-specific API (e.g. GSAP eases / Lottie player / Three.js mixer). Also covers auditing an existing composition's choreography (animation map) and 24 named text-animation effects. HyperFrames-native: single paused timeline, seek-safe, deterministic.
prototype
mattpocock/skills
Build a throwaway prototype to answer a design question. Use when the user wants to sanity-check whether a state model or logic feels right, or explore what a UI should look like.
hyperframes-core
heygen-com/hyperframes
The HyperFrames composition contract — build one renderable project. Use for composition structure, the data- timing attributes, class="clip", tracks, sub-compositions, variables, framework-owned media playback, deterministic-render rules, and validation. Read before writing composition HTML.
vercel-react-best-practices
vercel-labs/agent-skills
React and Next.js performance optimization guidelines from Vercel Engineering. This skill should be used when writing, reviewing, or refactoring React/Next.js code to ensure optimal performance patterns. Triggers on tasks involving React components, Next.js pages, data fetching, bundle optimization, or performance improvements.