Mermaid Documentation Guide

Mermaid is a JavaScript-based diagramming and charting tool that uses text definitions to create diagrams dynamically. This skill includes the complete official documentation from the mermaid repository.

Quick Start: Read mermaid-cli/README.md for installation and usage. Always use mermaid-cli to validate code and generate diagrams. Adjust width/height for readability (default PNGs are often too small).

Documentation Structure

Quick Start

• mermaid-README.md - Main Mermaid project README with overview, features, and quick examples

Getting Started

• intro/getting-started.md - Quick start guide for using Mermaid
• intro/index.md - Introduction and overview
• intro/syntax-reference.md - General syntax reference across all diagram types
• config/usage.md - How to use Mermaid in different environments