Este documento detalla la instalación y configuración del plugin PlantUML para Python-Markdown. Esta extensión facilita la incrustación de diagramas PlantUML directamente en archivos Markdown, que luego se renderizan automáticamente como imágenes.

Tecnologías y Dependencias

• Python-Markdown: El núcleo de la extensión, responsable de procesar el texto Markdown.
• PlantUML: La herramienta de generación de diagramas que interpreta la sintaxis de PlantUML.
• Dependencias Opcionales: Según la configuración, se puede requerir un servidor PlantUML (local o remoto) y Graphviz para la representación gráfica.

Procedimiento de Instalación

Requisitos Previos

1. Entorno Python: Asegúrate de tener Python 3.x instalado.
2. pip: El gestor de paquetes de Python. Actualízalo con pip install --upgrade pip.
3. Git: Necesario si deseas clonar el repositorio del proyecto.

Instalación del Plugin

Ejecuta el siguiente comando en tu terminal:

pip install plantuml-markdown
   

Configuración de PlantUML Local (Recomendado)

1. Descarga PlantUML: Obtén el archivo plantuml.jar desde el sitio oficial de PlantUML.
2. Instala Graphviz: Si es necesario para ciertos tipos de diagramas, descarga e instala Grapvhiz.
3. Configura el PATH: Asegúrate de que la ubicación de plantuml.jar esté incluida en la variable de entorno PATH del sistema, o crea un script ejecutable (ej. plantuml) en un directorio del PATH que apunte al JAR.

Configuración del Plugin

Puedes configurar el plugin mediante un archivo YAML (ej. config.yml) para especificar el servidor PlantUML, habilitar conexiones inseguras, definir un directorio de caché, etc.

# Ejemplo de config.yml
plantuml_markdown:
 server: "" # Deja vacío para usar PlantUML local
 insecure: False
 cachedir: "/tmp/plantuml_cache"
 # ... otras opciones
   

Al procesar tu Markdown, esepcifica el archivo de configuración:

markdown_py -x plantuml_markdown -c config.yml tu_archivo.md -o tu_archivo.html
   

Ejemplo de Uso

Inserta bloques de código PlantUML en tu archivo Markdown delimitados por ::uml:: y ::end-uml::.

::uml::
format="svg"
Alice -> Bob: Hola
Bob --> Alice: Adiós
::end-uml::
   

Procesamiento del Documento

Utiliza el comando markdown_py para generar el archivo HTML. Si no usas un archivo de configuración, el comando es:

markdown_py -x plantuml_markdown tu_archivo.md -o tu_archivo.html
   

Una vez completaods estos pasos, podrás integrar diagramas dinámicamente en tus documentos Markdown.