Funcionalidades do 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.

important

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

Recursos padrões

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.

### My Doc Section
Hello world message with some **bold** text, some _italic_ text and a [link](/)
![img alt](/img/docusaurus.png)

My Doc Section

Hello world message with some bold text, some italic text and a link

Citações

Citações Markdown são um estilo maravilhoso:

> Isso é uma citação

Isto é uma citação

Detalhes

Markdown pode incorporar elementos HTML e detalhes dos HTML os elementos têm um estilo bonito:

### Details element example
<details>  <summary>Toggle me!</summary>  <div>    <div>This is the detailed content</div>    <details>      <summary>        <div>Nested toggle!</div>        <div>Some surprise inside...</div>      </summary>      <div>        😲😲😲😲😲      </div>    </details>  </div></details>

Details element example

Toggle me!

This is the detailed content

Nested toggle!

Some surprise inside...

😲😲😲😲😲

note

Na prática, esses não são realmente elementos HTML, mas elementos React JSX, que abordaremos a seguir!