Commit `72d3e10034`

72d3e10034006cf0c5ff11ee8bb255c64992ab96

parent: 753f773650

Unsigned

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

OrgSwift: configurable path segments for relative URL resolution

Add imagePathSegment/linkPathSegment to OrgRenderOptions (default blob). A forge
that serves raw bytes on a separate route can now resolve relative images against
one segment and links against another — gitbay uses raw for images, blob for links.

Layout: unified · split

Sources/OrgSwift/Links.swift +8 −4

     owner: String,
     repositoryName: String,
     ref: String,
-    readmePath: String?
+    readmePath: String?,
+    pathSegment: String = "blob"
 ) -> String? {
     let trimmedSource = source.trimmingCharacters(in: .whitespacesAndNewlines)
     guard !trimmedSource.isEmpty else { return nil }
         owner: owner,
         repositoryName: repositoryName,
         ref: ref,
-        readmePath: readmePath
+        readmePath: readmePath,
+        pathSegment: pathSegment
     )
 }
     owner: String,
     repositoryName: String,
     ref: String,
-    readmePath: String?
+    readmePath: String?,
+    pathSegment: String = "blob"
 ) -> String? {
     let trimmedSource = source.trimmingCharacters(in: .whitespacesAndNewlines)
     guard !trimmedSource.isEmpty else { return nil }
             String(segment).addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? String(segment)
         }
         .joined(separator: "/")
-    components.percentEncodedPath = "/\(encodedOwner)/\(encodedRepository)/blob/\(encodedRef)/\(encodedRelativePath)"
+    let encodedSegment = pathSegment.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? pathSegment
+    components.percentEncodedPath = "/\(encodedOwner)/\(encodedRepository)/\(encodedSegment)/\(encodedRef)/\(encodedRelativePath)"
     return components.string
 }

Sources/OrgSwift/OrgRenderer.swift +19 −4

     public var owner: String?
     /// Repository name. Nil disables relative-link resolution.
     public var repositoryName: String?
-    /// Git ref used in the `blob/<ref>` path segment.
+    /// Git ref used in the `<segment>/<ref>` path segment.
     public var ref: String
     /// Path of the README being rendered, used to resolve paths relative to it.
     public var readmePath: String?
+    /// Path segment for a resolved relative *image* URL: `<host>/<owner>/<repo>/<segment>/…`.
+    /// Defaults to `blob`; forges that serve raw bytes on a different route (gitbay uses
+    /// `raw`) set this so an `<img src>` points at the file, not its HTML viewer page.
+    public var imagePathSegment: String
+    /// Path segment for a resolved relative *link* URL. Defaults to `blob` — a link should
+    /// open the file's page, not its raw bytes.
+    public var linkPathSegment: String
     /// Emit a leading `<div class="org-metadata">` block for `#+TITLE`/`#+AUTHOR`/`#+DATE`.
     /// Apps that show a README title want this; orgo treats those keywords as document
     /// metadata carried by the page template, not body content, so the conformance corpus
         ref: String = "HEAD",
         readmePath: String? = nil,
         metadataHeader: Bool = true,
-        headingLevelOffset: Int = 0
+        headingLevelOffset: Int = 0,
+        imagePathSegment: String = "blob",
+        linkPathSegment: String = "blob"
     ) {
         self.host = host
         self.owner = owner
         self.readmePath = readmePath
         self.metadataHeader = metadataHeader
         self.headingLevelOffset = headingLevelOffset
+        self.imagePathSegment = imagePathSegment
+        self.linkPathSegment = linkPathSegment
     }
     func imageURLResolver() -> ((String) -> String?)? {
         let host = host
         let ref = ref
         let readmePath = readmePath
+        let segment = imagePathSegment
         return { source in
             resolveRepositoryAssetURL(
                 source,
                 owner: owner,
                 repositoryName: repositoryName,
                 ref: ref,
-                readmePath: readmePath
+                readmePath: readmePath,
+                pathSegment: segment
             )
         }
     }
         let host = host
         let ref = ref
         let readmePath = readmePath
+        let segment = linkPathSegment
         return { source in
             resolveRepositoryLinkURL(
                 source,
                 owner: owner,
                 repositoryName: repositoryName,
                 ref: ref,
-                readmePath: readmePath
+                readmePath: readmePath,
+                pathSegment: segment
             )
         }
     }

Tests/OrgSwiftTests/OrgRendererTests.swift +22

	@@ -477,4 +477,26 @@ struct OrgRendererTests {
477	#expect(!html.contains("sample"))	477	#expect(!html.contains("sample"))
478	#expect(html.contains("<p>Body.</p>"))	478	#expect(html.contains("<p>Body.</p>"))
479	}	479	}
		480
		481	@Test
		482	func relativeURLsResolveWithConfigurablePathSegments() {
		483	// gitbay serves raw bytes at /raw/<ref>/ and the file page at /blob/<ref>/, so an
		484	// image resolves against a different segment than a link.
		485	let options = OrgRenderOptions(
		486	host: "gitbay.org",
		487	owner: "krz",
		488	repositoryName: "gitbay",
		489	ref: "HEAD",
		490	readmePath: "README.org",
		491	imagePathSegment: "raw",
		492	linkPathSegment: "blob"
		493	)
		494	let html = render("""
		495	[[file:docs/logo.png]]
		496
		497	See [[docs/DESIGN.org][the design]].
		498	""", options: options)
		499	#expect(html.contains(#"<img src="https://gitbay.org/krz/gitbay/raw/HEAD/docs/logo.png""#))
		500	#expect(html.contains(#"<a href="https://gitbay.org/krz/gitbay/blob/HEAD/docs/DESIGN.org">the design</a>"#))
		501	}
480	}	502	}

Commit 72d3e10034

Commit `72d3e10034`