Fix #260, work around inconsistent treatment of math syntax between typst and texoutput formats (#262)

Author: MichaelHatherly

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Fixed
+
+- Fix missing display maths output in Typst. Works around inconsistency in handling of markdown math syntax between Quarto output formats [#262]
+
 ## [v0.13.1] - 2025-02-18
 
 ### Fixed
@@ -378,3 +382,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#253]: https://github.com/PumasAI/QuartoNotebookRunner.jl/issues/253
 [#255]: https://github.com/PumasAI/QuartoNotebookRunner.jl/issues/255
 [#257]: https://github.com/PumasAI/QuartoNotebookRunner.jl/issues/257
+[#262]: https://github.com/PumasAI/QuartoNotebookRunner.jl/issues/262

src/QuartoNotebookWorker/ext/QuartoNotebookWorkerLaTeXStringsExt.jl

@@ -9,7 +9,19 @@ struct LaTeXStringWrapper <: QNW.WrapperType
     value::LS.LaTeXString
 end
 
-Base.show(io::IO, ::MIME"text/markdown", s::LaTeXStringWrapper) = print(io, s.value)
+function Base.show(io::IO, ::MIME"text/markdown", s::LaTeXStringWrapper)
+    qnr = get(io, :QuartoNotebookRunner, nothing)
+    isnothing(qnr) && error("No QuartoNotebookRunner found in IO context")
+    to_format = QNW.rget(qnr.options, ("format", "pandoc", "to"), nothing)
+    # Workaround for some weirdness in the treatment of rendering for math in
+    # typst output which fails to render display maths if it doesn't have to
+    # correct leading and trailing dollars. PDF(tex) output requires that
+    # `\begin` blocks don't have `$$` wrappers, but typst requires them.
+    wrap = to_format == "typst" && !qnr.inline && !startswith(s.value, "\$")
+    wrap && print(io, "\$\$")
+    show(io, MIME("text/latex"), s.value)
+    wrap && print(io, "\$\$")
+end
 Base.showable(::MIME"text/markdown", ::LaTeXStringWrapper) = true
 
 end

src/QuartoNotebookWorker/src/render.jl

@@ -261,11 +261,11 @@ function io_capture(f; cell_options, kws...)
 end
 
 # passing our module removes Main.Notebook noise when printing types etc.
-function with_context(io::IO, cell_options = Dict{String,Any}())
-    return IOContext(io, _io_context(cell_options)...)
+function with_context(io::IO, cell_options = Dict{String,Any}(), inline = false)
+    return IOContext(io, _io_context(cell_options, inline)...)
 end
 
-function _io_context(cell_options = Dict{String,Any}())
+function _io_context(cell_options = Dict{String,Any}(), inline = false)
     return [
         :module => NotebookState.notebook_module(),
         :limit => true,
@@ -279,7 +279,8 @@ function _io_context(cell_options = Dict{String,Any}())
         #
         # TODO: perhaps preprocess the metadata provided here rather
         # than just passing it through as-is.
-        :QuartoNotebookRunner => (; cell_options, options = NotebookState.OPTIONS[]),
+        :QuartoNotebookRunner =>
+            (; cell_options, options = NotebookState.OPTIONS[], inline),
     ]
 end
 
@@ -394,12 +395,12 @@ function render_mimetypes(
             try
                 if inline && mime == "text/plain"
                     Base.@invokelatest __print_barrier__(
-                        with_context(buffer, cell_options),
+                        with_context(buffer, cell_options, inline),
                         value,
                     )
                 else
                     Base.@invokelatest __show_barrier__(
-                        with_context(buffer, cell_options),
+                        with_context(buffer, cell_options, inline),
                         mime,
                         value,
                     )

test/testsets/mimetypes.jl

@@ -29,5 +29,20 @@ test_example(joinpath(@__DIR__, "../examples/mimetypes.qmd")) do json
     cell = cells[14]
     @test !isempty(cell["outputs"][1]["data"]["text/plain"])
     @test !isempty(cell["outputs"][1]["data"]["text/latex"])
-    @test !isempty(cell["outputs"][1]["data"]["text/markdown"])
+
+    md = cell["outputs"][1]["data"]["text/markdown"]
+    @test !isempty(md)
+    @test !startswith(md, "\$\$")
+    @test !endswith(md, "\$\$")
+end
+
+test_example(joinpath(@__DIR__, "../examples/mimetypes.qmd"), to_format("typst")) do json
+    cells = json["cells"]
+
+    cell = cells[14]
+    @test !isempty(cell["outputs"][1]["data"]["text/plain"])
+    @test !isempty(cell["outputs"][1]["data"]["text/latex"])
+    md = cell["outputs"][1]["data"]["text/markdown"]
+    @test startswith(md, "\$\$")
+    @test endswith(md, "\$\$")
 end

test/utilities/prelude.jl

@@ -12,14 +12,24 @@ if !@isdefined(SCHEMA)
         open(JSON3.read, joinpath(@__DIR__, "../schema/nbformat.v4.schema.json")),
     )
 
-    function test_example(f, each)
+    function test_example(f, each, options = Dict{String,Any}())
         examples = joinpath(@__DIR__, "../examples")
         name = relpath(each, pwd())
-        @info "Testing $name"
+        if isempty(options)
+            @info "Testing $name"
+        else
+            @info "Testing $name (extra options)" options
+        end
         @testset "$(name)" begin
             server = QuartoNotebookRunner.Server()
             buffer = IOBuffer()
-            QuartoNotebookRunner.run!(server, each; output = buffer, showprogress = false)
+            QuartoNotebookRunner.run!(
+                server,
+                each;
+                options = options,
+                output = buffer,
+                showprogress = false,
+            )
             seekstart(buffer)
             json = JSON3.read(buffer, Any)
 
@@ -70,4 +80,5 @@ if !@isdefined(SCHEMA)
         end
         GC.gc()
     end
+    to_format(format) = Dict{String,Any}("format" => Dict("pandoc" => Dict("to" => format)))
 end