Um scaffolder que gera no seu repositório um site de documentação Astro editável, com Markdown legível por agentes e saída llms.txt incluídos.
mdx-js/mdx
MDX é um formato para escrever componentes JSX dentro de documentos Markdown, com compiladores para bundlers e React, Preact e Vue.
- Estrelas
- 19,852
- Forks
- 1,182
- Issues abertas
- 21
- Último commit
- há 22 horas
O que é?
Com MDX, você pode escrever JSX dentro de arquivos Markdown. É possível importar componentes como gráficos ou alertas e incorporá-los diretamente ao texto, o que é ideal para documentação e artigos longos que precisam de elementos interativos.
Este repositório reúne os pacotes que compilam MDX para JavaScript, além de integrações com bundlers como webpack e Rollup. Os frameworks compatíveis são React, Preact e Vue.
O projeto oferece um playground no site para testar o formato, que também inclui guias de introdução para adicionar MDX a um projeto existente.
Recursos principais
- 01Incorpore componentes JSX diretamente ao conteúdo Markdown.
- 02Importe e exporte valores JavaScript em documentos MDX.
- 03Compile MDX para JavaScript para usar com bundlers como webpack e Rollup.
- 04Integra-se com React, Preact e Vue.
Casos de uso
- Criar sites de documentação que combinam texto com componentes interativos.
- Escrever posts longos para blogs com gráficos ou alertas incorporados.
- Criar sites com muito conteúdo em React ou Vue, com páginas baseadas em componentes.
Início rápido
- 1
Leia o guia de introdução para integrar MDX ao seu projeto
- 2
Experimente o MDX no playground on-line
Em coleções
Tópicos
Perguntas frequentes
- O que é mdx?
- MDX é um formato para escrever componentes JSX dentro de documentos Markdown, com compiladores para bundlers e React, Preact e Vue. Com MDX, você pode escrever JSX dentro de arquivos Markdown. É possível importar componentes como gráficos ou alertas e incorporá-los diretamente ao texto, o que é ideal para documentação e artigos longos que precisam de elementos interativos.
- mdx é gratuito? Qual é a licença?
- mdx é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
- mdx ainda é mantido?
- Manutenção ativa. O último commit de mdx foi em 6 de nov. de 2026.
- Para que posso usar mdx?
- Criar sites de documentação que combinam texto com componentes interativos. Escrever posts longos para blogs com gráficos ou alertas incorporados. Criar sites com muito conteúdo em React ou Vue, com páginas baseadas em componentes.
- Como instalar mdx?
- Leia o guia de introdução para integrar MDX ao seu projeto Experimente o MDX no playground on-line
- Onde consigo mdx?
- O código-fonte e as instruções de instalação estão no GitHub: https://github.com/mdx-js/mdx
Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.
Projetos relacionados
Publica arquivos Markdown de qualquer branch pública do GitHub como site de documentação, com chat de IA, servidor MCP e llms.txt.
Um framework de documentação em TypeScript que cria sites a partir de Markdown/MDX e gera documentação de APIs com OpenAPI e GraphQL.
Um framework baseado em Next.js para criar sites de documentação e conteúdo a partir de arquivos MDX e Markdown.
Ferramenta TypeScript que transforma arquivos locais Markdown, MDX, JSON e YAML em coleções de dados com tipos seguros para aplicações web.
CMS visual para Markdown e MDX que envia o conteúdo diretamente para seu repositório no GitHub, sem precisar de banco de dados.