Repolode
Submit
mdx-js

mdx-js/mdx

MDX is a format for writing JSX components inside Markdown documents, with compilers for bundlers and React, Preact, and Vue.

View on GitHubWebsite
Stars
19,852
Forks
1,182
Open issues
21
Last commit
21 hours ago

What is it?

MDX lets you write JSX inside Markdown files. You can import components such as charts or alerts and embed them directly in prose, which suits long-form documentation and articles that need interactive pieces.

This repository contains the packages that compile MDX into JavaScript, along with integrations for bundlers such as webpack and Rollup. Framework support covers React, Preact, and Vue.

The project provides a playground on its website for trying the format, and its site includes getting-started guides for adding MDX to an existing project.

Key features

  • 01Embed JSX components directly inside Markdown content.
  • 02Import and export JavaScript values within MDX documents.
  • 03Compile MDX to JavaScript for use with bundlers such as webpack and Rollup.
  • 04Integrates with React, Preact, and Vue.

Use cases

  • Writing documentation sites that mix prose with interactive components.
  • Authoring long-form blog posts that embed charts or alerts.
  • Building content-heavy React or Vue sites with component-driven pages.

Quick start

  1. 1

    Read the getting started guide for integrating MDX into your project

  2. 2

    Try MDX in the online playground

In collections

Compilers, transpilers & programming languagesStatic site generators & documentation tools

Topics

#markdown#jsx#react#vue#documentation#static-site#compiler#mdx#remark#unified

FAQ

What is mdx?
MDX is a format for writing JSX components inside Markdown documents, with compilers for bundlers and React, Preact, and Vue. MDX lets you write JSX inside Markdown files. You can import components such as charts or alerts and embed them directly in prose, which suits long-form documentation and articles that need interactive pieces.
Is mdx free to use? What license does it have?
mdx is open source under the MIT license. Check the license terms before using it in commercial products.
Is mdx still maintained?
Actively maintained. The last commit to mdx was on Nov 6, 2026.
What can I use mdx for?
Writing documentation sites that mix prose with interactive components. Authoring long-form blog posts that embed charts or alerts. Building content-heavy React or Vue sites with component-driven pages.
How do I install mdx?
Read the getting started guide for integrating MDX into your project Try MDX in the online playground
Where can I get mdx?
The source code and installation instructions are on GitHub: https://github.com/mdx-js/mdx

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects