rich-doc

Creates single-file interactive HTML documents with tabs, mermaid diagrams, and review threads.

Updated Apr 17, 2026
One-click install
npx skills add https://github.com/mistakenot/skills --skill rich-doc-mistakenot
Or copy as Structured Prompt for Agentβ–Ό
Please help me install this Agent Skill.
Skill: rich-doc
Source: https://github.com/mistakenot/skills/tree/main/plugins/rich-docs/skills/rich-doc
Command: npx skills add https://github.com/mistakenot/skills --skill rich-doc-mistakenot

SYSTEM DOCUMENTATION & REQUIREMENTS

πŸ’‘ This Skill includes scripts (resource) components.

What problem does it solve? Long design docs, plans, and reports written as plain text are hard to scan and review. This Skill renders them as a single self-contained HTML file with tabbed pages, diagrams, highlighted code, and inline comment threads, so reviewers absorb the content in minutes and leave feedback directly in the document. ## Core Features & Use Cases - Rich document rendering: Authors semantic markup using the pd-* web component library (tabs, mermaid diagrams, code blocks, API outlines, wireframes, CLI transcripts) loaded from a pinned CDN release β€” no CSS or JavaScript required. - Review workflow: Supports append-only comment threads, human-answerable questions, and authored decision records, with a paste-back protocol for merging reviewer comments exported from the browser. - Headless linting: Ships a Node CLI (scripts/pd-lint.mjs) that validates plan docs for untracked files, missing phase dependencies, dependency cycles, and open questions before handoff. - Use Case: Turn a design proposal into an interactive HTML doc with an architecture mermaid diagram, API outline, and review threads, then lint it and merge reviewer feedback pasted back as a DOC COMMENTS block. ## Quick Start Render this design document as a rich HTML doc with tabs, a mermaid architecture diagram, and a review thread section.

Frequently Asked Questions about rich-doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create an interactive HTML design doc with tabs and diagrams?β–Ό

Author semantic markup with the pd-* web components: wrap content in pd-doc, add one pd-tab per topic, and use pd-mermaid for diagrams and pd-code for snippets. The components load from a pinned CDN release, so no CSS or JavaScript is needed, and the file works opened directly from file://.

How do I render a plan or proposal as a single HTML file?β–Ό

Gather the source content, choose a tab structure, and write the doc using pd-* elements such as pd-section, pd-stepper for phases, and pd-files for file-change trees. Save it as a .html file and run the pd-lint.mjs script to catch consistency issues before sharing.

Does the rich doc renderer work offline or in sandboxed environments?β–Ό

The component reference is normally fetched from a pinned jsDelivr CDN tag. If the fetch fails, you can read the bundled pd-components/dist/llms.txt inside the skills repo, or fall back to the component index in SKILL.md while flagging that attributes may be stale.

How do reviewer comments get merged back into the HTML document?β–Ό

Reviewers comment in the browser and paste back a block delimited by DOC COMMENTS markers. Each REPLY, NEW comment, or ANSWER line maps to appending pd-comment, pd-thread, or pd-answer elements; existing comments are never edited or deleted so the decision log stays intact.

Why does the doc linter report unplanned-file or untracked-file errors?β–Ό

These errors mean the file tree and phase definitions are inconsistent: a pd-file entry is touched by no phase, or a phase references a file missing from the pd-files tree. Fix by aligning the pd-phase files attributes with the pd-files tree, then re-run pd-lint.mjs.

When should I not use rich HTML docs for planning content?β–Ό

Do not use it for markdown task docs β€” those belong to the new-task, new-solution, or new-plan skills. The rich doc renderer targets documents that benefit from interactive structure and review threads, not plain markdown workflow artifacts.