Cabeçalhos e texto

Aprenda a formatar textos, criar cabeçalhos e estilizar conteúdos

Cabeçalhos

Cabeçalhos organizam seu conteúdo e criam âncoras de navegação. Eles aparecem no índice e ajudam os usuários a percorrer sua documentação.

Criando cabeçalhos

Use os símbolos # para criar cabeçalhos de diferentes níveis:

## Cabeçalho da seção principal
### Cabeçalho da subseção
#### Cabeçalho da sub-subseção

Use cabeçalhos descritivos e ricos em palavras-chave que indiquem claramente o conteúdo a seguir. Isso melhora a navegação do usuário e o ranqueamento em mecanismos de busca.

Desativando links âncora

Por padrão, os cabeçalhos incluem links âncora clicáveis que permitem aos usuários criar links diretamente para seções específicas. Você pode desativar esses links âncora usando a prop noAnchor em cabeçalhos HTML ou React.

HTML header example

<h2 noAnchor>
Header without anchor link
</h2>

Quando noAnchor é usado, o cabeçalho não exibirá o chip de âncora e clicar no texto do cabeçalho não copiará o link âncora para a área de transferência.

Formatação de texto

Suportamos a maioria das formatações do Markdown para enfatizar e estilizar o texto.

Formatação básica

Aplique estes estilos de formatação ao seu texto:

Estilo	Sintaxe	Exemplo	Resultado
Negrito	**text**	**nota importante**	nota importante
Itálico	_text_	_ênfase_	ênfase
Tachado	~text~	~recurso obsoleto~	recurso obsoleto

Combinando formatos

Você pode combinar estilos de formatação:

**_bold and italic_**
**~~bold and strikethrough~~**
*~~italic and strikethrough~~**

negrito e itálico
negrito e tachado
itálico e tachado

Sobrescrito e subscrito

Para expressões matemáticas ou notas de rodapé, use as tags HTML:

Tipo	Sintaxe	Exemplo	Resultado
Sobrescrito	<sup>text</sup>	example<sup>2</sup>	example2
Subscrito	<sub>text</sub>	example<sub>n</sub>	examplen

Links

Links ajudam usuários a navegar entre páginas e acessar recursos externos. Use textos de link descritivos para melhorar a acessibilidade e a experiência do usuário.

Links internos

Crie links para outras páginas da sua documentação usando caminhos relativos à raiz:

[Quickstart](/quickstart)
[Steps](/components/steps)

Quickstart
Steps

Evite links relativos como [page](../page), pois eles carregam mais lentamente e não podem ser otimizados com a mesma eficácia que links relativos à raiz.

Links externos

Para recursos externos, inclua o URL completo:

[Guia de Markdown](https://www.markdownguide.org/)

Guia de Markdown

Links quebrados

Você pode verificar se há links quebrados na sua documentação usando o CLI:

mint broken-links

Citações em bloco

Citações em bloco destacam informações importantes, trechos citados ou exemplos no seu conteúdo.

Citações de uma única linha

Adicione > antes do texto para criar uma citação:

> This is a quote that stands out from the main content.

Esta é uma citação que se destaca do conteúdo principal.

Blocos de citação multilinha

Para citações mais longas ou com vários parágrafos:

> This is the first paragraph of a multi-line blockquote.
>
> This is the second paragraph, separated by an empty line with `>`.

Este é o primeiro parágrafo de uma citação multilinha.

Este é o segundo parágrafo, separado por uma linha vazia com >.

Use blocos de citação com moderação para manter seu impacto visual e seu significado. Considere usar callouts para notas, avisos e outras informações.

Expressões matemáticas

Damos suporte a LaTeX para renderizar expressões e equações matemáticas.

Matemática inline

Use um único cifrão, $, para expressões matemáticas inline:

The Pythagorean theorem states that $(a^2 + b^2 = c^2)$ in a right triangle.

O teorema de Pitágoras afirma que $(a^2 + b^2 = c^2)$ em um triângulo retângulo.

Equações em bloco

Use dois cifrões, $$, para equações em destaque:

$$
E = mc^2
$$

$$E = mc^2$$

O suporte a LaTeX requer sintaxe matemática correta. Consulte a documentação do LaTeX para diretrizes completas de sintaxe.

Quebras de linha e espaçamento

Controle o espaçamento e as quebras de linha para melhorar a legibilidade do conteúdo.

Quebras de parágrafo

Separe os parágrafos com linhas em branco:

This is the first paragraph.

This is the second paragraph, separated by a blank line.

Este é o primeiro parágrafo.

Este é o segundo parágrafo, separado por uma linha em branco.

Quebras de linha manuais

Use a tag HTML <br /> para forçar quebras de linha dentro de parágrafos:

This line ends here.<br />
This line starts on a new line.

Esta linha termina aqui.
Esta linha começa em uma nova linha.

Na maioria dos casos, separar parágrafos com linhas em branco oferece melhor legibilidade do que usar quebras de linha manuais.

Melhores práticas

Organização do conteúdo

• Use títulos para criar uma hierarquia de conteúdo clara
• Siga a hierarquia correta de títulos (não salte de H2 para H4)
• Escreva títulos descritivos e ricos em palavras-chave

Formatação de texto

• Use negrito para dar ênfase, não para parágrafos inteiros
• Reserve o itálico para termos, títulos ou ênfases sutis
• Evite excesso de formatação que distraia do conteúdo

Links

• Escreva textos de link descritivos em vez de “clique aqui” ou “leia mais”
• Use caminhos relativos à raiz para links internos
• Teste os links regularmente para evitar links quebrados