Solución Rápida (Code Snippet)

Crea un bloque de código tipo mermaid en tu archivo Markdown para generar un diagrama Entidad-Relación (ER) profesional sin salir de tu editor.

erDiagram
    USUARIOS ||--o{ POSTS : escribe
    USUARIOS {
        int id PK
        string nombre
        string email
    }
    POSTS {
        int id PK
        int usuario_id FK
        string titulo
        text contenido
    }

Cómo funciona

La documentación “como código” (Docs-as-Code) con Mermaid.js permite que tus diagramas de base de datos evolucionen al mismo ritmo que tu software:

  1. Sintaxis Declarativa: En lugar de arrastrar cuadros y flechas en una herramienta pesada, simplemente declaras las entidades y sus relaciones. Por ejemplo, ||--o{ representa una relación de “Uno a Muchos”.
  2. Integración con Git: Al ser archivos de texto plano, tus diagramas viven dentro del repositorio. Puedes ver quién cambió el esquema de la base de datos comparando las líneas de Markdown en un Pull Request.
  3. Visualización Universal: Plataformas como GitHub, GitLab y Notion renderizan bloques de Mermaid.js automáticamente. En VS Code, puedes usar la extensión “Markdown Preview Mermaid Support” para ver el resultado en tiempo real.
  4. Eficiencia en el Diseño: Permite definir tipos de datos (string, int), llaves primarias (PK) y llaves foráneas (FK) de forma clara y visualmente atractiva.

Preguntas Frecuentes

¿Qué es Mermaid.js?

Mermaid.js es una herramienta basada en JavaScript que permite generar diagramas y visualizaciones utilizando una sintaxis inspirada en Markdown.

¿Dónde puedo visualizar estos diagramas?

La mayoría de los editores modernos (VS Code) y plataformas (GitHub, GitLab, Notion) tienen soporte nativo o mediante plugins para renderizar Mermaid.js.

Enlaces relacionados