christianblos/codedocs-plugin-plantuml

Plugin for CodeDocs to generate UML diagrams via PlantUML

CodeDocs Plugin for PlantUML

This plugin uses PlantUML to generate UML diagrams., _(*1)

Installation

Warning: This Plugin is not yet supported by CodeDocs 3.0. You need Version 2 of CodeDocs to make use of it., _(*2)

Execute composer require christianblos/codedocs-plugin-plantuml., _(*3)

Add this plugin to your codedocs.yaml file:, _(*4)

plugins:
  - \CodeDocs\PlantUml

Usage

Create a puml-File next to the markdown files., _(*5)

docs
 |- example.md
 |- diagram.puml

diagram.puml:, _(*6)

@startuml

A -> B

@enduml

Use the PlantUml-Markup to show this diagram., _(*7)

example.md:, _(*8)

{@PlantUml("diagram")}

Use plantuml.jar

You can specify a path to a plantuml.jar to generates images instead of render them on the fly. You also have to add the following finalizer to the config:, _(*9)

finalizers:
  - \CodeDocs\PlantUml\CreateImagesFinalizer

plugins:
  - \CodeDocs\PlantUml:
      jar: ./plantuml.jar