Markdown

Como escrever documentos em Markdown

Introdução

O projeto aceita Markdown no padrão GFM, que inclui títulos, listas, tabelas, links, citações e blocos de código.

# Título

Um parágrafo com **negrito** e [um link](https://example.com).

- Primeiro item
- Segundo item

```ts
const mensagem = "Olá";
```

Boas práticas

  • Use uma hierarquia de títulos consistente
  • Escreva textos curtos e objetivos
  • Informe a linguagem dos blocos de código
  • Use texto descritivo nos links
  • Adicione texto alternativo às imagens

Para componentes interativos, consulte a página sobre MDX.

Nesta página