doc-html-preview

Convert markdown documentation into dual engineering and boss HTML previews.

2|Updated May 10, 2026
One-click install
npx skills add https://github.com/freedomw1987/tree_monstor --skill doc-html-preview
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-html-preview
Source: https://github.com/freedomw1987/tree_monstor/tree/main/skills/doc-html-preview
Command: npx skills add https://github.com/freedomw1987/tree_monstor --skill doc-html-preview

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pandoc, python3, and includes scripts (resource) and references (resource) components.

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.

Frequently Asked Questions about doc-html-preview

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

FAQPage Schema
How do I generate an HTML preview from markdown documentation for non-technical stakeholders?

Generating an HTML preview from markdown documentation converts technical files into a faithful engineering rendering and a decision-oriented boss version with plain-language summaries, decision cards, and risk assessments for non-technical stakeholders.

What is a boss summary in markdown-to-HTML conversion workflows?

A boss summary in markdown-to-HTML conversion is a structured JSON or inline override that captures decisions and plain-language risk communication, rendered into a dedicated HTML view for executive decision-making.

How do I convert all project markdown docs into a single shareable HTML file?

Converting all project markdown docs into a single shareable HTML file bundles documents into one viewer with sidebar navigation, search, and dark/light mode for email or Discord sharing.

Do I need pandoc and python3 to convert markdown to HTML previews?

Yes, pandoc and python3 are required dependencies for markdown-to-HTML conversion, with optional Node.js for bundled single-file documentation viewers and JSON-based boss summary generation.

Why does my generated boss HTML appear complete but contain no real content?

Generated boss HTMLs can suffer from silent placeholder rendering where the file appears complete but contains no real content, requiring a mandatory verification gate script to catch the issue before sharing.

Can I use pandoc to create both engineering and executive decision HTML views from the same markdown file?

Yes, using pandoc produces dual HTML views from the same markdown file: a 1:1 engineering render for code review and an executive boss version with summary cards, decisions, and risk assessments.