md-preview
Renders Markdown Claude edits in a pane like GitHub, with before/after compare.
Illustration. Actual results depend on the mod, terminal and environment.
Install
/plugin marketplace add hamzafer/claude-code-mods
/plugin install md-preview@claude-code-mods
/reload-pluginsRun these commands one at a time in a Claude Code session.
claude plugin marketplace add hamzafer/claude-code-mods
claude plugin install md-preview@claude-code-modsThen run /reload-plugins in your session, or start a new session.
Please install the Claude Code mod "md-preview" (https://github.com/hamzafer/claude-code-mods). Before installing, read the Security and Requirements sections of its README and tell me what it reads and writes, which commands it runs, whether it uses the network, and which Claude Code version, OS and terminal it needs. If everything looks fine, run claude plugin marketplace add hamzafer/claude-code-mods and claude plugin install md-preview@claude-code-mods, then remind me to run /reload-plugins in my session.Send this to Claude Code so it reads the author’s instructions before installing.
git clone https://github.com/hamzafer/claude-code-mods
cd claude-code-mods
claude --plugin-dir ./mods/md-previewClone the repository and try it in a local session with --plugin-dir.
What it accesses
Based on the author’s documentation, checked when listed; use claude plugin validate to check for yourself.
Reads
YesReads edited Markdown, git remotes, and HOME/terminal capabilities.
Writes files
YesWrites rendered pages, a throwaway Chrome profile, and PNG screenshots under a temp dir.
Runs commands
YesRuns git, gh, and a Headless Chrome/Chromium screenshot script.
Network
YesCalls GitHub's /markdown API via gh; Chrome may load linked images.
Introduction
md-preview is a Claude Code function-hooks mod: when Claude edits .md/.mdx/.markdown, a toast notes it, and /md opens a GitHub-style rendered preview in a pane, with before/after compare, multi-file browsing, and opening the full page in a browser.
- Renderer order:
gh api /markdownwhenghis signed in; otherwise a built-in renderer; text-only without Chrome or an image terminal. - Privacy: in repos with a GitHub remote, Markdown text is sent to GitHub's API via
ghin the background at turn end even if you never open/md. Headless Chrome uses a throwaway profile; scripts do not run. - Needs: Google Chrome/Chromium and an image-capable terminal (Ghostty, kitty, iTerm2, WezTerm); no images through tmux.
Marketplace hamzafer/claude-code-mods, plugin md-preview. Needs Claude Code 2.1.287+. Preview is illustrative.
Who it is for
- People who have Claude edit README/docs and want a live rendered preview
Requirements
- Claude Code ≥ 2.1.287
- Full page preview needs Chrome/Chromium and an image terminal; no images through tmux.
- Optional signed-in gh for GitHub's official renderer.