Skip to content

Commit

Permalink
docs: Added section on includes with Antora
Browse files Browse the repository at this point in the history
  • Loading branch information
mcbeelen committed Apr 17, 2023
1 parent 91b4f32 commit 4a4becf
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,25 @@ include::alice-bob.puml[]

![PlantUML diagram](https://kroki.io/plantuml/png/eNpzKC5JLCopzc3hSszJTE5V0LVTSMpP4nJIzUsBCgIApPUKcg==)

### References and includes with Antora

If you use this Asciidoctor Kroki Extension in combination with Antora, all references and includes MUST use [Antora Resource IDs](https://docs.antora.org/antora/latest/page/resource-id/). The `.puml`-files are best placed in the [_partials_-directory](https://docs.antora.org/antora/latest/page/partials/) of the modules.

#### Block macros

```shell
vegalite::partial$chart.vlite[svg,role=chart,opts=interactive]
```
#### Includes

```shell
[plantuml,alice-bob,svg,role=sequence]
----
include::partial$alice-bob.puml[]
----
```


### Syntax

You can declare positional and named attributes when using the block or the macro form.
Expand Down

0 comments on commit 4a4becf

Please sign in to comment.