Merge branch 'main' into fix/theorem-vertical-space

Author: cderv

.github/workflows/test-smokes.yml

@@ -78,6 +78,8 @@ jobs:
       - uses: ./.github/workflows/actions/quarto-dev
 
       - name: Install Tinytex
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
           quarto install tinytex
 

news/changelog-1.3.md

@@ -106,6 +106,7 @@
 - Replace default style for date picker component in OJS ([#2863](https://github.com/quarto-dev/quarto-cli/issues/2863)).
 - `quarto check` now supports `quarto check versions` for checking binary dependency versions in the case of custom binaries ([#3602](https://github.com/quarto-dev/quarto-cli/issues/3602)).
 - the API for shortcode handlers in lua now accepts a fourth parameter `raw_args` which hold the unparsed arguments in a table ([#3833](https://github.com/quarto-dev/quarto-cli/issues/3833)).
+- remove scaffolding div from conditional content in final output ([#3847](https://github.com/quarto-dev/quarto-cli/issues/3847)).
 
 ## Pandoc filter changes
 

src/config/constants.ts

@@ -40,6 +40,7 @@ export const kFormatResources = "format-resources";
 
 export const kFormatLinks = "format-links";
 export const kNotebookLinks = "notebook-links";
+export const kNotebookPreview = "notebook-preview";
 
 export const kKeepHidden = "keep-hidden";
 
@@ -168,6 +169,7 @@ export const kRenderDefaultsKeys = [
   kFormatResources,
   kFormatLinks,
   kNotebookLinks,
+  kNotebookPreview,
 ];
 
 // language fields

src/config/types.ts

@@ -131,6 +131,7 @@ import {
   kMergeIncludes,
   kMermaidFormat,
   kNotebookLinks,
+  kNotebookPreview,
   kNumberOffset,
   kNumberSections,
   kOutput,
@@ -403,6 +404,7 @@ export interface FormatRender {
   [kFormatResources]?: string[];
   [kFormatLinks]?: boolean | string[];
   [kNotebookLinks]?: boolean | "inline" | "global";
+  [kNotebookPreview]?: boolean;
 }
 
 export interface FormatExecute {

src/core/jupyter/jupyter-embed.ts

@@ -44,6 +44,8 @@ import {
 import { globalTempContext } from "../temp.ts";
 import { isAbsolute } from "path/mod.ts";
 import { partitionMarkdown } from "../pandoc/pandoc-partition.ts";
+import { safeExistsSync } from "../path.ts";
+import { basename } from "../../vendor/deno.land/[email protected]/path/win32.ts";
 
 export interface JupyterNotebookAddress {
   path: string;
@@ -173,18 +175,26 @@ export async function replaceNotebookPlaceholders(
       // Compute appropriate includes based upon the note
       // dependendencies
       const notebookIncludes = () => {
-        const notebook = jupyterFromFile(resolveNbPath(input, nbAddress.path));
-        const dependencies = isHtmlOutput(context.format.pandoc)
-          ? extractJupyterWidgetDependencies(notebook)
-          : undefined;
-        if (dependencies) {
-          const tempDir = globalTempContext().createDir();
-          return includesForJupyterWidgetDependencies(
-            [dependencies],
-            tempDir,
-          );
+        const nbPath = resolveNbPath(input, nbAddress.path);
+        if (safeExistsSync(nbPath)) {
+          const notebook = jupyterFromFile(nbPath);
+          const dependencies = isHtmlOutput(context.format.pandoc)
+            ? extractJupyterWidgetDependencies(notebook)
+            : undefined;
+          if (dependencies) {
+            const tempDir = globalTempContext().createDir();
+            return includesForJupyterWidgetDependencies(
+              [dependencies],
+              tempDir,
+            );
+          } else {
+            return undefined;
+          }
         } else {
-          return undefined;
+          const notebookName = basename(nbPath);
+          throw new Error(
+            `Unable to embed content from notebook '${notebookName}'\nThe file ${nbPath} doesn't exist or cannot be read.`,
+          );
         }
       };
       includes = notebookIncludes();

src/format/html/format-html-bootstrap.ts

@@ -5,7 +5,7 @@
 *
 */
 
-import { Document, Element, Node } from "../../core/deno-dom.ts";
+import { Document, Element } from "../../core/deno-dom.ts";
 import { join } from "path/mod.ts";
 
 import { renderEjs } from "../../core/ejs.ts";
@@ -20,12 +20,16 @@ import {
   kIncludeInHeader,
   kLinkCitations,
   kNotebookLinks,
+  kNotebookPreview,
+  kOutputFile,
   kQuartoTemplateParams,
   kRelatedFormatsTitle,
   kRelatedNotebooksTitle,
   kSectionDivs,
   kSourceNotebookPrefix,
   kTargetFormat,
+  kTemplate,
+  kTheme,
   kTocDepth,
   kTocLocation,
 } from "../../config/constants.ts";
@@ -82,6 +86,10 @@ import {
 } from "../../config/format.ts";
 import * as ld from "../../core/lodash.ts";
 import { basename } from "path/mod.ts";
+import { render, renderServices } from "../../command/render/render-shared.ts";
+import { info } from "log/mod.ts";
+import { dirname } from "../../vendor/deno.land/[email protected]/path/win32.ts";
+import { renderHtmlPreview } from "./format-html-embed.ts";
 
 export function formatPageLayout(format: Format) {
   return format.metadata[kPageLayout] as string || kPageLayoutArticle;
@@ -329,7 +337,7 @@ function bootstrapHtmlPostprocessor(
 
     // Look for included / embedded notebooks and include those
     if (format.render[kNotebookLinks] !== false) {
-      processNotebookEmbeds(doc, format, resources);
+      await processNotebookEmbeds(doc, format, resources);
     }
 
     // default treatment for computational tables
@@ -538,7 +546,7 @@ function processAlternateFormatLinks(
   }
 }
 
-function processNotebookEmbeds(
+async function processNotebookEmbeds(
   doc: Document,
   format: Format,
   resources: string[],
@@ -547,24 +555,43 @@ function processNotebookEmbeds(
     format.render[kNotebookLinks] === true;
   const global = format.render[kNotebookLinks] === "global" ||
     format.render[kNotebookLinks] === true;
+  const notebookPreview = format.render[kNotebookPreview] ?? true;
 
   const notebookDivNodes = doc.querySelectorAll("[data-notebook]");
   if (notebookDivNodes.length > 0) {
-    const nbPaths: { path: string; title: string; filename: string }[] = [];
+    const nbPaths: { path: string; title: string; filename?: string }[] = [];
     let count = 1;
-    notebookDivNodes.forEach((nbDivNode) => {
+    const services = renderServices();
+
+    for (const nbDivNode of notebookDivNodes) {
       const nbDivEl = nbDivNode as Element;
       nbDivEl.classList.add("quarto-notebook");
       const notebookPath = nbDivEl.getAttribute("data-notebook");
       if (notebookPath) {
         const title = nbDivEl.getAttribute("data-notebook-title");
+        const nbDir = dirname(notebookPath);
         const filename = basename(notebookPath);
 
-        const nbPath = {
-          path: notebookPath,
-          title: title || filename,
-          filename,
+        const notePreview = async () => {
+          if (notebookPreview) {
+            const htmlPreview = await renderHtmlPreview(
+              notebookPath,
+              format,
+              services,
+            );
+            return {
+              title: htmlPreview.title,
+              path: htmlPreview.path,
+            };
+          } else {
+            return {
+              path: join(nbDir, filename),
+              title: title || filename,
+              filename,
+            };
+          }
         };
+        const nbPath = await notePreview();
         nbPaths.push(nbPath);
 
         // Add a decoration to this div node
@@ -575,7 +602,9 @@ function processNotebookEmbeds(
           nbLinkEl.classList.add("quarto-notebook-link");
           nbLinkEl.setAttribute("id", `${id}`);
           nbLinkEl.setAttribute("href", nbPath.path);
-          nbLinkEl.setAttribute("download", nbPath.filename);
+          if (nbPath.filename) {
+            nbLinkEl.setAttribute("download", nbPath.filename);
+          }
           nbLinkEl.appendChild(
             doc.createTextNode(
               `${format.language[kSourceNotebookPrefix]}: ${nbPath.title}`,
@@ -597,7 +626,7 @@ function processNotebookEmbeds(
           }
         }
       }
-    });
+    }
 
     if (global) {
       const containerEl = doc.createElement("div");
@@ -618,7 +647,9 @@ function processNotebookEmbeds(
 
         const link = doc.createElement("a");
         link.setAttribute("href", nbPath.path);
-        link.setAttribute("download", nbPath.filename);
+        if (nbPath.filename) {
+          link.setAttribute("download", nbPath.filename);
+        }
 
         const icon = doc.createElement("i");
         icon.classList.add("bi");

src/format/html/format-html-embed.ts

@@ -0,0 +1,62 @@
+/*
+* format-html-embed.ts
+*
+* Copyright (C) 2020-2022 Posit Software, PBC
+*
+*/
+import { formatResourcePath } from "../../core/resources.ts";
+import { renderEjs } from "../../core/ejs.ts";
+
+import { kOutputFile, kTemplate, kTheme } from "../../config/constants.ts";
+import { Format } from "../../config/types.ts";
+
+import { RenderServices } from "../../command/render/types.ts";
+import { render } from "../../command/render/render-shared.ts";
+
+import { basename, dirname, join } from "path/mod.ts";
+
+export interface HtmlPreview {
+  title: string;
+  path: string;
+}
+
+export async function renderHtmlPreview(
+  path: string,
+  format: Format,
+  services: RenderServices,
+): Promise<HtmlPreview> {
+  const filename = basename(path);
+  const title = filename;
+
+  // Use the special `embed` template for this render
+  const embedHtmlEjs = formatResourcePath(
+    "html",
+    join("embed", "template.ejs.html"),
+  );
+  const embedTemplate = renderEjs(embedHtmlEjs, {
+    title,
+    path,
+    filename,
+  });
+  const templatePath = services.temp.createFile({ suffix: "html" });
+  Deno.writeTextFileSync(templatePath, embedTemplate);
+
+  // Rebder the notebook and update the path
+  const nbPreviewFile = `${filename}.html`;
+  await render(path, {
+    services,
+    flags: {
+      metadata: {
+        [kTheme]: format.metadata[kTheme],
+        [kOutputFile]: nbPreviewFile,
+        [kTemplate]: templatePath,
+      },
+      quiet: false,
+    },
+  });
+
+  return {
+    title,
+    path: join(dirname(path), nbPreviewFile),
+  };
+}

src/format/html/format-html-title.ts

@@ -88,7 +88,14 @@ export function documentTitleIncludeInHeader(
 
   if (variables.length > 0) {
     const styles = `<style>
-    .quarto-title-block .quarto-title-banner {
+    .quarto-title-block .quarto-title-banner,
+    .quarto-title-block .quarto-title-banner h1,
+    .quarto-title-block .quarto-title-banner h2,
+    .quarto-title-block .quarto-title-banner h3,
+    .quarto-title-block .quarto-title-banner h4,
+    .quarto-title-block .quarto-title-banner h5,
+    .quarto-title-block .quarto-title-banner h6
+    {
       ${variables.join("\n")}
     }
     </style>`;

src/format/html/format-html.ts

@@ -28,6 +28,7 @@ import {
   kLinkExternalIcon,
   kLinkExternalNewwindow,
   kNotebookLinks,
+  kNotebookPreview,
   kTheme,
 } from "../../config/constants.ts";
 
@@ -89,7 +90,6 @@ import {
 } from "../../core/giscus.ts";
 import { metadataPostProcessor } from "./format-html-meta.ts";
 import { kHtmlEmptyPostProcessResult } from "../../command/render/constants.ts";
-import { coerce } from "https://deno.land/x/[email protected]/mod.ts";
 
 export function htmlFormat(
   figwidth: number,
@@ -100,6 +100,7 @@ export function htmlFormat(
     {
       render: {
         [kNotebookLinks]: true,
+        [kNotebookPreview]: true,
         [kFormatLinks]: true,
       },
       resolveFormat: (format: Format) => {

src/format/reveal/format-reveal.ts

@@ -189,7 +189,6 @@ export function revealjsFormat() {
               figResponsive: false,
             }, // tippy options
             {
-              theme: "quarto-reveal",
               parent: "section.slide",
               config: {
                 offset: [0, 0],