md

^{Preview Markdown in your browser with live reload, GitHub-flavored rendering, Mermaid support, and automatic light/dark theming.}

md is a small CLI for previewing Markdown locally. Point it at a file, save as you work, and the browser stays in sync.

Install

npm install -g @truyman/md

Features

• Live preview that reloads as you save your Markdown.
• GitHub Flavored Markdown support for tables, task lists, and strikethrough.
• Emoji shortcodes expand outside code blocks.
• GitHub-style callouts, tables, details, and themed code blocks with copy buttons.
• Mermaid diagrams render inline, include copy buttons, and adapt to the active theme.
• Built-in preview server with automatic light/dark theming.
• Defaults to README.md when no file path is provided.

Usage

Preview README.md in the current directory:

md

Preview a specific file:

md OVERVIEW.md

When you run md, it will:

1. Start a local preview server on an available port.
2. Open your browser automatically.
3. Re-render the page whenever the target file changes.

License

MIT