Mantener un diagrama junto al código

Crear, modificar y publicar un diagrama que sigue siendo texto versionable.

Situación. Su arquitectura, flujo de datos o proceso necesita un esquema. Quiere conservarlo en el repositorio, revisarlo en las diferencias y evitar depender de herramientas en línea.

Lo que obtiene al terminar. Un diagrama Mermaid en texto, dibujado localmente, integrado en la documentación o exportado como imagen.

1. Empezar con una plantilla

Elija Archivo > Nuevo archivo (⌘N) y después un diagrama Mermaid.

La galería ofrece las 28 familias reconocidas, 16 plantillas recomendadas y búsqueda por uso y tipo. Tres campos de personalización permiten ajustar el punto de partida antes de crear el archivo.

Si no sabe qué familia elegir, busque lo que quiere mostrar en lugar del nombre técnico.

2. Construir

Puede trabajar de dos formas en el mismo archivo.

Sobre el dibujo: un clic selecciona, un doble clic en un nodo cambia su etiqueta, un doble clic en el fondo añade un nodo y la tecla Suprimir elimina la selección. Un tirador independiente sirve para crear relaciones.

Por estructura: la navegación izquierda muestra las declaraciones del diagrama. Seleccione una para modificar sus campos, use Añadir para insertar y Subir o Bajar para cambiar el orden.

En modo Fuente, escriba directamente el lenguaje Mermaid.

3. Aceptar la distribución calculada

Mermaid calcula la distribución. Si mueve un elemento sin que ese movimiento tenga sentido en la gramática, vuelve a su posición calculada.

Así se garantiza que el archivo de texto contenga todo el diagrama. Para influir en la distribución, cambie la dirección o el orden de las declaraciones.

4. Incluir el diagrama en la documentación

En un documento Markdown, Insertar abre la misma galería y coloca el diagrama en un bloque delimitado para evitar conflictos con el contenido.

Para modificar un bloque existente, Editar abre la misma superficie en una ventana separada. El borrador queda aislado: Cancelar no cambia el documento y Aplicar sustituye únicamente el interior del bloque.

5. Exportar cuando necesite una imagen

Copie la fuente, copie la imagen o exporte en SVG y PNG.

La imagen exportada es la que se ha saneado para mostrarla: sin scripts ni enlaces activos.

Conserve el .mmd en el repositorio aunque entregue un PNG. La imagen se puede regenerar; el texto se puede revisar y modificar.

6. Crear su biblioteca

Elija una carpeta local como biblioteca de plantillas personales. Son archivos .mmd o .mermaid ordinarios.

Desde un diagrama abierto, Guardar copia como plantilla… lo añade a la biblioteca.

Olvidar la carpeta solo retira el acceso de Balise, sin eliminar archivos.

Si algo falla