What is this?
MDX is an authorable format that lets you seamlessly write JSX in your markdown documents — import components like interactive charts or alerts and embed them right in the content.
MDX is an authorable format that lets you seamlessly write JSX in your markdown documents — import components like interactive charts or alerts and embed them right in the content.So is MDX a file format, a library, or an app?A format plus a JavaScript toolchain: this repo holds several packages that compile MDX to JavaScript, so it goes into your project rather than running as a standalone app.
A format plus a JavaScript toolchain: this repo holds several packages that compile MDX to JavaScript, so it goes into your project rather than running as a standalone app.How do I get MDX into an existing project?Add the packages and hook the compiler into your bundler; the README points to the Getting started guide on mdxjs.com for instructions per setup.
Add the packages and hook the compiler into your bundler; the README points to the Getting started guide on mdxjs.com for instructions per setup.Which frameworks and bundlers does it support?It ships integrations for bundlers such as webpack and Rollup, and packages for using it with React, Preact, and Vue.
It ships integrations for bundlers such as webpack and Rollup, and packages for using it with React, Preact, and Vue.MDX embeds live code inside content files — any security catch?The README does not go into detail here; it defers security information to a dedicated section on the MDX website.
The README does not go into detail here; it defers security information to a dedicated section on the MDX website.Do I need to be a React developer to write it?No — the base is plain markdown, so writers keep their usual workflow; developers are the ones adding interactive components, and the project pitches long-form content with components as a blast.
No — the base is plain markdown, so writers keep their usual workflow; developers are the ones adding interactive components, and the project pitches long-form content with components as a blast.Can I try MDX without installing anything?Yes — the MDX website has a Playground where you can experiment with the format right in the browser before wiring it into a project.
Yes — the MDX website has a Playground where you can experiment with the format right in the browser before wiring it into a project.Is MDX a mature project or something new?Mature: the repository was created in December 2017, has about 19.8k stars, and the format is published under the MIT license by Compositor and Vercel.
Mature: the repository was created in December 2017, has about 19.8k stars, and the format is published under the MIT license by Compositor and Vercel.Which topics is it in?mdx, jsx, components, webpack, compiler, vue, documentation, markdown, web-development, react, npm, frontend
mdx, jsx, components, webpack, compiler, vue, documentation, markdown, web-development, react, npm, frontend