Skip to content

Commit 7a7d4d5

Browse files
authored
feat: Add Antora Mermaid extension (#791)
1 parent bfd47c8 commit 7a7d4d5

File tree

6 files changed

+26
-10
lines changed

6 files changed

+26
-10
lines changed

antora-playbook.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ urls:
2525
redirect_facility: netlify
2626
# See https://docs.antora.org/antora/latest/playbook/urls-html-extension-style/#html-extension-style-key
2727
html_extension_style: indexify
28+
antora:
29+
extensions:
30+
- require: '@sntke/antora-mermaid-extension'
31+
mermaid_library_url: https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs
2832
content:
2933
sources:
3034
- url: .
@@ -267,8 +271,6 @@ asciidoc:
267271
- '@asciidoctor/tabs'
268272
attributes:
269273
base-repo: https://github.com/stackabletech
270-
plantuml-server-url: http://www.plantuml.com/plantuml
271-
kroki-fetch-diagram: true
272274
# an external icon. Create a link opening in a new tab like this: http://my-url.com[Text {external-link-icon}^]
273275
external-link-icon: "<i class=\"fa-solid fa-arrow-up-right-from-square fa-xs\" style=\"margin-left: 3px; vertical-align: baseline;\"></i>"
274276
# the default caching directory is ./.cache/antora

local-antora-playbook.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ urls:
1010
# This replaces the component version in the URL of the latest stable version with 'stable'
1111
# i.e. /commons-operator/stable/index.html instead of /commons-operator/0.3/index.html
1212
latest_version_segment: stable
13+
antora:
14+
extensions:
15+
- require: '@sntke/antora-mermaid-extension'
16+
mermaid_library_url: https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs
1317
content:
1418
sources:
1519
- url: ./
@@ -252,8 +256,6 @@ asciidoc:
252256
- '@asciidoctor/tabs'
253257
attributes:
254258
base-repo: https://github.com/stackabletech
255-
plantuml-server-url: http://www.plantuml.com/plantuml
256-
kroki-fetch-diagram: true
257259
# an external icon. Create a link opening in a new tab like this: http://my-url.com[Text {external-link-icon}^]
258260
external-link-icon: "<i class=\"fa-solid fa-arrow-up-right-from-square fa-xs\" style=\"margin-left: 3px; vertical-align: baseline;\"></i>"
259261
# the default caching directory is ./.cache/antora

only-dev-antora-playbook.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ urls:
1010
# This replaces the component version in the URL of the latest stable version with 'stable'
1111
# i.e. /commons-operator/stable/index.html instead of /commons-operator/0.3/index.html
1212
latest_version_segment: stable
13+
antora:
14+
extensions:
15+
- require: '@sntke/antora-mermaid-extension'
16+
mermaid_library_url: https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs
1317
content:
1418
sources:
1519
- url: ./
@@ -99,8 +103,6 @@ asciidoc:
99103
- '@asciidoctor/tabs'
100104
attributes:
101105
base-repo: https://github.com/stackabletech
102-
plantuml-server-url: http://www.plantuml.com/plantuml
103-
kroki-fetch-diagram: true
104106
# an external icon. Create a link opening in a new tab like this: http://my-url.com[Text {external-link-icon}^]
105107
external-link-icon: "<i class=\"fa-solid fa-arrow-up-right-from-square fa-xs\" style=\"margin-left: 3px; vertical-align: baseline;\"></i>"
106108
# the default caching directory is ./.cache/antora

package-lock.json

Lines changed: 8 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
},
77
"dependencies": {
88
"@antora/lunr-extension": "^1.0.0-alpha.8",
9-
"@asciidoctor/tabs": "^1.0.0-beta.6"
9+
"@asciidoctor/tabs": "^1.0.0-beta.6",
10+
"@sntke/antora-mermaid-extension": "0.0.8"
1011
},
1112
"workspaces": [
1213
"ui"

truly-local-playbook.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ urls:
1010
# This replaces the component version in the URL of the latest stable version with 'stable'
1111
# i.e. /commons-operator/stable/index.html instead of /commons-operator/0.3/index.html
1212
latest_version_segment: stable
13+
antora:
14+
extensions:
15+
- require: '@sntke/antora-mermaid-extension'
16+
mermaid_library_url: https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs
1317
content:
1418
sources:
1519
- url: ./
@@ -64,8 +68,6 @@ asciidoc:
6468
- '@asciidoctor/tabs'
6569
attributes:
6670
base-repo: https://github.com/stackabletech
67-
plantuml-server-url: http://www.plantuml.com/plantuml
68-
kroki-fetch-diagram: true
6971
# an external icon. Create a link opening in a new tab like this: http://my-url.com[Text {external-link-icon}^]
7072
external-link-icon: "<i class=\"fa-solid fa-arrow-up-right-from-square fa-xs\" style=\"margin-left: 3px; vertical-align: baseline;\"></i>"
7173
# the default caching directory is ./.cache/antora

0 commit comments

Comments
 (0)