跳到内容

PlantUML & GitLab

介绍了在GitLab 8.16中。

当PlantUML集成是在GitLab中启用和配置的，我们能够在AsciiDoc中创建简单的图表，并在snippet, wikis和repos中创建Markdown文档。

PlantUML服务器

在GitLab中启用PlantUML之前;您需要设置自己的PlantUML服务器来生成图表。

码头工人

使用Docker，你可以像这样运行一个容器:

Docker运行-d——name plantuml -p 8080:8080 plantuml/plantuml-server:tomcat

的PlantUML URL将是运行容器的服务器的主机名。

Debian / Ubuntu

在Debian/Ubuntu发行版中使用Tomcat安装和配置您自己的PlantUML服务器是很容易的。

首先你需要创建一个plantuml.war文件来自源代码:

Sudo apt-get install graphviz openjdk-7-jdk git-core mavenGit克隆https://github.com/plantuml/plantuml-server.gitcd plantuml-servermvn包

上面的命令序列将生成一个可以使用Tomcat部署的WAR文件:

Sudo apt-get install tomcat7Sudo cp target/plantuml。战争/var/lib/tomcat7/webapps/plantuml.warSudo chown tomcat7:tomcat7 /var/lib/tomcat7/webapps/plantum .warSudo服务tomcat7重启

一旦Tomcat服务重新启动，PlantUML服务将准备就绪，并在端口8080上监听请求:

http://localhost:8080/plantuml

属性可以更改这些默认值/etc/tomcat7/server.xml文件。

GitLab

您需要在“管理区域”下的“设置”中启用PlantUML集成。要做到这一点，请使用Admin帐户登录并执行以下操作:

  • 在GitLab转到管理区域然后设置
  • 滚动到页面底部，直到PlantUML部分
  • 检查使PlantUML复选框
  • 将PlantUML实例设置为PlantUML URL

创建图

随着PlantUML集成的启用和配置，我们可以开始添加图表到我们的AsciiDoc片段，wikis和repos使用分隔块:

  • 减价

    plantuml Bob -> Alice:你好Alice -> Bob:走开

  • AsciiDoc

    [plantuml, format="png"， id="myDiagram"， width="200px"]——Bob->Alice:你好Alice -> Bob:走开——

  • reStructuredText

    . .标题:用**粗体**和*斜体*的标题Bob -> Alice:你好Alice -> Bob:走开

    你也可以使用uml::兼容指令sphinxcontrib-plantuml，但请注意，我们目前只支持标题选择。

上面的块将被转换为HTML img标记，其源指向PlantUML实例。如果PlantUML服务器配置正确，这应该呈现一个漂亮的图表，而不是块:

PlantUML集成

在该块中，您可以添加PlantUML支持的任何图表，例如序列，用例，类，活动，组件，状态,对象图。您不需要使用PlantUML图分隔符@startuml/@enduml因为这些都被AsciiDoc取代了plantuml块。

一些参数可以添加到AsciiDoc块定义中:

  • 格式:两者皆有png或svg．请注意,svg并非所有浏览器都支持，因此请谨慎使用。默认为png．
  • id:添加到图表HTML标记中的CSS id。
  • 宽度: img标签中添加的宽度属性。
  • 高度: img标签中添加的高度属性。

Markdown不支持任何参数，始终使用PNG格式。

Baidu
map