← docsDocumentation

/html-manual

Self-contained interactive HTML from markdown contracts.

Generates standalone interactive HTML manuals from markdown contracts. Each HTML file is self-contained: Tailwind CSS via CDN, dark mode, glassmorphic cards, method/status badges. The human-facing companion to every .md file.

Category

Documentation

Execution

Markdown → self-contained .html

Goal

Produce a self-contained interactive visual HTML document from any markdown contract file.

Scope

Applies to

  • +SKILL.md files
  • +Reference docs
  • +Runbooks
  • +Any .md that needs a visual companion

Does not cover

  • −Already-HTML files
  • −Files outside the project structure

Triggers

"Generate HTML manual""Create visual companion""Visualize this contract"

Inputs

  • →Source .md file path
  • →Output .html path (convention: README.html or <filename>.html)

Invariants

  • 01Must be self-contained (single file, CDN deps only)
  • 02Must use dark mode (bg-zinc-950)
  • 03Must include glassmorphic styling
  • 04Source .md must link to .html under References

Procedure

  1. Step 1Read source markdown
  2. Step 2Parse contract sections (Goal, Procedure, etc.)
  3. Step 3Generate HTML with Tailwind CDN, dark mode, glassmorphic cards
  4. Step 4Add method/status badges for interactive elements
  5. Step 5Write .html file
  6. Step 6Update source .md to link to .html under References

Outputs

  • ▸Self-contained .html file
  • ▸Updated .md with reference link

Review Gate

  • [ ]HTML opens in browser without a server
  • [ ]Dark mode applied
  • [ ]All contract sections present
  • [ ]Source .md links to HTML companion