Pages

Documentation is written in Markdown (via Remark) and MDX.

Read the quick reference

Markdown vs MDX

:pray: that MDX v2 fixes this.

MDX has its flaws. When rendering components, any text inside of them is treated as raw text (not markdown). To work around this you can use the `` tag, but it also has its issues. Generally speaking, put an empty line after the opening tag, and before the closing tag.

Copied
// don't do this as parsing will hit weird breakages
foo bar

Additional Topics

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").