christianblos/codedocs-plugin-plantuml

Plugin for CodeDocs to generate UML diagrams via PlantUML

1.1.1 2016-07-08 12:46 UTC

Requires (Dev)

• christianblos/codedocs: ~2.3

MIT

• Christian Blos

README

This plugin uses PlantUML to generate UML diagrams.

Installation

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

Execute composer require christianblos/codedocs-plugin-plantuml.

Add this plugin to your codedocs.yaml file:

plugins:
  - \CodeDocs\PlantUml

Usage

Create a puml-File next to the markdown files.

docs
 |- example.md
 |- diagram.puml

diagram.puml:

@startuml

A -> B

@enduml

Use the PlantUml-Markup to show this diagram.

example.md:

{@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:

finalizers:
  - \CodeDocs\PlantUml\CreateImagesFinalizer

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