Escrevendo documentos
Um documento Ribalta é feito de páginas separadas por uma linha com ---. Veja Tamanhos e documentos.
O conteúdo de uma página é escrito como em Markdown, com uma diferença importante: em uma página, cada linha tem intenção, então uma quebra de linha no texto é uma quebra de linha na página.
Títulos
Seção intitulada “Títulos”Comece a linha com # seguido de um espaço. Use de um a seis # para os níveis de título:
# Título principal## Subtítulo### SeçãoTexto comum da página.O tamanho, o peso e a fonte de cada nível vêm do tema. O primeiro título da página também dá nome a ela, para o programa que mostra o documento exibir em listas e índices.
Parágrafos e quebras de linha
Seção intitulada “Parágrafos e quebras de linha”Linhas seguidas formam um parágrafo, e cada linha aparece em uma linha própria na página. Uma linha em branco separa um bloco do próximo:
# Próxima reuniãoQuinta-feira, às 14hSala 3, segundo andar
Traga os números do mês anterior.Negrito, itálico, riscado e código
Seção intitulada “Negrito, itálico, riscado e código”| Você escreve | Resultado |
|---|---|
**negrito** | negrito |
*itálico* | itálico |
~~riscado~~ | |
`código` | código |
As marcações podem ser combinadas:
# ÊnfaseTexto em **negrito**, *itálico* e ~~riscado~~.Código no meio da frase: `npm install`.**Negrito com *itálico* dentro.**Escreva o texto entre colchetes e o endereço entre parênteses. São aceitos endereços que começam com https:// ou http:// e endereços de e-mail com mailto::
# ContatoConheça o projeto em [nosso site](https://example.com).Dúvidas: [email@email.com](mailto:email@email.com)Comece cada item com - (ou *, ou +). Para listas numeradas, use 1. ou 1). Indente um item para criar uma lista aninhada:
# Plano de ação- Mapear os processos atuais- Definir as prioridades - Curto prazo - Longo prazo- Apresentar à diretoria
---# Etapas1. Diagnóstico2. Proposta3. ImplantaçãoAlgumas regras úteis:
- A numeração começa no primeiro número que você escrever: uma lista que começa com
3.continua em 4, 5 e assim por diante. - Uma linha indentada logo abaixo de um item, sem marcador, continua o mesmo item em uma nova linha.
- Uma linha em branco termina a lista.
Citações
Seção intitulada “Citações”Comece as linhas com >. Tudo o que estiver depois do > é tratado como conteúdo comum, então você pode usar ênfase e várias linhas:
> O relatório que levava uma semana agora fica pronto em uma hora.> — Gerente de operaçõesBlocos de código
Seção intitulada “Blocos de código”Coloque o código entre duas linhas com três crases. Informe a linguagem depois das crases de abertura para ter realce de sintaxe:
# Consulta de vendas```sqlSELECT nome, totalFROM vendasWHERE ano = 2026;```O conteúdo de um bloco de código aparece exatamente como foi escrito. Linhas com --- dentro dele não começam uma nova página.
Tabelas
Seção intitulada “Tabelas”Separe as colunas com | e coloque uma linha de traços logo abaixo do cabeçalho. Use : na linha de traços para alinhar a coluna:
# Planos| Plano | Usuários | Preço mensal || :--- | :---: | ---: || Básico | 5 | R$ 49 || Equipe | 20 | R$ 149 || Empresa | Ilimitado | R$ 399 || Linha de traços | Alinhamento |
|---|---|
--- ou :--- | À esquerda |
:---: | Centralizado |
---: | À direita |
As células aceitam negrito, itálico, código e links. Tabelas também servem de fonte de dados para gráficos.
Imagens
Seção intitulada “Imagens”Use a sintaxe de imagem do Markdown: !, a descrição entre colchetes e o endereço entre parênteses. Atributos colados logo depois ajustam o tamanho e o recorte:
# Nossa sede{h=600 radius=lg}O endereço precisa começar com https:// ou ser uma imagem guardada (asset:). Veja Imagens para imagens guardadas e fit=cover.
Comentários
Seção intitulada “Comentários”Uma linha que começa com // é um comentário: ela não aparece na página nem nas notas. Use para lembretes ou para esconder um trecho temporariamente:
// Confirmar os números com o financeiro# Metas do semestreExpandir para duas novas regiões.
// Reduzir custos em 10%.Melhorar o tempo de resposta ao cliente.O // só vale no começo da linha. No meio de uma frase, como em um endereço https://, ele é texto comum.
Escapando caracteres
Seção intitulada “Escapando caracteres”Algumas sequências têm significado especial, como *, # no começo da linha ou { no fim. Para escrever o caractere em si, coloque uma barra invertida \ antes dele:
# Tabela de preços \{2026}
Use \*asteriscos\* sem itálico.
\# Esta linha não é um título.
\- Esta linha não é um item de lista.A barra invertida funciona antes de qualquer sinal de pontuação. Dentro de uma tabela, \| escreve uma barra vertical sem criar uma nova coluna.
O bloco ::: notes guarda observações para quem mostra o documento, como o que dizer em cada página de uma apresentação. As notas nunca são desenhadas na página; o programa que mostra o documento decide onde exibi-las, por exemplo numa tela só para quem apresenta:
# Resultados do trimestreA receita cresceu 38%.
::: notesComentar que o crescimento veio principalmente de clientes novos.Abrir para perguntas antes da próxima página.:::O bloco começa com ::: notes e termina com uma linha contendo apenas :::. O texto dentro dele é guardado como está, sem formatação.
Próximos passos
Seção intitulada “Próximos passos”- Layouts: organize o conteúdo em colunas, linhas e grades.
- Estilos: mude cores, tamanhos e fontes.
- Referência da sintaxe: toda a linguagem em uma página.