Merge pull request #12502 from quarto-dev/bugfix/11948

epub - do not use css that amazon doesn't like

Author: cscheid

src/resources/formats/epub/styles.html

@@ -1,5 +1,4 @@
 <style type="text/css">
-  
   /* Figure formatting */
   .quarto-layout-panel>figure>figcaption,
   .quarto-layout-panel>.panel-caption {
@@ -37,10 +36,6 @@
     margin: 0.2em;
   }
 
-  .quarto-layout-cell img {
-    max-width: 100%;
-  }
-
   .quarto-layout-cell .html-widget {
     width: 100% !important;
   }
@@ -110,7 +105,6 @@
   }
 
   .quarto-cover-image {
-    max-width: 35%;
     float: right;
     margin-left: 30px;
   }

tests/docs/smoke-all/2025/04/09/issue-11948.qmd

@@ -0,0 +1,17 @@
+---
+format: epub
+_quarto:
+  tests:
+    epub:
+      ensureEpubFileRegexMatches:
+        - path: EPUB/nav.xhtml
+          regexes:
+            - []
+            - ["max-width", "max-height"]
+---
+
+## Hello
+
+Amazon epub doesn't allow some CSS attributes, so we remove them from the epub-specific styles we produce.
+
+See https://kdp.amazon.com/en_US/help/topic/GG5R7N649LECKP7U#css_support

tests/smoke/smoke-all.test.ts

@@ -16,6 +16,7 @@ import { breakQuartoMd } from "../../src/core/lib/break-quarto-md.ts";
 import { parse } from "../../src/core/yaml.ts";
 import { cleanoutput } from "./render/render.ts";
 import {
+  ensureEpubFileRegexMatches,
   ensureDocxRegexMatches,
   ensureDocxXpath,
   ensureFileRegexMatches,
@@ -125,6 +126,7 @@ function resolveTestSpecs(
   const result = [];
   // deno-lint-ignore no-explicit-any
   const verifyMap: Record<string, any> = {
+    ensureEpubFileRegexMatches,
     ensureHtmlElements,
     ensureHtmlElementContents,
     ensureFileRegexMatches,
@@ -202,6 +204,10 @@ function resolveTestSpecs(
             }
           } else if (key === "printsMessage") {
             verifyFns.push(verifyMap[key](value));
+          } else if (key === "ensureEpubFileRegexMatches") {
+            // this ensure function is special because it takes an array of path + regex specifiers,
+            // so we should never use the spread operator
+            verifyFns.push(verifyMap[key](outputFile.outputPath, value));
           } else if (verifyMap[key]) {
             // FIXME: We should find another way that having this requirement of keep-* in the metadata
             if (key === "ensureTypstFileRegexMatches") {

tests/verify.ts

@@ -44,6 +44,26 @@ export const withDocxContent = async <T>(
   }
 };
 
+export const withEpubDirectory = async <T>(
+  file: string,
+  k: (path: string) => Promise<T>
+) => {
+  const [_dir, stem] = dirAndStem(file);
+  const temp = await Deno.makeTempDir();
+  try {
+    // Move the docx to a temp dir and unzip it
+    const zipFile = join(temp, stem + ".zip");
+    await Deno.copyFile(file, zipFile);
+    await unzip(zipFile);
+
+    // Open the core xml document and match the matches
+    const result = await k(temp);
+    return result;
+  } finally {
+    await Deno.remove(temp, { recursive: true });
+  }
+};
+
 export const withPptxContent = async <T>(
   file: string,
   slideNumber: number,
@@ -569,6 +589,18 @@ export const verifyDocXDocument = (
   });
 };
 
+export const verifyEpubDocument = (
+  callback: (path: string) => Promise<void>,
+  name?: string,
+): (file: string) => Verify => {
+  return (file: string) => ({
+    name: name ?? "Inspecting Epub",
+    verify: async (_output: ExecuteOutput[]) => {
+      return await withEpubDirectory(file, callback);
+    },
+  });
+}
+
 export const verifyPptxDocument = (
   callback: (doc: string, docFile: string) => Promise<void>,
   name?: string,
@@ -730,6 +762,52 @@ export const ensureDocxRegexMatches = (
   }, "Inspecting Docx for Regex matches")(file);
 };
 
+export const ensureEpubFileRegexMatches = (
+  epubFile: string,
+  pathsAndRegexes: {
+    path: string;
+    regexes: (string | RegExp)[][];
+  }[]
+): Verify => {
+  return verifyEpubDocument(async (epubDir) => {
+    for (const { path, regexes } of pathsAndRegexes) {
+      const file = join(epubDir, path);
+      assert(
+        existsSync(file),
+        `File ${file} doesn't exist in Epub`,
+      );
+      const content = await Deno.readTextFile(file);
+      const mustMatch: (RegExp | string)[] = [];
+      const mustNotMatch: (RegExp | string)[] = [];
+      if (regexes.length) {
+        mustMatch.push(...regexes[0]);
+      }
+      if (regexes.length > 1) {
+        mustNotMatch.push(...regexes[1]);
+      }
+
+      mustMatch.forEach((regex) => {
+        if (typeof regex === "string") {
+          regex = new RegExp(regex);
+        }
+        assert(
+          regex.test(content),
+          `Required match ${String(regex)} is missing from file ${file}.`,
+        );
+      });
+      mustNotMatch.forEach((regex) => {
+        if (typeof regex === "string") {
+          regex = new RegExp(regex);
+        }
+        assert(
+          !regex.test(content),
+          `Illegal match ${String(regex)} was found in file ${file}.`,
+        );
+      });
+    }
+  }, "Inspecting Epub for Regex matches")(epubFile);
+}
+
 // export const ensureDocxRegexMatches = (
 //   file: string,
 //   regexes: (string | RegExp)[],