Skip to content

feat: Enable Mermaid diagram support in Docusaurus#6

Closed
TellMeAlex wants to merge 5 commits intomainfrom
feature/test-mermaid-diagrams
Closed

feat: Enable Mermaid diagram support in Docusaurus#6
TellMeAlex wants to merge 5 commits intomainfrom
feature/test-mermaid-diagrams

Conversation

@TellMeAlex
Copy link
Copy Markdown
Contributor

Descripción

Agrega soporte nativo para diagramas Mermaid en la documentación del sitio, permitiendo crear visualizaciones como diagramas de flujo, gráficos, y más directamente en los documentos.

Cambios principales

  • Dependencias: Agregó @docusaurus/theme-mermaid para integración nativa
  • Configuración: Habilitó Mermaid en docusaurus.config.js con tema adaptativo para modo claro/oscuro
  • Package.json: Actualizado con dependencias necesarias

Beneficios

✅ Mejor visualización de conceptos complejos en la documentación
✅ Soporte para múltiples tipos de diagramas (flowchart, sequence, state, etc.)
✅ Tema adaptativo que respeta preferencias de color del usuario
✅ Sin necesidad de herramientas externas para generar imágenes

Testing

  • Build completa sin errores
  • Diagramas renderizables en modo claro y oscuro
  • Compatibilidad con el tema actual del sitio

…Docusaurus

- 7 tipos diferentes de diagramas Mermaid para testear
- Flowcharts (flujos de decisión)
- Diagramas de secuencia (interacciones)
- Árboles de decisión (Claude Code composición)
- Diagramas de componentes (arquitectura)
- Gantt charts (timeline)
- State diagrams (máquinas de estado)
- Instrucciones para testear localmente

Objetivo: Validar si Docusaurus 3.9.2 soporta Mermaid de forma nativa
y usarlo en futuros artículos educativos.
- Install @docusaurus/theme-mermaid@3.9.2
- Configure markdown.mermaid = true
- Register @docusaurus/theme-mermaid theme
- Ready to render Mermaid diagrams in markdown

This allows creating interactive diagrams for documentation.
Tests with 7 different diagram types available in docs/test/mermaid-diagrams-test.md
- Add mermaid.theme configuration in themeConfig
- Set light theme: 'default', dark theme: 'dark'
- Fixes useColorMode hook errors

This resolves the ColorModeProvider issue with Mermaid diagrams.
- Added @docusaurus/theme-mermaid@^3.9.2 to support Mermaid diagrams.
- Updated start script in package.json to prevent automatic opening of the browser.
- Enhanced bun.lock with new dependencies and versions for improved compatibility.

These changes ensure better integration of Mermaid diagrams and streamline the development process.
@TellMeAlex TellMeAlex closed this Dec 19, 2025
@TellMeAlex TellMeAlex deleted the feature/test-mermaid-diagrams branch December 19, 2025 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant