modules/docs/src/main/mdoc/README.md
WITH THE COMMAND sbt mdoc-modifier-docs/mdoc
[TOC]
TODO: Description
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 healthSampleApplicationSpec: Sample Application Complete(HttpResponse(200 OK,List(),HttpEntity.Strict(application/json,16 bytes total),HttpProtocol(HTTP/1.1)))
List()
HttpEntity.Strict(none/none,0 bytes total)
HTTP/1.1 200 OK
List()
HttpEntity.Strict(application/json,16 bytes total)
- should health
libraryDependencies += "io.github.mvillafuertem" %% "mdoc-modifier-plantuml" % "0.1"
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
- Install Graphviz
more information see http://plantuml.com/es/graphviz-dot
- Add this line to diagram
!pragma layout smetana
more information see http://plantuml.com/es/smetana02
@startuml
!pragma layout smetana
class Foo1
Foo1 --> Foo2
Foo1 --> Foo3
Foo1 ---> Foo4 : test 4
Foo1 ----> Foo5 : test 5
@enduml
