christianblos/codedocs-plugin-plantuml

用于通过 PlantUML 生成 UML 图表的 CodeDocs 插件

维护者

详细信息

github.com/christianblos/codedocs-plugin-plantuml

源代码

问题

安装: 28

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 0

开放问题: 0

1.1.1 2016-07-08 12:46 UTC

Requires (Dev)

MIT 9ecc9d16b5a7195da2f55c10c03714afd155470c

  • Christian Blos <christian.blos.woop@gmx.de>

This package is auto-updated.

Last update: 2024-09-08 23:07:40 UTC

README

此插件使用 PlantUML 生成 UML 图表。

安装

警告：此插件尚不支持 CodeDocs 3.0。您需要 CodeDocs 版本 2 才能使用它。

执行 composer require christianblos/codedocs-plugin-plantuml。

将此插件添加到您的 codedocs.yaml 文件中

plugins:
  - \CodeDocs\PlantUml

用法

在 markdown 文件旁边创建一个 puml 文件。

docs
 |- example.md
 |- diagram.puml

diagram.puml

@startuml

A -> B

@enduml

使用 PlantUml-Markup 显示此图表。

example.md

{@PlantUml("diagram")}

使用 plantuml.jar

您可以指定一个 plantuml.jar 的路径来生成图像，而不是即时渲染。您还必须在配置中添加以下 finalizer

finalizers:
  - \CodeDocs\PlantUml\CreateImagesFinalizer

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