mdoc-modifier-plantuml

Mdoc Modifier is a set of modifiers

License	MIT
Categories	Ant Build Tools UML Business Logic Libraries Documents Processing
GroupId	io.github.mvillafuertem
ArtifactId	mdoc-modifier-plantuml_2.13
Last Version	0.1
Release Date	Nov 22, 2019
Type	jar
Description	mdoc-modifier-plantuml Mdoc Modifier is a set of modifiers
Project URL	https://github.com/mvillafuertem/mdoc-modifier
Project Organization	io.github.mvillafuertem
Source Code Management	https://github.com/mvillafuertem/mdoc-modifier

Download mdoc-modifier-plantuml_2.13

Filename	Size
mdoc-modifier-plantuml_2.13-0.1.pom
mdoc-modifier-plantuml_2.13-0.1.jar	5 KB
mdoc-modifier-plantuml_2.13-0.1-sources.jar	2 KB
mdoc-modifier-plantuml_2.13-0.1-javadoc.jar	1 MB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.github.mvillafuertem/mdoc-modifier-plantuml_2.13/ -->
<dependency>
    <groupId>io.github.mvillafuertem</groupId>
    <artifactId>mdoc-modifier-plantuml_2.13</artifactId>
    <version>0.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.github.mvillafuertem/mdoc-modifier-plantuml_2.13/
implementation 'io.github.mvillafuertem:mdoc-modifier-plantuml_2.13:0.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.github.mvillafuertem/mdoc-modifier-plantuml_2.13/
implementation ("io.github.mvillafuertem:mdoc-modifier-plantuml_2.13:0.1")

Apache Buildr

'io.github.mvillafuertem:mdoc-modifier-plantuml_2.13:jar:0.1'

Apache Ivy

<dependency org="io.github.mvillafuertem" name="mdoc-modifier-plantuml_2.13" rev="0.1">
  <artifact name="mdoc-modifier-plantuml_2.13" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.github.mvillafuertem', module='mdoc-modifier-plantuml_2.13', version='0.1')
)

Scala SBT

libraryDependencies += "io.github.mvillafuertem" % "mdoc-modifier-plantuml_2.13" % "0.1"

Leiningen

[io.github.mvillafuertem/mdoc-modifier-plantuml_2.13 "0.1"]

Dependencies

compile (3)

Group / Artifact	Type	Version
org.scala-lang : scala-library	jar	2.13.1
org.scalameta : mdoc_2.13	jar	2.0.2
net.sourceforge.plantuml : plantuml	jar	1.2019.12

Project Modules

There are no modules declared in this project.

⚠️ PLEASE, DO NOT EDIT THIS FILE. IT IS AUTOGENERATE YOU SHOULD EDIT modules/docs/src/main/mdoc/README.md WITH THE COMMAND sbt mdoc-modifier-docs/mdoc

---

Mdoc Modifier 0.1

[TOC]

TODO: Description

Akka HTTP

libraryDependencies += "io.github.mvillafuertem" %% "mdoc-modifier-akka-http" % "0.1"

import org.scalatest._
import io.github.mvillafuertem.mdoc.modifier.akka.http.sample.SampleApplicationSpec

nocolor.run(new SampleApplicationSpec)
// SampleApplicationSpec:
// Sample Application
// Complete(HttpResponse(200 OK,List(),HttpEntity.Strict(application/json,16 bytes total),HttpProtocol(HTTP/1.1)))
// 
// ## `GET / http://example.com/health`
// 
// List()
// 
// 
// ```
// 
// HttpEntity.Strict(none/none,0 bytes total)
// 
// ```
// 
// ### Response
// 
// HTTP/1.1 200 OK
// 
// List()
// 
// ```
// 
// HttpEntity.Strict(application/json,16 bytes total)
// 
// ```
//        
// - should health

SampleApplicationSpec: Sample Application Complete(HttpResponse(200 OK,List(),HttpEntity.Strict(application/json,16 bytes total),HttpProtocol(HTTP/1.1)))

GET / http://example.com/health

List()

HttpEntity.Strict(none/none,0 bytes total)

Response

HTTP/1.1 200 OK

List()

HttpEntity.Strict(application/json,16 bytes total)

• should health

PlantUML 📊

libraryDependencies += "io.github.mvillafuertem" %% "mdoc-modifier-plantuml" % "0.1"

How use

Only add this, that's all

scala mdoc:plantuml:modules/mdoc-modifier-docs/src/main/resources/result0:png

@see http://plantuml.com/sitemap-language-specification

@startuml

participant Bob
actor Alice
 
Bob -> Alice : hello
Alice -> Bob : Is it ok?

@enduml

Support SVG

Troubleshooting 😱

Can not find Graphviz

• Install Graphviz

more information see http://plantuml.com/es/graphviz-dot

• Add this line to diagram

!pragma graphviz_dot jdot

more information see http://plantuml.com/es/smetana02

@startuml

!pragma graphviz_dot jdot
class Foo1

Foo1 --> Foo2
Foo1 --> Foo3
Foo1 ---> Foo4 : test 4
Foo1 ----> Foo5 : test 5

@enduml

Choosing colors

Versions

Version
0.1 Nov 22, 2019