Ability to ignore specific code similar to @ts-ignore

[KamilDev]

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and discussions and couldn’t find anything (or linked relevant results below)

Problem

When using a templating language inside MDX, you will get the following error:

{% include "api-docs-table.liquid", apiDoc: "apiDocs.converter" %}

Could not parse expression with acornMDX (micromark-extension-mdx-expression:acorn)

Current solutions

I have not found any current way to ignore the error.

Proposed solutions

It would be great to be able to ignore expected errors, for example similar to @ts-ignore:

{ /* @mdx-ignore */ }
{% include "api-docs-table.liquid", apiDoc: "apiDocs.converter" %}

[remcohaszing]

Related:

• https://github.com/orgs/micromark/discussions/188
• Support loose (invalid) JavaScript mdx-js/mdx-analyzer#267
• Partial mode micromark-extension-mdx-jsx#10

[ChristianMurphy]

Welcome @KamilDev! 👋
Thanks for sharing your idea.

Remark/MDX has a way to support syntax extensions, including the one you describe, see https://github.com/micromark/micromark?tab=readme-ov-file#extending-markdown and https://github.com/micromark/micromark?tab=readme-ov-file#creating-a-micromark-extension (define what valid syntax is)

And has a way to disable lint rules https://github.com/remarkjs/remark-lint/tree/main?tab=readme-ov-file#ignore-warnings (check control flow and styling of valid syntax)

What you want is a loose mode (with a flag) for MDX, which fundamentally conflicts with the language goal.
MDX is Markdown + JSX, JSX is is JS + XML.
Neither JavaScript nor XML allow invalid syntax to exist within a document.

If you need a more forgiving parser.
Use markdown, there is no such thing as an invalid document in plain markdown.

There will not be a loose mode in core MDX.

---

To address your need which is implied through this.
You want to be able to import external documents.
MDX supports this, it is one of the core language features, imports https://mdxjs.com/docs/what-is-mdx/#esm
This means you can import and embed MDX document inside of others.

Additionally, when paired with a build tool/bundler it can import any file/document type that the build tool supports.
For example an external handlebars template with rollup as the build tool https://github.com/mixmaxhq/rollup-plugin-handlebars-plus

If you want to use MDX, use it, don't make up another language.