Home / Companies / ReadMe / Blog / Post Details
Content Deep Dive

Introducing MDX-ish

Blog post from ReadMe

Post Details
Company
Date Published
Author
Gregory Koberger
Word Count
2,218
Company Posts That Month
7
Language
English
Hacker News Points
-
Post removed?
No
Summary

ReadMe introduced MDX-ish, a permissive documentation format intended to combine Markdown’s ease of use and fault tolerance with MDX’s ability to embed JSX components and interactive UI. The change follows a difficult migration from Markdown to strict MDX, during which ReadMe converted roughly 23 million existing pages but found that only about 65% could be transformed automatically because old documents often contained malformed HTML or syntax incompatible with JSX. MDX-ish allows Markdown, HTML, and JSX to coexist within the same document or element, rendering loose HTML when possible while recognizing PascalCase components and JSX-style brace attributes as JSX. Built with a custom tokenizer on micromark and transformations compatible with the remark ecosystem, the system makes parsing decisions before constructing an abstract syntax tree and relies on later rendering layers to normalize mixed HTML- and JSX-like attributes. Although the approach can produce less predictable output than strict MDX and does not support inline JSX component definitions, ReadMe considers visual debugging more accessible than syntax errors and stack traces. MDX-ish is paired with a redesigned editor that supports both syntaxes without invalid-MDX save errors, and it is now the default for new projects, available through upgrades for existing users, and being rolled out to Enterprise customers.

Trends Found in this Post
Trend Post Mentions Total Month Mentions Posts Companies MoM
Real-time 1 7,339 1,892 285 -9%
Use This Data

Use this post, company, and trend context to find content marketing opportunities, perform competitive analysis, or address product feature gaps via the Plushcap MCP server or the Plushcap API.