1
1
mirror of https://github.com/mdx-js/mdx.git synced 2024-07-04 18:16:27 +03:00
Markdown for the component era
Go to file
Karl Horky dfdcb502f5
Fix to recommend rehype-mdx-code-props
Closes Gh-2501.

Reviewed-by: Remco Haszing <remcohaszing@gmail.com>
Reviewed-by: Christian Murphy <christian.murphy.42@gmail.com>
Reviewed-by: Titus Wormer <tituswormer@gmail.com>
2024-06-30 11:15:55 +02:00
.github/workflows Update dev-dependencies 2024-02-05 10:20:12 +01:00
docs Fix to recommend rehype-mdx-code-props 2024-06-30 11:15:55 +02:00
packages Refactor to use TypeScript @import JSDoc tags 2024-06-26 12:35:50 +02:00
script node-loader: remove support for Node 14 2023-10-18 15:45:24 +02:00
website Refactor to use TypeScript @import JSDoc tags 2024-06-26 12:35:50 +02:00
.editorconfig Miscellaneous cleaning tasks (#1677) 2021-09-24 12:58:28 +02:00
.gitignore Add declaration maps 2024-02-12 11:43:32 +01:00
.prettierignore Remove examples from monorepo (#1681) 2021-09-26 17:39:27 +02:00
.vercelignore Miscellaneous cleaning tasks (#1721) 2021-10-07 08:55:27 +02:00
changelog.md Improve docs (#315) 2018-11-19 00:29:43 +01:00
license Miscellaneous cleaning tasks (#1677) 2021-09-24 12:58:28 +02:00
package-lock.json Update to TypeScript 5.5 2024-06-25 14:16:57 +02:00
package.json Update dev-dependencies 2024-06-17 11:45:22 +02:00
readme.md 3.0.0 2023-10-24 20:29:05 +02:00
renovate.json5 Refactor code-style 2023-10-18 14:38:06 +02:00
tsconfig.json Add declaration maps 2024-02-12 11:43:32 +01:00
vercel.json Refactor more docs 2023-10-24 14:04:51 +02:00

MDX

Markdown for the component era

Build Coverage Sponsors Backers Chat

MDX is an authorable format that lets you seamlessly write JSX in your markdown documents. You can import components, such as interactive charts or alerts, and embed them within your content. This makes writing long-form content with components a blast. 🚀

import {Chart} from './snowfall.js'
export const year = 2013

# Last years snowfall

In {year}, the snowfall was above average.
It was followed by a warm spring which caused
flood conditions in many of the nearby rivers.

<Chart year={year} color="#fcb32c" />

See § What is MDX for more info on the format. See § Playground to try it out.

What is this?

This GitHub repository contains several packages for compiling the MDX format to JavaScript, integrating with bundlers such as webpack and Rollup, and for using it with frameworks such as React, Preact, and Vue.

See § Getting started for how to integrate MDX into your project.

Security

See § Security on our site for information.

Contribute

See § Contribute on our site for ways to get started. See § Support for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

Sponsor

See § Sponsor on our site for how to help financially.

Vercel

Motif

HashiCorp

GitBook

Gatsby

Netlify

Coinbase

ThemeIsle

Expo

Boost Note

Markdown Space

Holloway


You?

License

MIT © Compositor and Vercel