Markdown com componentes no documento
O MDX é um formato que combina Markdown com JSX, sintaxe que permite representar elementos e componentes dentro do JavaScript. Você pode escrever títulos e parágrafos em Markdown e inserir um componente no ponto do documento que precisa de uma apresentação específica.
O formato também aceita expressões JavaScript e instruções de importação e exportação dos módulos ECMAScript (ESM). A integração do projeto compila esse conteúdo para JavaScript e usa as ferramentas de renderização configuradas para produzir a página. Um arquivo com extensão .mdx exige esse processamento para que os componentes sejam exibidos.
Uma expressão dentro do parágrafo
O trecho abaixo é o conteúdo de um arquivo MDX com uma expressão aritmética entre chaves:
# Resultado do cálculo
O total é {2 + 3}.Ao processar esse documento com uma integração MDX compatível, o título é renderizado como um heading e a expressão é avaliada. O valor 5 ocupa o lugar de {2 + 3} no parágrafo renderizado, porque as chaves delimitam a expressão JavaScript inserida no texto.
Uma expressão incorreta pode causar erro de compilação ou de execução. O texto entre chaves precisa ser JavaScript válido para aquele ponto do documento. Esse comportamento exige atenção ao migrar um Markdown que use chaves ou sinais de menor que como texto literal.
Componentes e interação no navegador
Um componente pode ser importado e usado com a sintaxe JSX dentro do documento. A integração precisa localizar o módulo e renderizar o componente com as ferramentas compatíveis. A importação identifica o código a usar, mas não define todas as condições de execução da página.
Um aviso visual pode ser renderizado como conteúdo estático. Um gráfico com controles exige o código responsável pela interação no navegador e a configuração correspondente do framework. Você precisa conferir a página produzida e testar esses controles, pois a compilação do documento não comprova que a interação funciona.
Dúvidas frequentes
Perguntas frequentes sobre MDX
- Um leitor comum de Markdown consegue processar MDX?
- A sintaxe adicional exige uma ferramenta que reconheça MDX. Um processador que aceita apenas Markdown pode rejeitar importações e expressões ou exibir parte delas como texto.
- O que significa importar um componente no documento?
- A importação torna um componente disponível para uso no MDX por meio dos módulos JavaScript. O caminho precisa ser resolvido pela integração e o componente precisa ser compatível com as ferramentas do projeto.
- Um componente em MDX torna a página interativa?
- A renderização pode produzir conteúdo estático. A interação depende do componente e da execução de JavaScript no navegador, conforme o framework e as opções de integração.
Para continuar
Recursos relacionados
Documentação
MDX: sintaxe e componentes no conteúdo
Apresenta a combinação de Markdown com JSX e explica expressões JavaScript e importações no documento.
Abrir recursoSite de referência
DevSide: desenvolvimento colaborativo
Sessão de Desenvolvimento Colaborativo para revisar um documento MDX e conferir os componentes renderizados na página.
Abrir recursoAplicação na formação
Vibe Coding: Do Zero ao MVP
A revisão de conteúdo em MDX inclui conferir a sintaxe do documento e o comportamento dos componentes usados na página.
Conhecer a formação
Fontes consultadas
Referências deste verbete
Este verbete ajudou você?
Obrigado pela resposta. Ela fica salva apenas neste navegador.