asciidoctor / asciidoctor-reveal.js

:crystal_ball: A reveal.js converter for Asciidoctor and Asciidoctor.js. Write your slides in AsciiDoc!
http://asciidoctor.org
Other
287 stars 189 forks source link

Document how to integrate Kroki #366

Open sebrautu opened 4 years ago

sebrautu commented 4 years ago

I used to embedded simple plantuml diagrams in my asciidoctor docs.

Is it possible to add the kroki extension for Asciidoctor.js ? https://github.com/Mogztter/asciidoctor-kroki

ggrossetie commented 4 years ago

Hello @sebrautu

It's actually working if you are using the Node/JavaScript.

$ mkdir asciidoctor-revealjs-kroki
$ cd asciidoctor-revealjs-kroki
$ npm init -y
$ npm i --save asciidoctor@^2.0 @asciidoctor/reveal.js asciidoctor-kroki

Check that everything is working:

$ npx asciidoctor-revealjs --version
Asciidoctor reveal.js 4.0.1 using Asciidoctor.js 2.2.0 (Asciidoctor 2.0.10) [https://asciidoctor.org]
Runtime Environment (node v12.16.1 on linux)
CLI version 3.4.0

Create a presentation:

$ cat presentation.adoc
= Title Slide
:revealjs_theme: beige

== Slide One

* Foo
* Bar
* World

== Pirate

[nomnoml]
....
[Pirate|eyeCount: Int|raid();pillage()|
  [beard]--[parrot]
  [beard]-:>[foul mouth]
]

[<abstract>Marauder]<:--[Pirate]
[Pirate]- 0..7[mischief]
[jollyness]->[Pirate]
[jollyness]->[rum]
[jollyness]->[singing]
[Pirate]-> *[rum|tastiness: Int|swig()]
[Pirate]->[singing]
[singing]<->[rum]

[<start>st]->[<state>plunder]
[plunder]->[<choice>more loot]
[more loot]->[st]
[more loot] no ->[<end>e]

[<actor>Sailor] - [<usecase>shiver me;timbers]
....

Convert using the --require (-r for short) option to require the Asciidoctor Kroki extension:

$ npx asciidoctor-revealjs -r asciidoctor-kroki presentation.adoc

And here's the result :tada: :tada: :tada:

beige-kroki

ggrossetie commented 3 years ago

We should add this in the documentation.