skills.rest
312362115
312362115COMMUNITY
Explore all skills by this author →
GitHub

preview-md

Render Markdown documents in a browser with GitHub-style formatting and an automatic table of contents.

109|17|Updated Mar 14, 2026
Search Tags:#documentation#markdown#mermaid#toc#md-preview#github-style#browser-preview
One-click install
npx skills add https://github.com/312362115/claude --skill preview-md
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: preview-md
Source: https://github.com/312362115/claude/tree/main/skills/preview-md
Command: npx skills add https://github.com/312362115/claude --skill preview-md

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jq, markdown, and includes scripts (resource) components.

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.

Frequently Asked Questions about preview-md

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

FAQPage Schema
How do I preview markdown files in a browser with a table of contents?▼

You can preview markdown in a browser using this tool to render documents in GitHub style with an automatically generated, fixed left-hand table of contents for immediate navigation and review.

Does the markdown browser preview support Mermaid diagrams?▼

Yes, the markdown browser preview supports Mermaid diagrams. It provides Mermaid-friendly rendering alongside GitHub-style formatting to validate technical documentation visually.

How do I review markdown specs and plans before sharing them?▼

To review markdown specs and plans before sharing, trigger the browser preview after completing your document. It outputs a GitHub-style view with an interactive TOC for quick validation.

Do I need jq and markdown installed to use the GitHub-style preview?▼

Yes, you need jq and markdown installed as dependencies. These command-line utilities process the markdown text and generate the TOC structure required for the browser-based preview.

Can I trigger a markdown preview automatically after generating a document in a workflow?▼

Yes, you can trigger a markdown preview automatically in workflows. It is designed for post-specs or post-plans MD workflows, enabling immediate review of generated documentation outputs.

Related Skills

Explore More Software Engineering Skills→
cloudofgeorgecloudofgeorge

make-pdf

Convert Markdown documents into publication-ready PDFs with covers, TOC, and headers.

Community
Advanced
alastor0325alastor0325

open-team

Opens Firefox review-team dashboards hosted on GitHub Pages for specified teams.

Community
Basic
gmcabritagmcabrita
6

mermaid

Validate Mermaid diagrams by parsing and rendering them to SVG.

Community
Intermediate
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate