Commit `753f773650`

753f7736507fbe15f790f3a14b233af0ccc0e5ea

parent: eb2beb19c9

Unsigned

cmc <hello@cleberg.net> · 2026-08-28 18:51 UTC

OrgSwift: image-as-link descriptions render as clickable images

An org link whose description is itself an image — [[url][file:badge.svg]] (the
common build-badge form) or [[url][[badge.svg]]] — makes the image the anchor's
content instead of showing the raw description text. A plain-text description
that merely looks path-like stays text.

Layout: unified · split

Sources/OrgSwift/Links.swift +22 −8

     target.hasPrefix("file:") ? String(target.dropFirst(5)) : target
 }
+/// If a link *description* is itself an image reference — `[[img]]`, a `file:` image, or an
+/// image URL — return its source, so the image becomes the link's content. A bare relative
+/// string (`img.png`) is a plain text description, not an image.
+private func descriptionImageSource(_ label: String) -> String? {
+    if label.hasPrefix("[["), label.hasSuffix("]]") {
+        return String(label.dropFirst(2).dropLast(2))
+    }
+    if label.hasPrefix("file:") || label.hasPrefix("http://") || label.hasPrefix("https://") {
+        return label
+    }
+    return nil
+}
 private func renderOrgLink(
     destination rawDestination: String,
     label: String?,
         return ##"<a href="#\##(escapeHTMLAttribute(id))">\##(text)</a>"##
     }
     let destination = normalizeOrgLinkTarget(rawDestination)
-    if let label, label.hasPrefix("[["), label.hasSuffix("]]") {
+    // A description that is itself an image link (`[[url][file:badge.svg]]`, the common
-        let source = String(label.dropFirst(2).dropLast(2))
+    // build-badge form, or the double-bracketed `[[url][[badge.svg]]]`) makes the image the
-        if let imageHTML = makeOrgImageHTML(source: source, alt: nil, imageURLResolver: imageURLResolver) {
+    // clickable content of the link. A plain-text description like `img.png` stays text.
-            let resolvedDestination = linkURLResolver?(destination) ?? destination
+    if let label, let source = descriptionImageSource(label),
-            guard let sanitizedURL = sanitizedReadmeLinkURLString(resolvedDestination) else {
+       let imageHTML = makeOrgImageHTML(source: source, alt: nil, imageURLResolver: imageURLResolver) {
-                return imageHTML
+        let resolvedDestination = linkURLResolver?(destination) ?? destination
-            }
+        guard let sanitizedURL = sanitizedReadmeLinkURLString(resolvedDestination) else {
-            return #"<a href="\#(sanitizedURL)">\#(imageHTML)</a>"#
+            return imageHTML
         }
+        return #"<a href="\#(sanitizedURL)">\#(imageHTML)</a>"#
     }
     // A bare `[[image]]` with no description is an inline image. `[[image][text]]` is a

Tests/OrgSwiftTests/OrgRendererTests.swift +16

	@@ -325,6 +325,22 @@ struct OrgRendererTests {
325	#expect(!html.contains("<img"))	325	#expect(!html.contains("<img"))
326	}	326	}
327		327
		328	@Test
		329	func imageDescriptionBecomesClickableImage() {
		330	// A build-badge: the description is itself an image, so it is the link's content.
		331	let badge = render("[[https://example.com/builds][file:https://example.com/badge.svg]]")
		332	#expect(badge.contains(#"<a href="https://example.com/builds"><img src="https://example.com/badge.svg" alt=""></a>"#))
		333
		334	// The double-bracketed form works the same.
		335	let bracketed = render("[[https://example.com/builds][[https://example.com/badge.svg]]]")
		336	#expect(bracketed.contains(#"<a href="https://example.com/builds"><img"#))
		337
		338	// A plain-text description that merely looks path-like stays text.
		339	let plain = render("[[https://example.com][see diagram.png]]")
		340	#expect(plain.contains(#"<a href="https://example.com">see diagram.png</a>"#))
		341	#expect(!plain.contains("<img"))
		342	}
		343
328	@Test	344	@Test
329	func captionPromotesImageToFigure() {	345	func captionPromotesImageToFigure() {
330	let html = render("""	346	let html = render("""

Commit 753f773650

Commit `753f773650`