html-report
Skill0 starsChanged 24 days agoMITView on GitHub
Use when the user wants a report, findings write-up, review, plan or analysis delivered as a standalone .html page (e.g. "zapisz do .html", "save as HTML I can send to the PO", "zrób wersję PL i EN", "add an edit mode like the ERP viewer") — from a Markdown file or from content just written in chat.
- Installs packages
19 other projects use a version of this.
Adopted by
Most recently taken up by
- mikejhill/agent-skillstheir own version, first seen Nov 15, 2026
- dmoreq/precepttheir own version, first seen Nov 15, 2026
- jameswyse/skillstheir own version, first seen Nov 15, 2026
- Makkov-design/makkov-harnesstheir own version, first seen Nov 15, 2026
- databricks-industry-solutions/vital-skillstheir own version, first seen Nov 15, 2026
- rodeyseijkens/skillstheir own version, first seen Nov 9, 2026
Other versions19 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 19
- HHU3637kr/skills★ 148same name
- anton-abyzov/vskill★ 47same name
- voidful/claude-html-report-skill★ 19same name
- databricks-industry-solutions/vital-skills★ 9same name
- Makkov-design/makkov-harness★ 8same name
- costiash/eliviz★ 7same name
- rodeyseijkens/skills★ 2same name
- addisonk/skills★ 1same name
- ianneub/claude-skills★ 1same name
- jameswyse/skills★ 1same name
9 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository2 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- code-reviewSkill
The file
We split this skill into the rules it gives an agent
3 rules. 0 are common, 1 is distinctive, and 2 are very specific to this project.
0
Common
Most of the 17 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 16
NOT for web apps, live dashboards, slides, or when the user asks for an Artifact.
- Very specific: line 63
Keep cards / items fences at top level of a section (not inside lists or quotes).
- Very specific: line 69
Always on. Floating button → toolbar: change counter, Save draft (localStorage, Ctrl+S), Export HTML (<name>-edited-<timestamp>.html, edits …
“Common” is measured: kept by at least 6 in 10 of the 17 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
html-report
Markdown → one self-contained HTML file with a fixed report design (hero + meta cards, TOC, numbered finding cards, ID-tagged items, badges, callouts, scrollable tables, OS-following light/dark, A4 print) and a built-in Edit Mode (in-browser editing, localStorage draft, restore on reload, export edited copy). File paths in the text become links that are verified against the filesystem.
Core rule: write Markdown, run the script, never hand-write the page or a new generator. Without the script an agent needed a bespoke 45 KB generator, 32 tool calls and ~18 min for one page that matched nothing else; with it, one command per language and an identical design every time.
When to use
- A report / analysis / plan / review must leave the chat as
.html("a page I can send", "printable", "with edit mode", "PL + EN"). - NOT for web apps, live dashboards, slides, or when the user asks for an Artifact.
Workflow
- Source = Markdown, named after the subject. The output name is what the reader sees:
<topic-or-ticket-slug>.md→.html(neversample,report,output). Existing.mdwith a good name → use it; scratch/chat content → write it to that name where the HTML should live. Keep the source language. Move any trailing "generated on…" line into front matterfooter:. - Apply the conventions (table below); copy the skeleton of example.md.
Build:
python3 .claude/skills/html-report/build_report.py <slug>.md --root <repo root> [--lang en|pl] [--link-base URL] [--strict] [--theme NAME]--themelayersreport-<name>.cssover the default look. Available:theme look reach for it when engineeringspec-sheet: auto-numbered sections, hairline rules, single teal accent, no shadows technical / architecture reports paperwarm cream canvas, serif headings, booktabs tables, no panel fills decision records, PO-facing write-ups, long reading blueprintpure monochrome, faint drafting grid, right-aligned figures, dotted TOC leaders port maps, dependency matrices, table-heavy pages tuiGruvbox, box borders, .metaas a status bar,[!]callout labelsrunbooks, ops timelines, DevOps requests catppuccinofficial Latte / Mocha, ##heading markers, tree-shaped TOCcode reviews, bug write-ups, many code spans riviera1930s travel poster: sand, navy, terracotta, postcard cards retros, summaries meant to be enjoyed brutal3px borders, hard offset shadows, flat saturated states short reviews and checklists, under ~3 pages Every theme carries its own light, dark and print palettes; all pass WCAG AA on the fixture. Themes are auto-discovered from the skill dir, so a new look is a new
report-*.cssfile and never an edit toreport.css, which is the shared default and would restyle every past report. Only pass a theme when the user asks for one. To restyle an already-built HTML whose.mdis gone, append the theme file inside its existing<style>block rather than hand-editing rules.--root= directorypath/file.ext:12-34spans resolve against. Link modes (the build prints which):--link-base https://<gitlab>/<grp>/<repo>/-/blob/<branch>/→ real URLs with working#Lanchors, use it whenever the file leaves the machine (only valid when--rootis a single git repo — in a multi-repo workspace the paths span several repos, so keep relative links and say so); otherwise links are relative (valid only while the file stays in the tree) or absolute when the output is far outside--root(dead anywhere else).--langoverrides front matterlang.- Act on the build report.
MISSING:= path absent under--root(left as plain code) → fix the path, or mark it intentional with`?path/file.py`(rendered as code, unverified).RANGE:= cited lines past end of file → open the file and cite the real span; never clamp to EOF. Exit 2 = unbalanced HTML → fix the Markdown (raw HTML / unclosed fence). Use--strictso leftovers fail the build. - Second language only when asked: translate into
<slug>_pl.md/<slug>_en.md, build with--lang, cross-link both with--pair HREF=LABEL(HREF relative to the output file; overrides front matterpair:). Translate prose, badge text, status, labels, callouts; keep IDs (A1/B2), code spans, paths, product and person names. Say the translation is unreviewed. - Report back in one place: file path(s) + size; MISSING/RANGE = 0; link mode used (and that relative/absolute links are dead in an e-mailed copy — use
--link-basefor that); Edit Mode caveats: the browser cannot overwrite the file (durable result = exported copy), drafts live in that browser for that file location (a mailed or exported copy starts clean), the PL/EN cross-link only works when both files sit together. No commit, no Artifact unless asked.
Verification beyond the built-in structural check is optional and only on request: serve the output dir with python3 -m http.server 8765 --bind 127.0.0.1 & (Playwright MCP refuses file://), stop it with kill <pid> — not pkill -f, which matches your own shell. Headless Chrome on a dark-GTK host renders dark by default; force --blink-settings=preferredColorScheme=1 for a light shot (0 is dark).
Needs markdown-it-py (pip install markdown-it-py); pyyaml optional.
theme-preview.md is the theme fixture: it exercises every construct the builder can emit. Build it with each theme after touching report.css or adding a theme — it is the only page that shows the whole surface at once.
Markdown conventions
| You write | You get |
Front matter title, subtitle, kicker, date, owner, scope, status, meta: {Label: value}, lang, footer, pair | Hero + meta cards. Value prefixed !warn / !ok / !bad / !part / !info renders as a badge (status: "!warn STOPPED — awaiting answers"). No title → first # H1 is promoted. |
## Heading | Section + TOC entry (auto; --no-toc to skip) |
```cards … ### Title + body … ``` | Grid of numbered finding cards (cards nonum = no numbers) |
```items … - **A1** **Title.** body … ``` | ID-tagged item list (proposals, questions, risks); title optional; continuation lines indented 2 spaces |
[[ok:exists]] [[bad:none]] [[part:partial]] [[warn:risk]] [[info:PO]] | Coloured pill badges |
> [!STOP] / > [!WARNING] / > [!OK] / > [!NOTE] + text | Callout (red / amber / green / neutral) |
`dir/file.ext:12-34` inline code (needs a / and extension) | Verified link with #L12-34; unresolved → plain code + MISSING; `?dir/file.ext` → plain code, unverified |
| GFM table | Scrollable table, th scope="col" |
Register ID (D-01, OP-44, R-50, A3-10) leading a table row or a bold list item | Anchor id="ref-<ID>" at that definition; every mention elsewhere becomes a cross-link (--no-refs to skip). Only IDs that got an anchor are linked, so AC-3 or F8-2 stay plain unless they are defined the same way. First definition wins — a table row beats a bold list item, and among equals the earliest one; put the canonical register first if you care where mentions land. A competing later definition is left as plain text, never linked to its rival. |
Keep cards / items fences at top level of a section (not inside lists or quotes).
Edit Mode
Foreign markup entering the page — paste, drag-and-drop, restoring a draft — is run through an allow-list sanitizer (no scripts, event handlers or scriptable URLs) before it touches the live DOM; drafts are stored sanitized too.
Always on. Floating button → toolbar: change counter, Save draft (localStorage, Ctrl+S), Export HTML (<name>-edited-<timestamp>.html, edits baked in, Edit Mode kept), Reset, Exit; restore prompt on reload; unsaved-changes guard; hidden in print. Editable: headings, paragraphs, cards, items, table cells incl. headers, callouts, meta cards, footer.
Common mistakes
| Mistake | Fix |
| Writing a bespoke generator or hand-crafted HTML "because the request is a bit different" | Extend the Markdown, not the tooling; the script already covers header, TOC, cards, items, badges, callouts, links, edit mode, validation. |
| Paths as prose ("see ingestion.py line 58") | Code-span form `platform/x/ingestion.py:58` → verified link. |
| "Fixing" a RANGE by clamping to the file length | Read the file; cite the real span. |
| Delivering with MISSING/RANGE lines in the output | Each is a wrong reference for the reader — fix, or ?-mark as intentional. |
| Relative links in a file that will be e-mailed | Build with --link-base (GitLab blob URL). |
Translating by editing the built .html | Translate the .md, rebuild; otherwise the pair drifts. |
Inventing output names (report.en.html, sample.html) | <slug>.html + <slug>_pl.html / _en.html, cross-linked via --pair. |
/html-report <source.md> [--root DIR] [--lang pl|en] — treat $ARGUMENTS as build arguments; with no source file, first write the chat content to Markdown (step 1).
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

