Sintaxe Markdown

Títulos

Use títulos para introduzir seções principais. Eles estruturam sua documentação e ajudam na navegação do conteúdo.

## Titles

Subtítulos

Use subtítulos para dividir seções ainda mais. Eles criam uma hierarquia de conteúdo mais detalhada para melhor legibilidade.

### Subtitles

Formatação de Texto

Este repositório suporta a maioria das opções de formatação Markdown.

Combine formatações para estilos de texto mais ricos e ênfase visual.

Links

Links conectam diferentes partes da documentação e recursos externos, essenciais para navegação e referências. Para criar um link, envolva o texto do link entre colchetes []().

[Exemplo de Link](https://exemplo.com)

Links internos

Para vincular dentro da documentação, use caminhos relativos à raiz como /primeiros-passos/introducao.

[Instalação](/primeiros-passos/instalacao)

Listas

Organize itens relacionados em um formato estruturado e legível. Markdown suporta listas não ordenadas, ordenadas e aninhadas para diversas necessidades de conteúdo.

Não ordenadas

Use listas não ordenadas para itens sem uma sequência específica. Comece cada item com o símbolo -.

- Sou um item da lista.
- Sou outro item da lista.
- Sou o último item da lista.

Ordenadas

Use listas ordenadas quando a ordem dos itens importa, como passos em um processo. Comece cada item com um número.

1. Sou um item da lista.
2. Sou outro item da lista.
3. Sou o último item da lista.

Aninhadas

Crie listas hierárquicas com sub-itens para estruturas complexas. Indente sub-itens por quatro espaços para aninhamento.

- Sou um item da lista.
  - Sou um item aninhado.
  - Sou outro item aninhado.
- Sou outro item da lista.

Tabelas

Apresente dados estruturados em linhas e colunas de forma clara. Tabelas são ideais para comparar dados ou listar propriedades.

| Prop    | Default   | Type                     |
|---------|-----------|--------------------------|
| `name`  |           | `string`{lang="ts-type"} |
| `size`  | `md`      | `string`{lang="ts-type"} |
| `color` | `neutral` | `string`{lang="ts-type"} |

Citações

Destaque citações importantes, referências ou texto enfatizado. Citações distinguem visualmente o conteúdo citado.

Linha única

Citações de linha única são melhores para citações curtas e impactantes que cabem em uma única linha. Para criar uma citação de linha única, adicione > na frente de um parágrafo. Ideal para citações curtas e impactantes.

> Este é um exemplo de citação curta que destaca informações importantes.

Múltiplas linhas

Citações de múltiplas linhas são adequadas para citações mais longas ou quando você precisa incluir múltiplos parágrafos em uma única citação.

> Este é um exemplo de citação de múltiplas linhas que pode conter
> informações importantes sobre o tópico em discussão.
>
> Citações ajudam a destacar conteúdo relevante e fornecer contexto adicional.