asciidoctor-kroki
Advanced tools
An extension for Asciidoctor.js to convert diagrams to images using Kroki!
Install the dependencies:
$ npm install asciidoctor asciidoctor-kroki
Create a file named kroki.js with following content and run it:
const asciidoctor = require('@asciidoctor/core')()
const kroki = require('asciidoctor-kroki')
const input = 'plantuml::hello.puml[svg,role=sequence]'
kroki.register(asciidoctor.Extensions)
console.log(asciidoctor.convert(input)) // <1>
const registry = asciidoctor.Extensions.create()
kroki.register(registry)
console.log(asciidoctor.convert(input, {'extension_registry': registry})) // <2>
<1> Register the extension in the global registry <2> Register the extension in a dedicated registry
Install the dependencies:
$ npm install asciidoctor asciidoctor-kroki
Create a file named kroki.html with the following content and open it in your browser:
<html>
<head>
<script src="node_modules/@asciidoctor/core/dist/browser/asciidoctor.js"></script>
<script src="node_modules/asciidoctor-kroki/dist/browser/asciidoctor-kroki.js"></script>
</head>
<body>
<div id="content"></div>
<script>
var input = 'plantuml::hello.puml[svg,role=sequence]'
var asciidoctor = Asciidoctor()
var kroki = AsciidoctorKroki
const registry = asciidoctor.Extensions.create()
kroki.register(registry)
var result = asciidoctor.convert(input, {'extension_registry': registry})
document.getElementById('content').innerHTML = result
</script>
</body>
</html>
<1> Register the extension in the global registry <2> Register the extension in a dedicated registry
[plantuml,alice-bob,svg,role=sequence]
....
alice -> bob
....
[graphviz]
....
digraph foo {
node [style=rounded]
node1 [shape=box]
node2 [fillcolor=yellow, style="rounded,filled", shape=diamond]
node3 [shape=record, label="{ a | b | c }"]
node1 -> node2 -> node3
}
....
To build this project, you will need Node.js >= 8.11 and npm (we recommend nvm to manage multiple active Node.js versions).
Install the dependencies:
$ npm i
Generate a distribution:
$ npm run dist
When working on a new feature or when fixing a bug, make sure to run the linter and the tests suite:
$ npm run lint
$ npm run test
FAQs
Asciidoctor extension to convert diagrams to images using Kroki
The npm package asciidoctor-kroki receives a total of 11,032 weekly downloads. As such, asciidoctor-kroki popularity was classified as popular.
We found that asciidoctor-kroki demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious Go packages are impersonating popular libraries to install hidden loader malware on Linux and macOS, targeting developers with obfuscated payloads.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.