# Mermaid

*noun*

say it: **“MUR-mayd”** **/ˈmɜrmeɪd/**

A small language for writing diagrams as text in a Markdown file, which GitHub and VS Code draw as pictures.

## What is **Mermaid**?

**Mermaid** is a small language for writing diagrams as text. You put a few lines in a fenced block marked `mermaid` in a Markdown file, and GitHub (and VS Code's Markdown preview, with an extension) draws the picture. Because the diagram is text beside the code, it changes in the same commit as the code.

```mermaid
classDiagram
    Bike <|-- EBike
    Bike "1" *-- "1" Lock
```

## In a sentence

- “We kept the design as **Mermaid** text in the README, so it changed in the same commit as the code.”

Level: Apprentice · [More Software Development terms at this level](https://www.ask-codey.com/glossary?category=software-development&level=2)

Updated: November 9, 2026

Source: https://www.ask-codey.com/glossary/mermaid
