Stats
Actions
Tags
Help us improve
Share bugs, ideas, or general feedback.
From mdserve
Serves markdown as live-reloading browser previews using mdserve for complex docs, tables, Mermaid diagrams, and multi-file sets. Handles iterative edits.
npx claudepluginhub jfernandez/mdserve --plugin mdserveHow this skill is triggered — by the user, by Claude, or both
Slash command
/mdserve:mdserveThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Serve markdown files as live-reloading HTML previews in the browser
Generates browser-viewable HTML previews from markdown, plain text, and Mermaid diagrams. Validates diagrams, applies GitHub/dark/minimal styling, saves to temp dir, and auto-opens in default browser for docs, reports, and visualizations.
Routes Mermaid diagram requests to type-specific guides (sequence, activity, ER, architecture); validates .md files, renders .mmd to SVG, architects from codebases.
Provides best practices for Markdown technical documentation and READMEs, including structure, organization, linking, writing style, code examples, and admonitions.
Share bugs, ideas, or general feedback.
Serve markdown files as live-reloading HTML previews in the browser
using mdserve.
Use mdserve whenever you produce markdown that benefits from rendered presentation:
Use mdserve when markdown is more than about 40 to 60 lines, has complex formatting, or is likely to go through multiple edit/review iterations with the user.
Do not use mdserve for short conversational answers, single code snippets, trivial one-paragraph responses, or any markdown that fits comfortably within a terminal window.
plan.md).run_in_background: true and
the --open flag to launch the browser automatically:
command: mdserve --open plan.md
run_in_background: true
TaskStop with the task ID.mdserve automatically finds an available port if the default (3000) is in use. Check the startup output for the actual URL and always tell the user the URL that mdserve reports.
When producing multiple related markdown files, serve the parent directory instead:
command: mdserve --open docs/
run_in_background: true
This gives the user a sidebar to navigate between files. Only the immediate directory is watched (non-recursive).
Use Mermaid diagrams when they improve clarity over plain text:
Prefer Mermaid over ASCII art when the diagram has more than a few elements or shows relationships and flow.
mdserve must be installed on the user's system. If the mdserve
command is not found, ask the user how they would like to install it
using AskUserQuestion with these options:
curl -sSfL https://raw.githubusercontent.com/jfernandez/mdserve/main/install.sh | bashbrew install mdservecargo install mdservesudo pacman -S mdserveThen run the corresponding install command for them.