Getting Started

Getting Started

Prerequisites

• .NET Framework 4.8 (required for core library and tests)
• .NET 8.0 SDK (required for core library and tests)
• .NET 9.0 SDK (required for sample applications)

Installation via NuGet

dotnet add package MermaidSharp

For Entity Framework Core integration:

dotnet add package MermaidSharp.EntityFrameworkCore

Build from Source

Clone the repository and restore/build the solution:

git clone https://github.com/IchiSamaFR/MermaidSharp.git
cd MermaidSharp
dotnet restore src/MermaidSharp.sln
dotnet build src/MermaidSharp.sln -c Release

Running Tests

dotnet test src/MermaidSharp.sln -c Release

Solution Structure

MermaidSharp/
├── src/
│   ├── MermaidSharp/                               # Core library (.NET Framework 4.8 / .NET 8)
│   ├── MermaidSharp.Tests/                         # Unit tests (.NET Framework 4.8 / .NET 8)
│   ├── MermaidSharp.AutoDiagram/                   # AutoDiagram extension (.NET Framework 4.8 / .NET 8)
│   ├── MermaidSharp.AutoDiagram.Tests/             # AutoDiagram tests (.NET Framework 4.8 / .NET 8)
│   ├── MermaidSharp.AutoDiagram.Tests.Models/      # AutoDiagram test models (.NET Framework 4.8 / .NET 8)
│   ├── MermaidSharp.MVCWeb/                        # Sample MVC app (.NET 9)
│   ├── MermaidSharp.BlazorApp/                     # Sample Blazor WebAssembly app (.NET 9)
│   ├── MermaidSharp.EntityFrameworkCore/           # EF Core integration (.NET Framework 4.8 / .NET 8)
│   ├── MermaidSharp.EntityFramework.Tests/         # EF tests (.NET Framework 4.8)
│   ├── MermaidSharp.EntityFrameworkCore.Tests/     # EF Core tests (.NET 8)
│   └── MermaidSharp.sln
└── README.md

Next Steps

• Features — Discover all supported diagram types.
• Basic Usage — See examples for each diagram type.
• EntityFramework Integration — Generate ERDs automatically from your DbContext.