Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Notebook previews don't pick up options from a custom format extension

Offen
  • Stimmt etwas nicht?
#14,954 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
82/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
typescript
Bereich
cli

Rechercherichtung

Start in src/render/notebook/notebook-contributor-html.ts at renderHtmlNotebook and compare the preview render with the host and notebook renders. Reproduce the issue using the four-file project in the report, run quarto render, and check the three grep counts. Done means notebook-preview.html includes the custom format's from-myformat tag, matching the other pages.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

embed enhancement
I have
  • searched the issue tracker for similar issues
  • installed the latest version of Quarto CLI
  • formatted my issue following the Bug Reports guide
Bug description

When a page embeds a notebook cell with {{< embed >}}, Quarto also builds a preview page for that notebook.
I noticed that if the project uses a custom format from an extension, the preview doesn't get that format's options.
The host page and the notebook's own page get them just fine.
With the built-in html format, the preview gets the same options as the other pages, which is what I'd expect.

I'm not completely sure this isn't intended, but it does feel like a bug.

I think it comes from renderHtmlNotebook in src/render/notebook/notebook-contributor-html.ts.
It renders the preview with formats: ["html"] and only carries over the host format's theme, so the rest of a custom format's options are left behind.

I ran into this while moving the quarto.org theme into a local extension.
The notebook previews there lost the header and footer scripts that the site's format adds.

Steps to reproduce

Here's a small project with four files, and none of them need a computation engine.

_quarto.yml:

project:
  type: default

format: myformat-html

_extensions/myformat/_extension.yml:

title: My Format
author: Example
version: 1.0.0
contributes:
  formats:
    html:
      include-in-header:
        text: '<meta name="from-myformat" content="yes">'

index.qmd:

---
title: "Host page"
---

{{< embed notebook.ipynb#cell-hello >}}

notebook.ipynb:

{
 "cells": [
  {
   "cell_type": "raw",
   "metadata": {},
   "source": [
    "---\n",
    "title: Notebook\n",
    "---"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "c1",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "hello\n"
     ]
    }
   ],
   "source": [
    "#| label: cell-hello\n",
    "print(\"hello\")"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}

Then render it and look for the tag in each page:

quarto render
grep -c 'from-myformat' index.html notebook.html notebook-preview.html
Actual behavior

The tag from the custom format is missing from the preview:

index.html:1
notebook.html:1
notebook-preview.html:0
Expected behavior

I'd expect the preview to get the custom format's options, like the other two pages:

index.html:1
notebook.html:1
notebook-preview.html:1

That's exactly what happens with the built-in format.
If you swap format: myformat-html in _quarto.yml for the following, all three pages have the tag:

format:
  html:
    include-in-header:
      text: '<meta name="from-myformat" content="yes">'
Your environment
  • IDE: none, I ran quarto render from the terminal.
  • OS: macOS 27.0.
  • I also reproduced it with a development build of quarto-cli at 5757cfc88.
Quarto check output
Quarto 1.10.18

[✓] Checking environment information...
      Quarto cache location: /Users/mcanouil/Library/Caches/quarto

[✓] Checking versions of quarto binary dependencies...
      Pandoc version 3.10.0: OK
      Dart Sass version 1.101.0: OK
      Deno version 2.7.14: OK
      Typst version 0.15.1: OK

[✓] Checking versions of quarto dependencies......OK

[✓] Checking Quarto installation......OK
      Version: 1.10.18
      Path: ~/quarto-1.10.18/bin

[✓] Checking tools....................OK
      TinyTeX: v2026.07
      Chrome Headless Shell: (not installed)
      VeraPDF: (not installed)

[✓] Checking LaTeX....................OK
      Using: TinyTex
      Path: /Users/mcanouil/Library/TinyTeX/bin/universal-darwin
      Version: 2026

[✓] Checking Chrome Headless....................OK
      Using: Chrome from QUARTO_CHROMIUM
      Path: /Applications/Brave Browser.app/Contents/MacOS/Brave Browser

[✓] Checking basic markdown render....OK

ℹ R version 4.6.1 (2026-06-24)
! Config '~/.Rprofile' was loaded!

[✓] Checking R installation...........OK
      Version: 4.6.1
      Path: /Library/Frameworks/R.framework/Versions/4.6/Resources
      LibPaths:
        - /Users/mcanouil/Library/R/arm64/4.6/library
        - /Library/Frameworks/R.framework/Versions/4.6/Resources/library
      knitr: 1.51
      rmarkdown: 2.31

[✓] Checking Knitr engine render......OK

[✓] Checking Python 3 installation....OK
      Version: 3.9.6
      Path: /Library/Developer/CommandLineTools/usr/bin/python3
      Jupyter: (None)

      Jupyter is not available in this Python installation.
      Install with python3 -m pip install jupyter

[✓] Checking Julia installation...
Vorherrschende Sprache
JavaScript
Sterne
6.1k
Forks
476
Ø Merge
15 Std. 46 Min.
Gemergte PRs (30 T.)
110

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus quarto-dev/quarto-cli

Alle Issues in quarto-dev/quarto-cli

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.