Repolode
Предложить
mdx-js

mdx-js/mdx

MDX — формат для встраивания компонентов JSX в Markdown-документы; доступны компиляторы для сборщиков и React, Preact и Vue.

Открыть на GitHubСайт
Звёзды
19,852
Форки
1,182
Открытые issues
21
Последний коммит
18 часов назад

Что это?

MDX позволяет писать JSX внутри Markdown-файлов. Можно импортировать такие компоненты, как диаграммы или уведомления, и встраивать их прямо в текст — это удобно для подробной документации и статей с интерактивными элементами.

В репозитории собраны пакеты, которые компилируют MDX в JavaScript, а также интеграции со сборщиками, такими как webpack и Rollup. Поддерживаются React, Preact и Vue.

На сайте проекта есть playground, где можно попробовать формат, а также руководства для начала работы, которые помогут добавить MDX в существующий проект.

Ключевые возможности

  • 01Встраивание компонентов JSX прямо в Markdown-контент.
  • 02Импорт и экспорт значений JavaScript в MDX-документах.
  • 03Компиляция MDX в JavaScript для использования со сборщиками, такими как webpack и Rollup.
  • 04Интеграция с React, Preact и Vue.

Сценарии использования

  • Создание сайтов с документацией, где обычный текст сочетается с интерактивными компонентами.
  • Написание подробных публикаций в блог с диаграммами или уведомлениями.
  • Создание контентных сайтов на React или Vue со страницами на основе компонентов.

Быстрый старт

  1. 1

    Прочитайте руководство по началу работы с интеграцией MDX в проект

  2. 2

    Попробуйте MDX в онлайн-песочнице

В подборках

Компиляторы, транспайлеры и языки программированияГенераторы статических сайтов и инструменты для документации

Темы

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

Частые вопросы

Что такое mdx?
MDX — формат для встраивания компонентов JSX в Markdown-документы; доступны компиляторы для сборщиков и React, Preact и Vue. MDX позволяет писать JSX внутри Markdown-файлов. Можно импортировать такие компоненты, как диаграммы или уведомления, и встраивать их прямо в текст — это удобно для подробной документации и статей с интерактивными элементами.
mdx можно использовать бесплатно? Какая у него лицензия?
mdx распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
mdx всё ещё поддерживается?
Активно поддерживается. Последний коммит в mdx — 6 нояб. 2026 г..
Для чего можно использовать mdx?
Создание сайтов с документацией, где обычный текст сочетается с интерактивными компонентами. Написание подробных публикаций в блог с диаграммами или уведомлениями. Создание контентных сайтов на React или Vue со страницами на основе компонентов.
Как установить mdx?
Прочитайте руководство по началу работы с интеграцией MDX в проект Попробуйте MDX в онлайн-песочнице
Где скачать mdx?
Исходный код и инструкции по установке — на GitHub: https://github.com/mdx-js/mdx

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты