Guia rápido de markdown

A Agenda não é um editor de markdown, mas reconhece alguma sintaxe markdown para aplicar estilos. Aqui ficam os atalhos de markdown que podem ser usados.

Estilos de parágrafo

Os estilos seguintes alteram o aspeto do parágrafo inteiro.

Título

Usa de 1 a 6 cardinais no início da linha, seguidos de um espaço. O nível do título é dado pelo número de cardinais. Ex.: ### Exemplo produz um título de terceiro nível.

Lista com travessões ou marcas

Começa uma linha com uma marca, um hífen, um asterisco ou um sinal de mais para criar um item de lista com travessão. Ex.: • Item de exemplo 1 - Item de exemplo 2 * Item de exemplo 3 + Item de exemplo 4 produz um item de lista com travessões ou marcas.

Lista numerada

Começa uma linha com um número seguido de um ponto e um espaço para criar um item de lista numerada. Ex.: \1. Item de exemplo 1 produz um item de lista numerada.

Para começares uma lista numerada num número diferente de 1, basta usares esse número Ex.: \3. Item de exemplo 3 produz um item de lista numerada a começar em 3.

Lista de verificação

Começa uma linha com um hífen seguido de um parêntesis reto de abertura e um de fecho. Inserir um “x” entre os dois parêntesis cria um item assinalado. Ex.: - [ ] Exemplo produz um item de lista de verificação.

- [x] Exemplo produz um item assinalado.

O hífen é opcional, pelo que também podes criar uma caixa de verificação usando apenas dois parêntesis retos.

Pré-formatado

Para conteúdo que fica melhor num tipo de letra de largura fixa, como código de computador, podes aplicar o estilo pré-formatado. Podes acionar este estilo começando a linha com três plicas invertidas. Ex.: ```exemplo produz exemplo

Código

A Agenda suporta a coloração de sintaxe de código de computador. Ao adicionares a linguagem a seguir às três plicas invertidas, podes indicar em que linguagem o excerto de código foi escrito. Ex.: ```swift int i = 0; produz int i = 0 colorido usando a linguagem Swift

Uma lista completa de todos os parâmetros de linguagem suportados é mantida pelo projeto highlight.js em https://github.com/highlightjs/highlight.js/blob/main/SUPPORTED_LANGUAGES.md.

Citação

Usa um ou mais símbolos > no início da linha, seguidos de um espaço. O número de caracteres > determina o nível da citação, indicado pelas linhas verticais que precedem o texto. Ex.: > Exemplo produz

Exemplo

Estilos incorporados

Estes estilos são usados dentro dos parágrafos para alterar o aspeto do texto.

Itálico

Delimitar com sublinhados ou asteriscos dá um estilo itálico. Ex.: _exemplo_ ou *exemplo* produz exemplo

Negrito

Delimitar com sublinhados duplos ou asteriscos duplos dá um estilo negrito. Ex.: __exemplo__ ou **exemplo** produz exemplo

Riscado

Delimitar com tis duplos dá um estilo riscado. Ex.: ~~exemplo~~ produz exemplo

Largura fixa (monoespaçado)

Para alguns conteúdos, como código-fonte de computador, é preferível ter texto de largura fixa. Para blocos de texto, é melhor usar o estilo de parágrafo Pré-formatado. Para texto incorporado, podes delimitá-lo com plicas invertidas. Ex.: `exemplo` produz exemplo

Destaque

Delimitar com sinais de igual duplos ou dois pontos dá um estilo de destaque. Ex.: ==exemplo== ou ::exemplo:: destaca a palavra exemplo

Inserir

Alguns estilos não estão relacionados com o significado do texto, mas servem para delimitar elementos informativos, como as etiquetas. Estes também podem ser introduzidos usando uma sintaxe semelhante à do markdown.

Etiquetas

Para introduzires uma etiqueta, basta usares um símbolo #, seguido da etiqueta. A etiqueta não pode conter espaços. Ex.: Escreve #giraffes para criar uma etiqueta chamada “giraffes”.

Escrever um # aciona o popover de preenchimento automático para te ajudar a encontrar a etiqueta que procuras.

As etiquetas também podem conter um parâmetro entre parêntesis. Por exemplo, #due(12/12/2018). Para saberes mais sobre como tirar pleno partido dos parâmetros nas etiquetas, consulta o capítulo Etiquetas, pessoas, ações de texto e ligações.

Etiquetas de pessoas

A Agenda reconhece um segundo tipo de etiqueta reservado a indivíduos (pessoas). Podes introduzir um nome ou iniciais para te referires a um amigo ou colega. Basta introduzires um símbolo @ antes do texto. Ex.: Introduz @Tom para criares uma etiqueta de pessoa para alguém chamado “Tom”.

Escrever um @ aciona o popover de preenchimento automático para te ajudar a encontrar a pessoa que procuras.

Emoji

Para introduzires um emoji, basta escreveres um : (dois pontos), seguido da abreviatura do emoji, e novamente um : de fecho. Ex.: Escreve :+1: para inserires o emoji 👍.

Escrever um : aciona o popover de preenchimento automático para te ajudar a encontrar o emoji que procuras.

Linha horizontal

Se gostas de delimitar visualmente secções dentro das tuas notas com uma linha horizontal, podes fazê-lo escrevendo três hífenes seguidos e depois um espaço: Ex.: Introduz --- para criares uma linha horizontal.

Dica: Se estiveres a importar um ficheiro markdown, podes fazer com que ele seja dividido em notas individuais na Agenda usando os mesmos três hífenes seguidos: Ex.: Primeira nota --- Segunda nota

Isto criará duas notas diferentes, a primeira com o conteúdo “Primeira nota”, e a segunda com o conteúdo “Segunda nota”.

Tabelas

A Agenda dá-te a possibilidade de inserir tabelas nas tuas notas, que podes criar rapidamente escrevendo três ou mais símbolos de barra vertical (|) seguidos no início da linha: Ex.: Introduz ||| para inserires uma tabela.

Ligações

As ligações são reconhecidas automaticamente no texto, mas também podes adicioná-las com sintaxe markdown. Usa parêntesis retos para delimitar o texto que é apresentado, seguidos de parêntesis curvos a delimitar o URL da ligação. Ex.: Introduz [Agenda](agenda.com) para criares uma ligação para agenda.com associada ao texto “Agenda”.

Ações de texto

Embora não façam estritamente parte da sintaxe markdown clássica, a Agenda permite acionar certas ações se começares por escrever uma barra invertida , seguida de uma ação.

Por exemplo, \remind aciona a inserção de um lembrete na tua nota. Podem ser fornecidos parâmetros opcionais como parte da ação; por exemplo, \remind(today at noon) agenda um lembrete para hoje ao meio-dia. Outras ações comuns são \now, \date e \time, para inserir a data e a hora atuais.

Para uma visão geral completa de todas as ações, consulta o capítulo Guia rápido de ações de texto.

As ações também podem ser usadas como marcadores de posição em modelos; consulta o capítulo Criar e usar modelos.

Impedir a interpretação de markdown

Embora os atalhos de markdown possam ser super úteis e rápidos, há alturas em que podes não querer que algo seja reconhecido como markdown. Podes escapar as sequências markdown acima escrevendo primeiro um caráter de barra invertida \, seguido do que normalmente escreverias. Ao premires o espaço, o caráter de barra invertida deverá desaparecer automaticamente e o texto deverá ficar tal como o escreveste. Por exemplo, escrever \1. Something não resultará numa lista numerada, mas no texto 1. Something.

Nota que o markdown nunca é interpretado dentro de texto que tenha o estilo de parágrafo Preformatted nem o estilo incorporado Fixed Width.