markdown-mermaid-viewer
v1.0.3
Published
A lightweight markdown viewer with mermaid flowchart support
Downloads
554
Readme
Markdown Mermaid Viewer
A lightweight markdown viewer with mermaid flowchart support.
Features
- Render markdown files with beautiful styling
- Support for mermaid flowchart diagrams with white background
- CLI tool for quick preview
Installation
# Install globally
npm install -g markdown-mermaid-viewer
# Or use npx without installation
npx markdown-mermaid-viewer preview your-file.mdUsage
Preview a markdown file (opens browser)
mmv preview your-file.mdStart server without opening browser
mmv serve your-file.md --port 3000Command Options
| Option | Description | Default |
|--------|-------------|---------|
| -p, --port <number> | Port number | 3000 |
| -o, --open | Open browser automatically | false (serve), true (preview) |
| -V, --version | Show version number | - |
| -h, --help | Show help | - |
npx Usage
Run without installation:
npx markdown-mermaid-viewer preview your-file.md
npx markdown-mermaid-viewer serve your-file.md --port 8080 --no-openExamples
# Preview README.md in browser
mmv preview README.md
# Serve on port 8080 without opening browser
mmv serve "基金合同处理流程_业务逻辑详解v0.1.md" --port 8080 --no-openLicense
MIT
Additional Resources
- README_VS.md - VSCode Extension documentation
- DEVELOPMENT.md - Development and publishing guide
