Skip to content

Commit

Permalink
resolves #166 explain how to install and require the Ruby library
Browse files Browse the repository at this point in the history
resolves #166
  • Loading branch information
ggrossetie committed Nov 6, 2020
1 parent 4ee624f commit b95403c
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ An extension for [Asciidoctor.js](https://github.com/asciidoctor/asciidoctor.js)
* [Install](#install)
+ [Node.js](#nodejs)
+ [Browser](#browser)
+ [Ruby](#ruby)
+ [Antora Integration](#antora-integration)
* [Usage](#usage)
+ [Supported diagram types](#supported-diagram-types)
Expand Down Expand Up @@ -104,6 +105,16 @@ const input = 'plantuml::hello.puml[svg,role=sequence]'
asciidoctor.convert(input, { base_dir: window.location.origin, safe: 'safe', extension_registry: registry })
```

### Ruby

Install the dependency:

$ gem install asciidoctor-kroki

Require the library using the `--require` (or `-r`) option from the Asciidoctor CLI:

$ asciidoctor -r asciidoctor-kroki doc.adoc

### Antora Integration

If you are using [Antora](https://antora.org/), you can integrate Kroki in your documentation site.
Expand Down

0 comments on commit b95403c

Please sign in to comment.