reveal-plantuml / reveal-plantuml.github.io

A reveal.js plugin that allow using PlantUML diagrams on slides

reveal-plantuml

A reveal.js plugin that allow using PlantUML diagrams on HTML and Markdown slides. Check live demo to see plugin in action.

Installation

You can use the plugin directly from CDN:

Reveal.initialize({
  dependencies: [
    { src: '//cdn.jsdelivr.net/npm/reveal-plantuml' },
  ]
});

or install using npm:

npm i reveal-plantuml

Usage

Simply put PlantUML diagrams in code block. In markdown use plantuml language type:

```plantuml
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: Another authentication Response
@enduml
```

The @startuml and @enduml lines are optional.

In HTML use language-plantuml class in code element inside of pre element:

<pre>
<code class="language-plantuml">
  @startuml
  Alice -> Bob: Authentication Request
  Bob --> Alice: Authentication Response
  Alice -> Bob: Another authentication Request
  Bob --> Alice: Another authentication Response
  @enduml
</code>
</pre>

The @startuml and @enduml lines are optional.

Options

You can set PlantUML server path using serverPath configuration option:

Reveal.initialize({
  plantuml: {
      serverPath: 'https://plantuml.example.com/plantuml/svg/'
  }
  dependencies: [
    { src: '//cdn.jsdelivr.net/npm/reveal-plantuml' },
  ]
});

The default server path is //www.plantuml.com/plantuml/svg

License

This project is licensed under the MIT License. See the LICENSE for details.

reveal-plantuml.github.io's Issues

Failed to load resource: too many HTTP redirects

[Error] Failed to load resource: too many HTTP redirects (reveal-plantuml, line 0)

As title, I am going crazy to make this plugin work. I know the import is deprecated from reveal.js, but I was able to make it work, commit to my local GitHub repo, changed theme, and then everything got broken and I can't even render plantUML files on the demo presentation you provide.

Also, I tried to install it via npm i reveal-plantuml but didn't have any success. Can you please help me? I'm going crazy!

Markdown examples use incorrect language annotation

I could not get the plugin to correctly render PlantUML diagrams defined in Markdown sections. It turns out, it's also necessary to use language-plantuml instead of just plantuml to make the diagrams render. This is on Reveal.js-4.1.0, so it might be a change in that codebase that causes the examples to fail.

Long diagrams are not resized to fit screen

If a diagram does not fit the screen, I expect it to be resized to not exceed the screen. Instead, it is currently cut off.

Would you have an idea how I could achieve a scaled diagram?