Skip to content

fix(site): don't caption badges, center image captions #331

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
petermuessig merged 1 commit into from
Aug 13, 2026
+18 −12
Merged

fix(site): don't caption badges, center image captions #331

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
8 changes: 6 additions & 2 deletions assets/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,12 +169,16 @@ li > section.ts-only, li > section.js-only {

/* Image captions rendered from each image's alt text (see renderImageCaptions
in assets/js/custom.js). Restores the SAP Demo Kit behavior of showing the
image description below the figure. */
image description below the figure. The figure shrink-wraps to the image and
is centered on the page, with the caption centered beneath the image. */
figure.img-figure {
margin: 16px 0;
display: table;
margin: 16px auto;
}

figure.img-figure > .img-caption {
display: table-caption;
caption-side: bottom;
margin-top: 6px;
font-size: 90%;
font-style: italic;
Expand Down
22 changes: 12 additions & 10 deletions assets/js/custom.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,21 +297,23 @@ function renderImageCaptions() {
return; // already processed
}

// A link-wrapped image is captioned via its anchor; otherwise the image
// itself is the wrap target.
const wrapTarget =
img.parentElement && img.parentElement.tagName === "A"
? img.parentElement
: img;
const host = wrapTarget.parentElement;
// Skip link-wrapped images. In the tutorials these are badges / icons
// (e.g. the REUSE status badge `[![…](…)](…)`), never a preview
// screenshot — content images are always plain `![alt](assets/…)`. A
// linked image should not get a caption.
if (img.parentElement && img.parentElement.tagName === "A") {
return;
}

const host = img.parentElement;
if (!host) {
return;
}

// Only caption block-level "preview" images — those that are the sole
// meaningful content of their containing block. This skips inline
// images sitting inside a line of prose (badges, inline icons), which
// should not get a centered caption. `host.textContent` is empty for a
// should not get a caption. `host.textContent` is empty for a
// standalone image because the <img> contributes no text.
if (host.textContent.trim() !== "") {
return;
Expand All @@ -324,8 +326,8 @@ function renderImageCaptions() {
figcaption.classList.add("img-caption");
figcaption.textContent = caption;

wrapTarget.parentNode.insertBefore(figure, wrapTarget);
figure.appendChild(wrapTarget);
img.parentNode.insertBefore(figure, img);
figure.appendChild(img);
figure.appendChild(figcaption);
});
}
Expand Down