render-mermaid-markdown
v1.0.2
Published
A lightweight markdown viewer with mermaid flowchart support
Downloads
44
Readme
Render Mermaid Markdown
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
- VSCode extension available
Installation
# Install globally
npm install -g render-mermaid-markdown
# Or use npx without installation
npx render-mermaid-markdown 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 render-mermaid-markdown preview your-file.md
npx render-mermaid-markdown 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 "README.md" --port 8080 --no-openLicense
MIT
Contributing
Contributions are welcome! Please feel free to submit issues and pull requests.
