Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenter 1.0 doesn't like interpolated markdown #2296

Open
tecosaur opened this issue Oct 8, 2023 · 1 comment
Open

Documenter 1.0 doesn't like interpolated markdown #2296

tecosaur opened this issue Oct 8, 2023 · 1 comment

Comments

@tecosaur
Copy link

tecosaur commented Oct 8, 2023

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

@mortenpi
Copy link
Member

mortenpi commented Oct 8, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants