Skip to content

Commit 37968ff

Browse files
committed
docs: update README with features and usage
1 parent 43e9de7 commit 37968ff

1 file changed

Lines changed: 58 additions & 0 deletions

File tree

readme.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Mermaid Parser
2+
3+
A minimal online Mermaid diagram parser for creating, previewing, and exporting diagrams.
4+
5+
**Live Demo**: https://mappedinfo.github.io/mermaidreader/
6+
7+
## Features
8+
9+
- **Real-time Preview** - Diagrams render instantly as you type
10+
- **Zoom Controls** - Zoom in/out (25%-400%) with reset option
11+
- **Resizable Preview** - Drag to resize the preview area
12+
- **Copy Text** - Copy Mermaid syntax to clipboard
13+
- **Export Image** - Export diagrams as 300 DPI PNG
14+
- **Error Display** - Detailed syntax error messages with location
15+
16+
## Usage
17+
18+
1. Paste or type Mermaid syntax in the text area
19+
2. View the rendered diagram in the preview
20+
3. Use zoom controls (+/-) to adjust size
21+
4. Click "Copy Text" or "Copy Image" to export
22+
23+
## Supported Diagram Types
24+
25+
- Flowchart
26+
- Sequence Diagram
27+
- Class Diagram
28+
- State Diagram
29+
- Entity Relationship Diagram
30+
- Gantt Chart
31+
- Pie Chart
32+
- Git Graph
33+
- Mind Map
34+
- Timeline
35+
- And more...
36+
37+
## Development
38+
39+
```bash
40+
# Install dependencies
41+
npm install
42+
43+
# Start dev server
44+
npm run dev
45+
46+
# Build for production
47+
npm run build
48+
49+
# Preview production build
50+
npm run preview
51+
```
52+
53+
## Tech Stack
54+
55+
- Vite
56+
- TypeScript
57+
- Mermaid.js
58+
- GitHub Pages

0 commit comments

Comments
 (0)