Skip to content

Welcome to Astro PlantUML

Transform PlantUML code blocks into diagrams automatically in your markdown files

Features

Automatic Conversion

Automatically converts PlantUML code blocks in markdown files to images during build time.

Multiple Diagram Types

Supports sequence, class, activity, state, component diagrams, mind maps, and Gantt charts.

Customizable

Configure server URL, timeout, CSS classes, and more to fit your needs.

Error Handling

Graceful error handling with fallback to show the original code if rendering fails.

Quick Example

Write PlantUML in your markdown:

```plantuml
@startuml
Alice -> Bob: Hello!
Bob --> Alice: Hi there!
@enduml
```

And it automatically renders as:

PlantUML Diagram

Why Astro PlantUML?

  • πŸ“ Write Once: Keep your diagrams as code in version control
  • πŸš€ Fast Builds: Diagrams are rendered at build time, not runtime
  • 🎨 Themeable: Use PlantUML themes to match your site’s design
  • πŸ”§ Flexible: Use the public server or host your own
  • ✨ Simple: Just write PlantUML code blocks - no manual exports needed