pixeleate / mdx Goto Github PK

Markdown for the component era.

MDX is a format that lets you seamlessly use JSX in your Markdown documents. You can import components, like interactive charts or notifs, and export metadata. This makes writing long-form content with components a blast 🚀.

See it in action

import { Chart } from '../components/chart'

# Here's a chart

The chart is rendered inside our MDX document.

<Chart />

❤️ Powerful: MDX blends Markdown and JSX syntax to fit perfectly in React/JSX-based projects.

💻 Everything is a component: Use existing components inside your MDX and import other MDX files as plain components.

🔧 Customizable: Decide which component is rendered for each Markdown element ({ h1: MyHeading }).

📚 Markdown-based: The simplicity and elegance of Markdown remains, you interleave JSX only when you want to.

🔥 Blazingly blazing fast: MDX has no runtime, all compilation occurs during the build stage.

Watch some of these features in action

“It's extremely useful for using design system components to render markdown and weaving interactive components in with existing markdown.”

— @chrisbiscardi

Before MDX, some of the benefits of writing Markdown were lost when integrating with JSX. Implementations were often template string-based which required lots of escaping and cumbersome syntax.

MDX seeks to make writing with Markdown and JSX simpler while being more expressive. The possibilities are endless when you combine components (that can even be dynamic or load data) with the simplicity of Markdown for long-form content.

• Fast
• No runtime compilation
• Pluggable
• Element to React component mapping
• React component import/export
• Customizable layouts
• Webpack loader
• Parcel plugin
• Next.js plugin
• Gatsby plugin

npm init mdx

• Documentation
  • Syntax
  • Getting Started
  • Plugins
  • Contributing

See related projects in the MDX specification.

• John Otander (@4lpine) – Compositor + Clearbit
• Tim Neutkens (@timneutkens) – ZEIT
• Guillermo Rauch (@rauchg) – ZEIT
• Brent Jackson (@jxnblk) – Compositor

MIT license