Skip to content

feat: Add Antora Mermaid extension #791

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 3, 2025
Merged

feat: Add Antora Mermaid extension #791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions antora-playbook.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ urls:
redirect_facility: netlify
# See https://docs.antora.org/antora/latest/playbook/urls-html-extension-style/#html-extension-style-key
html_extension_style: indexify
antora:
extensions:
- require: '@sntke/antora-mermaid-extension'
mermaid_library_url: https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs
content:
sources:
- url: .
Expand Down Expand Up @@ -267,8 +271,6 @@ asciidoc:
- '@asciidoctor/tabs'
attributes:
base-repo: https://github.com/stackabletech
plantuml-server-url: http://www.plantuml.com/plantuml
kroki-fetch-diagram: true
# an external icon. Create a link opening in a new tab like this: http://my-url.com[Text {external-link-icon}^]
external-link-icon: "<i class=\"fa-solid fa-arrow-up-right-from-square fa-xs\" style=\"margin-left: 3px; vertical-align: baseline;\"></i>"
# the default caching directory is ./.cache/antora
Expand Down
6 changes: 4 additions & 2 deletions local-antora-playbook.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ urls:
# This replaces the component version in the URL of the latest stable version with 'stable'
# i.e. /commons-operator/stable/index.html instead of /commons-operator/0.3/index.html
latest_version_segment: stable
antora:
extensions:
- require: '@sntke/antora-mermaid-extension'
mermaid_library_url: https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs
content:
sources:
- url: ./
Expand Down Expand Up @@ -252,8 +256,6 @@ asciidoc:
- '@asciidoctor/tabs'
attributes:
base-repo: https://github.com/stackabletech
plantuml-server-url: http://www.plantuml.com/plantuml
kroki-fetch-diagram: true
# an external icon. Create a link opening in a new tab like this: http://my-url.com[Text {external-link-icon}^]
external-link-icon: "<i class=\"fa-solid fa-arrow-up-right-from-square fa-xs\" style=\"margin-left: 3px; vertical-align: baseline;\"></i>"
# the default caching directory is ./.cache/antora
Expand Down
6 changes: 4 additions & 2 deletions only-dev-antora-playbook.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ urls:
# This replaces the component version in the URL of the latest stable version with 'stable'
# i.e. /commons-operator/stable/index.html instead of /commons-operator/0.3/index.html
latest_version_segment: stable
antora:
extensions:
- require: '@sntke/antora-mermaid-extension'
mermaid_library_url: https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs
content:
sources:
- url: ./
Expand Down Expand Up @@ -99,8 +103,6 @@ asciidoc:
- '@asciidoctor/tabs'
attributes:
base-repo: https://github.com/stackabletech
plantuml-server-url: http://www.plantuml.com/plantuml
kroki-fetch-diagram: true
# an external icon. Create a link opening in a new tab like this: http://my-url.com[Text {external-link-icon}^]
external-link-icon: "<i class=\"fa-solid fa-arrow-up-right-from-square fa-xs\" style=\"margin-left: 3px; vertical-align: baseline;\"></i>"
# the default caching directory is ./.cache/antora
Expand Down
9 changes: 8 additions & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
},
"dependencies": {
"@antora/lunr-extension": "^1.0.0-alpha.8",
"@asciidoctor/tabs": "^1.0.0-beta.6"
"@asciidoctor/tabs": "^1.0.0-beta.6",
"@sntke/antora-mermaid-extension": "0.0.8"
},
"workspaces": [
"ui"
Expand Down
6 changes: 4 additions & 2 deletions truly-local-playbook.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ urls:
# This replaces the component version in the URL of the latest stable version with 'stable'
# i.e. /commons-operator/stable/index.html instead of /commons-operator/0.3/index.html
latest_version_segment: stable
antora:
extensions:
- require: '@sntke/antora-mermaid-extension'
mermaid_library_url: https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs
content:
sources:
- url: ./
Expand Down Expand Up @@ -64,8 +68,6 @@ asciidoc:
- '@asciidoctor/tabs'
attributes:
base-repo: https://github.com/stackabletech
plantuml-server-url: http://www.plantuml.com/plantuml
kroki-fetch-diagram: true
# an external icon. Create a link opening in a new tab like this: http://my-url.com[Text {external-link-icon}^]
external-link-icon: "<i class=\"fa-solid fa-arrow-up-right-from-square fa-xs\" style=\"margin-left: 3px; vertical-align: baseline;\"></i>"
# the default caching directory is ./.cache/antora
Expand Down
Loading