Introdução aos Recursos Markdown

A documentação é uma das interfaces do seu produto com seus usuários. Um conjunto de documentos bem escrito e bem organizado ajuda os usuários a entender o seu produto rapidamente. Nosso objetivo alinhado aqui é ajudar seus usuários a encontrar e entender as informações de que precisam, o mais rapidamente possível.

O Docusaurus 2 usa ferramentas modernas para ajudá-lo a escrever suas documentações interativas com facilidade. Você pode incorporar componentes React, ou construir blocos de codificação ao vivo, onde seus usuários podem jogar com o código no local. Comece a compartilhar seus momentos de eureka com o código do qual seu público não pode fugir. É talvez a forma mais eficaz de atrair potenciais utilizadores.

Nessa seção, gostaríamos de apresentar-lhe as ferramentas que escolhemos e que acreditamos ajudarão você a construir uma documentação poderosa. Deixe-nos mostrar um exemplo.

Markdown é uma sintaxe que permite escrever conteúdo formatado em uma sintaxe legível.

A sintaxe Markdown padrão é compatível e usamos MDX como o mecanismo de análise, que pode fazer muito mais do que apenas analisar Markdown, como renderizar componentes React dentro de seus documentos.

important

Essa seção presume que você está usando os plugins oficiais de conteúdo do Docusaurus.