How can I prevent the alt text in markdown cell of a ipynb getting wrapped?

[jonathanalgar]

Description

Hello folks,

I'm trying to improve the alt texts for the images of an open-source project I follow. The PR: https://github.com/langchain-ai/langchain/pull/15357/files

The problem is for the ipynb the build (quarto preview docs) is breaking because the intermediate md files are getting wrapped. For example:

+ quarto preview docs --verbose
Preparing to preview

[1/1] docs/guides/local_llms.ipynb
[INFO] Loaded /opt/quarto/share/pandoc/templates/default.markdown from /opt/quarto/share/pandoc/templates/default.markdown
[INFO] Running filter /opt/quarto/share/filters/main.lua
[INFO] Completed filter /opt/quarto/share/filters/main.lua in 331 ms

Creates an intermediate md:

...
![Graphical representation of open-source LLMs assessed by base model
and fine-tuning approach.](../../static/img/OSS_LLM_overview.png)
...

Which breaks the Docusaurus HTML build:

SyntaxError: /home/ja/langchain-2/_dist/docs/guides/local_llms.md: Unterminated string constant. (42:13)
  40 | was used?`}</li>
  41 | </ol>
> 42 | <p><img alt={"Graphical representation of open-source LLMs assessed by base model
     |              ^
  43 | and fine-tuning approach."}...

Do you have any suggestions on what I could do myself in the ipynb file or a minimal change I could ask the maintainers to do to fix?

Many thanks 😊

[mcanouil]

Could you share a small and simple self-contained "working" (reproducible) example to work with, i.e., a complete Quarto document or a Git repository? Thanks.
There are too many files and it's an ongoing PR.

[cderv]

EDIT: the issue here seems to be that it's a custom rendered that does not take into account wrap.

You mean docusaurus-md not respecting --wrap ? This is what I think too and is highly possibly.

Ideally I'd like to get the alt texts working without having to propose upgrading docusaurus.

You should definitely follow advice and try Quarto 1.4 pre-release with your docusaurus version. I think we are using <figure> tag in 1.4.

Can you try that ?

Otherwise other workaround will require Lua filter override or writing raw docusuarus in your input

[jonathanalgar]

Yes, thanks, moving to Quarto v1.4.534 fixes the issue with the wrapping by using <figure> tag. And across the entire repo the render to docusaurus-md with the new version fails with just with one file:

rockset.ipynb:

Error running filter /opt/quarto/share/filters/main.lua:
...are/extensions/quarto/docusaurus/docusaurus_citeproc.lua:8: attempt to index a nil value (field 'integer index')
stack traceback:
        [C]: in ?
        [C]: in method 'walk'
        ...are/extensions/quarto/docusaurus/docusaurus_citeproc.lua:4: in function <...are/extensions/quarto/docusaurus/docusaurus_citeproc.lua:1>
        [C]: in ?
        [C]: in method 'walk'
        /opt/quarto/share/filters/main.lua:224: in local 'checked_walk'
        /opt/quarto/share/filters/main.lua:276: in function 'run_emulated_filter'
        /opt/quarto/share/filters/main.lua:936: in local 'callback'
        [string "..."]:1888: in field 'withScriptFile'
        /opt/quarto/share/filters/main.lua:949: in upvalue 'run_emulated_filter_chain'
        /opt/quarto/share/filters/main.lua:987: in function </opt/quarto/share/filters/main.lua:984>
stack traceback:
        ...are/extensions/quarto/docusaurus/docusaurus_citeproc.lua:4: in function <...are/extensions/quarto/docusaurus/docusaurus_citeproc.lua:1>
        [C]: in ?
        [C]: in method 'walk'
        /opt/quarto/share/filters/main.lua:224: in local 'checked_walk'
        /opt/quarto/share/filters/main.lua:276: in function 'run_emulated_filter'
        /opt/quarto/share/filters/main.lua:936: in local 'callback'
        [string "..."]:1888: in field 'withScriptFile'
        /opt/quarto/share/filters/main.lua:949: in upvalue 'run_emulated_filter_chain'
        /opt/quarto/share/filters/main.lua:987: in function </opt/quarto/share/filters/main.lua:984>
stack traceback:
        /opt/quarto/share/filters/main.lua:224: in local 'checked_walk'
        /opt/quarto/share/filters/main.lua:276: in function 'run_emulated_filter'
        /opt/quarto/share/filters/main.lua:936: in local 'callback'
        [string "..."]:1888: in field 'withScriptFile'
        /opt/quarto/share/filters/main.lua:949: in upvalue 'run_emulated_filter_chain'
        /opt/quarto/share/filters/main.lua:987: in function </opt/quarto/share/filters/main.lua:984>

Resolved by fixing the formatting error:
https://github.com/jonathanalgar/langchain/blob/master/docs/docs/integrations/vectorstores/rockset.ipynb?short_path=8a0406f#L20
—is this a bug or the expected behavior?

Though quickly ran into a problem when testing on the docusaurus server (2.4.3) for local_llms.ipynb.. the image doesn't render:

local_llms.mdx:

...
<figure>
<img src="../../static/img/OSS_LLM_overview.png"
alt="Graphical representation of open-source LLMs assessed by base model and fine-tuning approach." />
<figcaption aria-hidden="true">Graphical representation of open-source
LLMs assessed by base model and fine-tuning approach.</figcaption>
</figure>
...

[cderv]

Resolved by fixing the formatting error:
jonathanalgar/langchain@master/docs/docs/integrations/vectorstores/rockset.ipynb?short_path=8a0406f#L20
—is this a bug or the expected behavior?

It seems indeed empty link are creating an issue...

---
title: test
format: docusaurus-md
---

[ ](https://python.langchain.com/docs/modules/data_connection/vectorstores/integrations/rockset#setting-up-environment)

Error

Error running filter C:\Users\chris\DOCUME~1\DEV_R\QUARTO~2\src\resources\filters\main.lua:
...ces\extensions\quarto\docusaurus\docusaurus_citeproc.lua:8: attempt to index a nil value (field 'integer index')
stack traceback:
	[C]: in ?
	[C]: in method 'walk'
	...ces\extensions\quarto\docusaurus\docusaurus_citeproc.lua:4: in function <...ces\extensions\quarto\docusaurus\docusaurus_citeproc.lua:1>
	[C]: in ?
	[C]: in method 'walk'
	...V_R\QUARTO~2\src\resources\filters\./ast/customnodes.lua:86: in local 'checked_walk'
	...V_R\QUARTO~2\src\resources\filters\./ast/customnodes.lua:138: in function 'run_emulated_filter'
	..._R\QUARTO~2\src\resources\filters\./ast/runemulation.lua:82: in local 'callback'
	[string "..."]:1888: in field 'withScriptFile'
	..._R\QUARTO~2\src\resources\filters\./ast/runemulation.lua:95: in upvalue 'run_emulated_filter_chain'
	..._R\QUARTO~2\src\resources\filters\./ast/runemulation.lua:133: in function <..._R\QUARTO~2\src\resources\filters\./ast/runemulation.lua:130>
stack traceback:
	...ces\extensions\quarto\docusaurus\docusaurus_citeproc.lua:4: in function <...ces\extensions\quarto\docusaurus\docusaurus_citeproc.lua:1>
	[C]: in ?
	[C]: in method 'walk'
	...V_R\QUARTO~2\src\resources\filters\./ast/customnodes.lua:86: in local 'checked_walk'
	...V_R\QUARTO~2\src\resources\filters\./ast/customnodes.lua:138: in function 'run_emulated_filter'
	..._R\QUARTO~2\src\resources\filters\./ast/runemulation.lua:82: in local 'callback'
	[string "..."]:1888: in field 'withScriptFile'
	..._R\QUARTO~2\src\resources\filters\./ast/runemulation.lua:95: in upvalue 'run_emulated_filter_chain'
	..._R\QUARTO~2\src\resources\filters\./ast/runemulation.lua:133: in function <..._R\QUARTO~2\src\resources\filters\./ast/runemulation.lua:130>
stack traceback:
	...V_R\QUARTO~2\src\resources\filters\./ast/customnodes.lua:86: in local 'checked_walk'
	...V_R\QUARTO~2\src\resources\filters\./ast/customnodes.lua:138: in function 'run_emulated_filter'
	..._R\QUARTO~2\src\resources\filters\./ast/runemulation.lua:82: in local 'callback'
	[string "..."]:1888: in field 'withScriptFile'
	..._R\QUARTO~2\src\resources\filters\./ast/runemulation.lua:95: in upvalue 'run_emulated_filter_chain'
	..._R\QUARTO~2\src\resources\filters\./ast/runemulation.lua:133: in function <..._R\QUARTO~2\src\resources\filters\./ast/runemulation.lua:130>
ERROR: Error
    at renderFiles (file:///C:/Users/chris/DOCUME~1/DEV_R/QUARTO~2/src/command/render/render-files.ts:346:23)
    at eventLoopTick (ext:core/01_core.js:183:11)
    at async renderProject (file:///C:/Users/chris/DOCUME~1/DEV_R/QUARTO~2/src/command/render/project.ts:268:23)
    at async renderForPreview (file:///C:/Users/chris/DOCUME~1/DEV_R/QUARTO~2/src/command/preview/preview.ts:419:24)
    at async render (file:///C:/Users/chris/DOCUME~1/DEV_R/QUARTO~2/src/command/preview/preview.ts:165:22)
    at async preview (file:///C:/Users/chris/DOCUME~1/DEV_R/QUARTO~2/src/command/preview/preview.ts:182:18)
    at async Command.fn (file:///C:/Users/chris/DOCUME~1/DEV_R/QUARTO~2/src/command/preview/cmd.ts:415:7)
    at async Command.execute (file:///C:/Users/chris/DOCUME~1/DEV_R/QUARTO~2/src/vendor/deno.land/x/[email protected]/command/command.ts:1790:7)
    at async quarto (file:///C:/Users/chris/DOCUME~1/DEV_R/QUARTO~2/src/quarto.ts:155:3)
    at async file:///C:/Users/chris/DOCUME~1/DEV_R/QUARTO~2/src/quarto.ts:186:5

It should not create this type of Lua error, though empty link syntax is uncommon...

What is the expected output to add a link to empty string ?

[cderv]

I fix it in #8159 by the way, but still unsure what is the expected output in your case.

[jonathanalgar]

I fix it in #8159 by the way, but still unsure what is the expected output in your case.

Correct, it is an error in the content that I will propose a correction for. I just wanted to point out the error being thrown.

With regards to the images not rendering correctly for the <figure> tag on the docusaurus 2.4.3, this makes me think there is a backwards compatibility issue and I should wait to update the alt texts on the ipynb until the docusaurus for the project is updated to v3.