Retain forward slashes in HTML img src paths

Fixes #2807
r-lib · Nov 8, 2024 · 3bee460 · 3bee460
1 parent ffe60d5
commit 3bee460
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 1 deletion.
diff --git a/R/tweak-page.R b/R/tweak-page.R
@@ -51,7 +51,7 @@ tweak_rmarkdown_html <- function(html, input_path, pkg = list(bs_version = 3)) {
     img_src_real <- path_real(xml2::url_unescape(src[abs_src]))
     input_path_real <- path_real(xml2::url_unescape(input_path))
     img_rel_paths <- path_rel(path = img_src_real, start = input_path_real)
-    img_rel_paths <- xml2::url_escape(img_rel_paths)
+    img_rel_paths <- xml2::url_escape(img_rel_paths, reserved="/")
 
     purrr::walk2(
       .x = img_target_nodes,

diff --git a/tests/testthat/test-tweak-page.R b/tests/testthat/test-tweak-page.R
@@ -135,3 +135,36 @@ test_that("h1 section headings adjusted to h2 (and so on)", {
     c("page-header", "section level2", "section level3", "section level2")
   )
 })
+
+test_that("slashes not URL encoded during relative path conversion", {
+
+  # Since the URL conversion process in tweak_markdown_html() makes calls to
+  # fs::path_real() (which requires paths to exist), we create a
+  # temporary pkgdown site directory and populate it with an image file, which
+  # we can then reference in our test HTML file.
+
+  # Create a site
+  pkg <- local_pkgdown_site()
+
+  # Add the referenced image in a subdirectory of vignettes.
+  pkg <- pkg_add_kitten(pkg, "vignettes/img/")
+
+  # Get the full path to the image.
+  sim_path <- path_real(path(pkg$src_path, "vignettes/img/kitten.jpg"))
+
+  # Simulate an output HTML file referencing the absolute path.
+  html <- xml2::read_html(
+    sprintf('
+    <body>
+      <img src="%s" />
+    </body>
+    ', sim_path)
+  )
+
+  # Function should update the absolute path to a relative path.
+  tweak_rmarkdown_html(html, path(pkg$src_path, "vignettes"))
+
+  # Check that the relative path has a non-encoded slash.
+  expect_equal(xpath_attr(html, ".//img", "src"), "img/kitten.jpg")
+
+})