plantuml-maven-plugin

KO | EN

gitlite — search

#python #react #typescript #machine-learning #linux #nodejs #windows #kubernetes #awesome-list #security #mcp #ios #openai #open-source

plantuml-maven-plugin

(★ 15)

Maven plugin for generating diagram images from PlantUML files

plantuml-maven-plugin 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# plantuml-maven-plugin 
<a href="https://github.com/davidmoten/plantuml-maven-plugin/actions/workflows/ci.yml"><img src="https://github.com/davidmoten/plantuml-maven-plugin/actions/workflows/ci.yml/badge.svg"/></a><br/>
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.davidmoten/plantuml-maven-plugin/badge.svg?style=flat)](https://maven-badges.herokuapp.com/maven-central/com.github.davidmoten/plantuml-maven-plugin)<br/>

A [maven](http://maven.apache.org/) plugin that generates UML diagrams from [PlantUML](http://plantuml.sourceforge.net/) files (text files).

**Status**: *released to Maven Central*

## Usage
To generate images from PlantUML source when you build your project add this to your pom.xml:

```xml
...
<build>
    <plugins>
        <plugin>
            <groupId>com.github.davidmoten</groupId>
            <artifactId>plantuml-maven-plugin</artifactId>
            <version>VERSION_HERE</version>
            <executions>
                <execution>
                    <id>generate-diagrams</id>
                    <phase>generate-resources</phase>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <sources>
                    <directory>${basedir}/src/main/plantuml</directory>
                    <includes>
                        <include>**/*.puml</include>
                    </includes>
                    <excludes>
                        <exclude>**/ignore-me.puml</exclude>
                    </excludes>
                </sources>
                <outputDirectory>${project.build.directory}/generated-diagrams</outputDirectory>
                <formats>
                    <format>png</format>
                    <format>svg</format>
                </formats>
                <preserveDirectoryStructure>false</preserveDirectoryStructure>
                <generateMarkdownIndex>true</generateMarkdownIndex>
            </configuration>
        </plugin>
    </plugins>
</build>
```
### PlantUML Config lines and files

If for example you want to include `skin rose` at the start of every plantuml file while processing then you can specify 
config lines or config files for that purpose.

Here's how you include `skin rose` at the start of every plantuml file with config lines.

This fragment goes in the maven plugin `<configuration>` section as above:
```xml
<configs>
  <config>skin rose</config>
</config>
```

Here's how you do the same using a config file rather than lines:
```xml
<configFiles>
  <configFile>src/main/plantuml/global.config</configFile>
</configFiles>
```

global.config:
```
skin rose
```

### Configuration defaults

Defaults for the `<configuration>` element are:

* **sources**: 
  * **directory**: `src/main/plantuml`
  * **includes**: `**/*.puml`, `**/*.plantuml`, `**/*.txt`
  * **excludes**: none
* **outputDirectory**: `target/generated-diagrams`
* **configs**: none
* **formats**: `png`
* **metadata**: `true`
* **writePreproc**: `false`
* **preserveDirectoryStructure**: `false`
* **skip**: `false`
* **generateMarkdownIndex**: `true`

### Minimal plugin configuration

Minimal on-demand use looks like this:

```xml
<build>
    <plugins>
        <plugin>
            <groupId>com.github.davidmoten</groupId>
            <artifactId>plantuml-maven-plugin</artifactId>
            <version>VERSION_HERE</version>
        </plugin>
    </plugins>
</build>
```
Then execute command:

```
mvn clean com.github.davidmoten:plantuml-maven-plugin:generate
```

## How to build
```bash
mvn clean install
```

plantuml-maven-plugin

plantuml-maven-plugin 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

plantuml-maven-plugin

plantuml-maven-plugin 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README