Curly braces in code blocks are not escaped and raise an error

[zhouzi]

Due to Docusaurus interpreting .md files as MDX, curly braces are troublesome. They're currently escaped in description and inline code, through #10

The issue with code blocks is that the current Markdown parser (marked) escapes the content of code blocks. In the below example:

{ example }

If we turn that into:

{ example }

The parser would then turn that into:

{ example }

As a side note, this issue is tracked through facebook/docusaurus#3018 from docusaurus' side.

[Braunson]

I just ran through this issue again. I had another error url is not defined which ended up being due to this line that contains { url }

<blockquote>Deprecated: Query media { url } instead</blockquote>

And in the GraphQL Schema

"Type of content"
type Content {
    "The ID for the Content"
    id: ID!
    
    "Media for the Content"
    mediaUrl: String @rename(attribute: "media_url") @deprecated(reason: "Query media { url } instead")
}

While I can remove that from the GraphQL schema, I wonder if there's a way to escape or ignore it in Docusaurus when building or rather when building the GraphQL docs themselves (via the plugin)?

Possible solution:

• Convert any curly braces to entities { and }? Though they don't render properly in markdown and just end up as text.

[zhouzi]

Thanks for reporting @Braunson 👍 This one should be easy to fix as we can safely escape curly braces there. I just created #17 to look into it.

[zhouzi]

Docusaurus pushed an update so Markdown files are not interpreted by MDX which solves this issue and others: facebook/docusaurus#3018 (comment)