É possível usar vários parágrafos dentro da citação.
Também é possível aninhar citações.
Código
Código em linha
Use código dentro do seu texto.
Blocos de código
main.js
1console.log('Olá!');
hello.rb
1puts "Olá!"
Emojis
Este é um emoji 😄.
Outros exemplos:
😄
😆
😊
😃
Diagrama Mermaid
Tabelas
Cabeçalho 1
Cabeçalho 2
Cabeçalho 3
Célula 1
Célula 2
Célula 3
Célula 4
Célula 5
Célula 6
Linhas horizontais
Sintaxe estendida
Listas de tarefas
Tarefa concluída
Tarefa pendente
(Opcional) Tarefa opcional
Avisos e caixas de destaque
As caixas de destaque ajudam a chamar atenção para informações importantes na documentação. Cada tipo possui uma finalidade e um estilo visual específicos.
Sintaxe básica
Tipos disponíveis
1. Observação
Use para informações gerais ou referências úteis.
Exemplo: “Lembre-se de salvar suas alterações antes de sair.”
2. Dica
Use para sugestões úteis e boas práticas.
Exemplo: “Você pode usar atalhos de teclado para trabalhar mais rápido.”
3. Alerta
Use para avisos sobre possíveis problemas ou situações que exigem atenção.
Exemplo: “Faça backup dos dados antes de continuar com a atualização.”
4. Importante
Use para informações essenciais que não podem passar despercebidas.
Exemplo: “Chaves de API nunca devem ser compartilhadas publicamente.”
5. Cuidado
Use para operações arriscadas ou que podem causar consequências graves.
Exemplo: “Excluir esta pasta removerá permanentemente todos os arquivos.”
6. Pergunta
Use para perguntas frequentes ou pontos de discussão.
Exemplo: “Por que usar TypeScript em vez de JavaScript?”
7. Citação
Use para citações ou materiais referenciados.
Exemplo: “Código é como humor. Quando você precisa explicá-lo, ele não é bom.” — Cory House
8. Comentário
Use para contexto adicional ou observações paralelas.
Exemplo: “Este recurso ainda está em fase beta.”
9. Documentação
Use para informações e referências específicas da documentação.
Exemplo: “Consulte a documentação da API para obter mais detalhes.”
Uso avançado
As caixas de destaque aceitam sintaxe Markdown em seu interior:
