Frequently Asked Questions
Find answers to common questions about using mermantic.
Understanding Mermaid
What is a Mermaid chart?
A Mermaid chart is a visual diagram that represents relationships, processes, and structures. It is commonly used for flowcharts, organizational charts, and Gantt charts. Mermaid charts are generated using the Mermaid JS syntax, allowing easy creation and customization.
What is Mermaid JS?
Mermaid JS is a JavaScript-based diagramming and charting tool that allows you to create diagrams using simple text syntax. It is an open-source tool that powers our free online chart generator. The syntax is designed to be both simple and powerful, making it accessible even for beginners.
How does Mermaid work?
Mermaid works by converting simple text descriptions into diagrams. Users define the structure of their diagram using a specific syntax, and the software generates a corresponding visual chart. This text-based approach makes it easy to version control your diagrams and integrate them with development workflows.
What are the benefits of using Mermaid?
Key benefits include:
• Easy-to-learn text-based syntax
• Version control support (store as text files in Git)
• Integration with development tools and platforms
• Wide variety of diagram types
• Free and open-source
• Excellent for technical documentation
• Support for collaboration
Getting Started with mermantic
What is mermantic?
mermantic is a free web application that allows you to create, edit, and share Mermaid diagrams online. It provides a live preview of your diagrams, supports multiple diagram types, and offers features like saving, sharing, and collaboration.
Is it really free?
Yes! mermantic is completely free to use. You can create, save, and share as many diagrams as you want without any cost. All features, including templates, customization options, and export capabilities, are available at no charge.
Do I need an account?
While you can view shared diagrams without an account, creating a free account allows you to:
• Save diagrams for later use
• Organize diagrams in folders
• Share diagrams with others
• Access diagram templates
• Customize themes and settings
Registration is free and you can sign up using your email or Google account.
What diagram types can I create?
mermantic supports all Mermaid diagram types including:
• Flowcharts
• Sequence Diagrams
• Class Diagrams
• State Diagrams
• Entity Relationship Diagrams
• Gantt Charts
• Pie Charts
• User Journey Maps
• Git Graphs
• Mind Maps
• Timeline Charts
Creating and Customizing Diagrams
How do I create a Mermaid diagram online?
Creating a diagram is easy:
1. Log in to your account (it's free!)
2. Click the "Create New Diagram" button
3. Choose a template or start from scratch
4. Use the editor to write your diagram code
5. See your changes instantly in the live preview
Where can I find diagram templates?
We offer a variety of free templates in our Gallery section. You can:
• Browse templates by category
• Preview templates before using them
• Copy and customize any template
• Save modified templates for later use
Can I customize my diagrams?
Yes! You can customize:
• Colors and themes (Default, Dark, Forest, Base, Neutral)
• Fonts and text styles
• Line styles and arrows
• Layout and spacing
• Node shapes and sizes
Set preferences globally or per diagram.
How do I learn Mermaid syntax?
The editor supports several keyboard shortcuts:
• Ctrl+S / Cmd+S: Save diagram
• Ctrl+Enter / Cmd+Enter: Update preview
• F11: Toggle fullscreen
• Esc: Exit fullscreen or close modal
Advanced Features and Integration
Can I use Mermaid for collaborative projects?
Yes! Mermaid is excellent for collaboration:
• Share diagrams with unique URLs
• Embed diagrams in GitHub/GitLab
• Use in documentation platforms
• Store diagram code in version control
• Work together on technical documentation
Can I integrate Mermaid diagrams into websites?
Absolutely! You can:
• Embed diagrams in websites and blogs
• Integrate with content management systems
• Add dynamic, interactive diagrams
• Use Mermaid JS for custom integrations
Can AI read my Mermaid diagrams?
Yes! AI can analyze Mermaid diagrams to:
• Extract data and relationships
• Identify patterns and workflows
• Generate insights from diagram structure
• Assist with automation and process optimization
What are common use cases?
By default, your diagrams are private and only accessible to you. When you share a diagram, only people with the share link can view it. You can also make diagrams public if desired.
Saving, Sharing, and Export
Can I save my diagrams?
Yes! With a free account you can:
• Save unlimited diagrams
• Organize them in folders
• Access them from anywhere
• Keep track of versions
• Backup your work automatically
How do I share my diagrams?
Sharing is easy:
1. Click the "Share" button on any diagram
2. Copy the generated share link
3. Send the link to others - they can view without an account
4. Optionally make diagrams public
5. Control access permissions
What export options are available?
You can export your diagrams in multiple formats:
• PNG for raster images
• SVG for vector graphics
• Plain text for Mermaid syntax
• PDF for documentation
Perfect for presentations, documentation, and reports!
Account and Support
How secure are my diagrams?
We take security seriously:
• Private diagrams are only accessible to you
• Shared diagrams require specific links
• Data is encrypted in transit and at rest
• Regular security updates
• Industry-standard protection
What if I need help?
We offer multiple support options:
• Comprehensive documentation
• Interactive tutorials
• Example templates
• Email support
• Community forums
Can I use Mermaid for non-technical projects?
Absolutely! While Mermaid is popular in technical fields, it's great for:
• Project planning
• Organization charts
• Process documentation
• Educational materials
• Visual storytelling
Our templates and user-friendly interface make it accessible to everyone!