mdx README

The project's README from github.com/mdx-js/mdx. As one markdown file: README.md.

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 year’s 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

mdx (mdx-js/mdx)

Searching Database…

19.8K ·GitHub
Что это такое?MDX — это формат, в котором можно прямо в markdown-документах писать JSX: импортировать компоненты вроде интерактивных графиков или предупреждений и вставлять их прямо в текст.
Так MDX — это формат файлов, библиотека или приложение?Формат плюс набор инструментов для JavaScript: в этом репозитории несколько пакетов, которые компилируют MDX в JavaScript, поэтому он встраивается в ваш проект, а не работает как отдельное приложение.
Как добавить MDX в существующий проект?Установите пакеты и подключите компилятор к своему сборщику; в README есть ссылка на руководство Getting started на mdxjs.com с инструкциями для разных настроек.
Какие фреймворки и сборщики он поддерживает?Есть интеграции для сборщиков вроде webpack и Rollup, а также пакеты для работы с React, Preact и Vue.
MDX вставляет живой код прямо в файлы с контентом — есть ли подводные камни с безопасностью?README не останавливается на этом подробно; информация о безопасности вынесена в отдельный раздел на сайте MDX.
Мне нужно быть React-разработчиком, чтобы писать на MDX?Нет — основа это обычный markdown, так что авторы сохраняют привычный рабочий процесс; интерактивные компоненты добавляют уже разработчики, а длинные материалы с компонентами, по замыслу проекта, получаются особенно интересными.
Можно попробовать MDX без установки чего-либо?Да — на сайте MDX есть Playground, где можно поэкспериментировать с форматом прямо в браузере, прежде чем встраивать его в проект.
MDX — это зрелый проект или что-то новое?Зрелый: репозиторий создан в декабре 2017 года, у него около 19.8k звёзд, а формат распространяется под лицензией MIT от Compositor и Vercel.
What are similar projects?mitosis, core, react-markdown, svgr, tamagui, tiptap, rspack, tsrx
Creator
mdx-js
Size
43.6 MB
Stars
19.8K
Age
8y
Commits · 90 Days