doc-html-preview

Community

Generate dual HTML previews from markdown docs

Authorfreedomw1987
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill solves the problem of project documentation being trapped in markdown files that are hard for non-technical stakeholders to read and confirm. It automatically generates two versions of each document: a faithful engineering rendering for code review and a decision-oriented boss version with plain-language summaries, decision cards, and risk assessments.

Core Features & Use Cases

  • Dual HTML Generation: Produces both an engineering HTML (1:1 markdown render) and a boss HTML (summary cards, decisions, risks) for every document in docs/*.md.
  • Boss Summary JSON: Supports structured boss summaries via docs/_meta/<doc>.json or inline ## 👀 老闆版摘要 overrides, enabling decision capture and plain-language risk communication.
  • Bundled Single-File Viewer: Combines all project docs into one shareable HTML file with sidebar navigation, search, and dark/light mode for email or Discord sharing.
  • Verification Gate: Includes a mandatory verification step to catch silent placeholder rendering where boss HTMLs appear complete but contain no real content.

Quick Start

Use the doc-html-preview skill to generate both engineering and boss HTML previews from your project's markdown documents, then run the verification script to confirm all boss versions contain real content before sharing.

Dependency Matrix

Required Modules

pandocpython3

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: doc-html-preview
Download link: https://github.com/freedomw1987/tree_monstor/archive/main.zip#doc-html-preview

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 536,000+ vetted skills library on demand.