preview-md

Community

Preview MDs in GitHub-style browser with TOC.

Author312362115
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This tool provides a browser-based preview for Markdown documents, rendering them in GitHub style with a fixed left-hand table of contents to accelerate review and validation.

Core Features & Use Cases

  • GitHub-style rendering with navigation-friendly left TOC and Mermaid-friendly rendering for diagrams.
  • Auto-generated, interactive table of contents that scrolls with the document.
  • Triggerable in workflows after MD outputs like specs or plans, enabling quick review before sharing.

Quick Start

After you finish a specs or plans MD, trigger the browser preview to view it with a GitHub-style rendering and automatic table of contents.

Dependency Matrix

Required Modules

jqmarkdown

Components

scripts

💻 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: preview-md
Download link: https://github.com/312362115/claude/archive/main.zip#preview-md

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 471,000+ vetted skills library on demand.