Skip to content

mrbrightsides/mermaind

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

19 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿงœโ€โ™€๏ธ Mermaind - AI-Powered Academic Diagram Generator

Mermaid + MindMap. Mind your flow, let Mermaind draw it for you.

Mermaind adalah tool untuk membantu akademisi, peneliti, dan praktisi membuat flow diagram hanya dengan prompt singkat. Nama Mermaind adalah gabungan dari Mermaid dan Mind โ†’ cukup tulis deskripsi alur, biarkan Mermaind menggambarkannya untukmu.

Built with Next.js TypeScript Tailwind CSS Built on Base

Transform natural language into publication-ready academic diagrams in seconds. Powered by AI, designed for researchers.

Live Demo โ€ข API Docs โ€ข Contributing โ€ข Changelog


๐ŸŒŸ Overview

Mermaind is an advanced academic diagram generator that combines the power of AI with the precision of Mermaid.js to create publication-ready flow diagrams from natural language prompts. Built specifically for researchers, academics, and students who need professional diagrams for papers, theses, and presentations.

Why Mermaind?

  • ๐Ÿค– AI-Powered: Perplexity AI understands your research context and generates accurate diagrams
  • ๐Ÿ“š Academic-Focused: 200+ templates for research workflows, methodologies, and protocols
  • ๐Ÿ“ Publication-Ready: Export to SVG, PDF, LaTeX with proper citations and formatting
  • ๐Ÿ”— LaTeX Integration: One-click export to Overleaf with complete project scaffolding
  • ๐Ÿ“– Reference Managers: Direct export to Zotero, Mendeley, EndNote
  • ๐Ÿ’ฌ Collaboration: Real-time commenting with @mentions and threaded discussions
  • ๐ŸŽจ Beautiful UI: Clean, modern interface with light/dark mode and web3 aesthetic
  • ๐Ÿ”Œ REST API: Programmatic access for automation and integration

๐ŸŽฏ Features

Core Functionality

1. AI-Enhanced Diagram Generation

  • Natural Language Input: Describe your process in plain English
  • Context-Aware: Upload research papers for informed diagram creation
  • Smart Templates: 200+ academic templates across all disciplines
  • 6 Diagram Types: Flowchart, Sequence, Class, State, Gantt, Git Graph

2. Academic Integration

Citation Generator

  • IEEE, APA, MLA, Chicago formats
  • Auto-generated BibTeX entries
  • Publication-ready references

Reference Manager Export

  • Zotero RDF format
  • Mendeley BibTeX
  • EndNote XML
  • One-click metadata export

Overleaf Integration

  • Complete LaTeX project generation
  • Quick snippets for existing documents
  • Multiple document classes (article, thesis, report, beamer)
  • Professional figure formatting

3. Collaboration Features

Commenting System

  • @mention collaborators
  • Threaded discussions
  • Reaction system (like, agree, question, important)
  • Resolution tracking
  • Edit and delete capabilities

Version Control

  • Git-like branching
  • Commit history
  • Change tracking
  • Version comparison

4. Export Options

  • Vector Graphics: SVG, PDF
  • High Resolution: PNG (300+ DPI)
  • LaTeX: Complete projects or snippets
  • Multiple Formats: Simultaneous multi-format export

5. REST API

  • Programmatic diagram generation
  • 200+ template access
  • API key management
  • Usage analytics
  • Rate limiting (100 req/hour)

๐Ÿ› ๏ธ Contoh Penggunaan

Prompt

โ€œGambarkan supply chain AgroViz. Dari petani โ†’ koperasi โ†’ eksportir โ†’ blockchain traceability โ†’ konsumen. Tambahkan feedback loop dari konsumen balik ke petani.โ€

Output (Mermaid code)

flowchart TD
    Farmer --> Cooperative --> Exporter --> BlockchainTraceability --> Consumer
    Consumer -.-> Farmer
Loading

๐Ÿงฐ Tech Stack

Frontend

  • Framework: Next.js 14 (App Router)
  • Language: TypeScript
  • Styling: Tailwind CSS
  • UI Components: Radix UI
  • Diagram Engine: Mermaid.js
  • State Management: React Hooks

Backend

  • API: Next.js API Routes (Edge Runtime)
  • AI Integration: Perplexity API
  • Storage: LocalStorage (offline-first)
  • Export: html2canvas, jsPDF

Infrastructure

  • Deployment: Vercel
  • Blockchain: Base (web3 integration ready)
  • API: RESTful with OpenAPI spec

๐Ÿš€ Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn
  • Perplexity API key (optional, for AI features)

Installation

# Clone the repository
git clone https://github.com/yourusername/mermaind.git
cd mermaind

# Install dependencies
npm install

# Set up environment variables (optional)
cp .env.example .env.local
# Add your Perplexity API key to .env.local

# Run development server
npm run dev

Open http://localhost:3000 to see the app.

Environment Variables

# Optional: AI Enhancement
PERPLEXITY_API_KEY=your_api_key_here

# Optional: Analytics
NEXT_PUBLIC_ANALYTICS_ID=your_analytics_id

๐Ÿ“– Usage Guide

Basic Usage

  1. Enter Your Prompt

    Example: "Show the peer review process for submitting 
    to a Q1 journal with editor decision, reviewer feedback, 
    and revision cycles"
    
  2. Select Diagram Type

    • Flowchart: Processes and workflows
    • Sequence: Interactions and communications
    • Class: System architecture and relationships
    • State: Lifecycle and transitions
    • Gantt: Project timelines
    • Git Graph: Version control flows
  3. Generate Diagram

    • AI analyzes your prompt
    • Generates structured Mermaid syntax
    • Renders publication-ready diagram
  4. Export & Share

    • Download SVG/PNG/PDF
    • Export to Overleaf
    • Generate citations
    • Add to reference manager

Advanced Features

Context-Aware Generation

1. Click "Context Analysis" button
2. Upload your research paper (PDF/DOCX)
3. AI reads and understands your research
4. Generates contextually accurate diagrams

LaTeX/Overleaf Export

1. Generate your diagram
2. Click "Overleaf" button
3. Choose export type:
   - Quick Snippet: Copy-paste code
   - Full Project: Complete LaTeX package
4. Upload to Overleaf and compile

Team Collaboration

1. Generate diagram
2. Click "Comments" button
3. Add comments with @mentions
4. Team members reply and react
5. Mark discussions as resolved

API Usage

# Generate diagram via API
curl -X POST https://mermaind.app/api/v1/diagram \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Show machine learning pipeline",
    "type": "flowchart"
  }'

See API.md for complete API documentation.


๐ŸŽ“ Use Cases

For PhD Students

  • Methodology flowcharts for thesis
  • Research workflow diagrams
  • Literature review structures
  • Experimental protocols

For Research Teams

  • Collaborative workflow design
  • Project timelines (Gantt)
  • System architecture (Class diagrams)
  • Communication flows (Sequence)

For Conference Presentations

  • Beamer presentation integration
  • Professional diagram styling
  • High-resolution exports
  • Quick iteration cycles

For Journal Submissions

  • Publication-ready figures
  • Q1 journal compliance
  • Proper citations
  • Multiple format support

๐Ÿ“š Documentation


๐Ÿค Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

Quick Start for Contributors

# Fork and clone
git clone https://github.com/yourusername/mermaind.git

# Create feature branch
git checkout -b feature/amazing-feature

# Make changes and test
npm run dev
npm run build

# Commit and push
git commit -m "Add amazing feature"
git push origin feature/amazing-feature

# Open Pull Request

๐Ÿ—บ๏ธ Roadmap

Q1 2024 โœ…

  • Core diagram generation
  • AI integration (Perplexity)
  • 200+ academic templates
  • Export system (SVG, PNG, PDF)
  • Citation generator
  • Reference manager integration
  • Overleaf integration
  • Commenting system
  • REST API

Q2 2024 ๐Ÿšง

  • Real backend with database (Supabase)
  • User authentication and accounts
  • Real-time collaboration (WebSocket)
  • Mobile apps (iOS/Android)
  • Template marketplace
  • Advanced analytics

Q3 2024 ๐Ÿ“‹

  • Blockchain verification (Base)
  • Institution SSO integration
  • Google Docs/Word plugins
  • Enhanced AI models
  • Custom shape libraries
  • Preprint server integration

Q4 2024 ๐Ÿ”ฎ

  • Enterprise features
  • Academic social network
  • Advanced collaboration tools
  • AR/VR diagram exports
  • Interactive diagrams
  • Multi-language support

๐Ÿ† Recognition

Built with โค๏ธ on Base blockchain infrastructure.

Credits


๐Ÿ“„ License

MIT License - see LICENSE file for details.


๐Ÿ’ฌ Community & Support


๐ŸŒŸ Star History

If you find Mermaind useful, please consider giving it a star! โญ

Star History Chart


๐Ÿ“Š Stats

  • 200+ Academic Templates
  • 6 Diagram Types
  • 4 Citation Formats
  • 3 Reference Manager Exports
  • 100+ API Requests/Hour
  • 0 Cost to Use (Free & Open Source)

Built with ๐Ÿ”ต on Base โ€ข Empowering Academic Research Worldwide ๐Ÿš€

Made with โค๏ธ by researchers, for researchers.

About

Academic Flow Diagram Generator by RANTAI

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages