Documenter.jl icon indicating copy to clipboard operation
Documenter.jl copied to clipboard

Documenter 1.0 doesn't like interpolated markdown

Open tecosaur opened this issue 2 years ago • 2 comments

I have some docs pages that are generated from Markdown.MD values in my package. This is done via @eval blocks that worked fine pre- 1.0, but now I see messages like this:

┌ Warning: Unexpected Julia interpolation of type Markdown.MD in the Markdown.
│   value =
│      List the datasets in a certain collection
│    
│      By default, the datasets of the active collection are shown.
│    
│      Usage
│      -------
│    
│      data> list (lists dataset of the active collection)
│      data> list COLLECTION
└ @ Documenter.HTMLWriter ~/.julia/packages/Documenter/Meee1/src/html/HTMLWriter.jl:2215

And then I see unformatted results:

image

I'm currently working around this by doing ::Markdown.MD |> string |> Markdown.parse, but it's a bit annoying to do so.

Documenter version: 1.1.0

tecosaur avatar Oct 08 '23 07:10 tecosaur

Do you have a link or an MWE? It looks like what you end up with in the at-eval block is incorrect. It sounds like you have a Markdown.MD object within a Markdown.MD object?

Note: 1.0 is more strict with these things (both with interpolations and also at-eval block results), so it showing up in 1.0 is not unexpected.

mortenpi avatar Oct 08 '23 09:10 mortenpi

@tecosaur ping?

fingolfin avatar Oct 28 '25 22:10 fingolfin