Guía Markdown

Guia de sintaxe Markdown

Esta é uma visão geral da sintaxe do Markdown. Para obter mais informações, visite o [site da Markdown].

[Site Markdown]:
http://daringfireball.net/projects/markdown/

Itálico e Negrito

Isto está em itálico , e assim é esta .

Esta é ousada , e assim é esta .

Você pode usar itálico e negrito juntos, se necessário .

Links

Links simples

Existem três maneiras de escrever links. Cada um é mais fácil de ler do que o anterior:

Aqui está um link embutido para o Google .
Aqui está um link de estilo de referência para o Google .
Aqui está um link muito legível para o Yahoo! .

As definições de link podem aparecer em qualquer lugar no documento – antes ou depois do local onde você as usa. Os nomes de definição de link ( 1e Yahoo!) podem ser qualquer string exclusiva e não fazem distinção entre maiúsculas e minúsculas; [Yahoo!]é o mesmo que [YAHOO!].

Links avançados: atributos de título

Você também pode adicionar um titleatributo a um link, que aparecerá quando o usuário segurar o ponteiro do mouse sobre ele. Os atributos de título são úteis se o texto do link não for descritivo o suficiente para informar aos usuários para onde estão indo. (Em links de referência, você pode usar parênteses opcionalmente para o título do link em vez de aspas.)

Aqui está um link com nome ruim .
Nunca escreva ” clique aqui “.
Confie em mim .

(Advice against the phrase "click here")

Links avançados: URLs nus

Você pode escrever URLs simples, colocando-os entre colchetes angulares:

Meu site está em http://www.attacklab.net .

Se você usar esse formato para endereços de e-mail, o Showdown codificará o endereço para torná-lo mais difícil para os spammers coletarem. Experimente e observe o painel de saída HTML para ver os resultados:

Humanos podem ler isso, mas a maioria dos robôs coletores de spam não: me@privacy.net

Cabeçalhos

Existem duas maneiras de fazer cabeçalhos no Markdown. (Nestes exemplos, o Cabeçalho 1 é o maior e o Cabeçalho 6 é o menor.)

Você pode sublinhar o texto para fazer os dois cabeçalhos de nível superior:

Cabeçalho 1

Cabeçalho 2

O número de sinais =ou -não importa; você pode fugir com apenas um. Mas usar o suficiente para sublinhar o texto faz com que seus títulos tenham uma aparência melhor em texto simples.

Você também pode usar marcas de hash para todos os seis níveis de cabeçalhos HTML:

Cabeçalho 1

Cabeçalho 2

Cabeçalho 3

Cabeçalho 4

Cabeçalho 5
Cabeçalho 6

Os #caracteres de fechamento são opcionais.

Regras horizontais

Você pode inserir uma regra horizontal colocando três ou mais hifens, asteriscos ou sublinhados em uma linha:




Você também pode usar espaços entre os caracteres:


Todos esses exemplos produzem a mesma saída.

Listas

Listas simples

Uma lista com marcadores:

  • Você pode usar um sinal de menos para uma bala
  • Ou sinal de mais
  • Ou um asterisco

Uma lista numerada:

  1. Listas numeradas são fáceis
  2. Markdown mantém o controle dos números para você
  3. Portanto, este será o item 3.

Uma lista em espaço duplo:

  • Esta lista fica embrulhada em <p>tags

  • Portanto, haverá espaço extra entre os itens

Listas avançadas: aninhamento

Você pode colocar outros blocos Markdown em uma lista; apenas recue quatro espaços para cada nível de aninhamento. Então:

  1. Listas em um item de lista:

    • Quatro espaços recuados.
      • recuou oito espaços.
    • Quatro espaços novamente.
  2. Vários parágrafos em uma lista de itens:

    É melhor recuar os parágrafos com quatro espaços.
    Você pode se safar com três, mas pode ficar
    confuso quando você aninha outras coisas.
    Atenha-se a quatro.

    Recuamos a primeira linha com um espaço extra para alinhá-
    la com esses parágrafos. Em uso real, podemos fazer
    isso com a lista inteira para que todos os itens se alinhem.

    Este parágrafo ainda faz parte do item da lista, mas parece confuso para os humanos. Portanto, é uma boa ideia quebrar seus parágrafos aninhados manualmente, como fizemos com os dois primeiros.

  3. Blockquotes em um item da lista:

    Pule uma linha e
    indente os quatro espaços do>.

  4. Texto pré-formatado em um item da lista:

    Skip a line and indent eight spaces.
    That's four spaces for the list
    and four to trigger the code block.

Citações em bloco

Blockquotes simples

Blockquotes são recuados:

A sintaxe é baseada na maneira como os programas de e-mail
costumam fazer cotações. Você não precisa embrulhar
os parágrafos em suas citações de bloco, mas fica muito melhor se o fizer. Depende de como você se sente preguiçoso.

Blockquotes avançados: aninhamento

Você pode colocar outros blocos Markdown em um blockquote; basta adicionar um >seguido por um espaço:

O parágrafo quebra em uma aspa:

O> nas linhas em branco é opcional.
Inclua ou não; Markdown não se importa.

Mas seu texto simples fica melhor para os
humanos se você incluir o extra >
entre os parágrafos.

Blockquotes dentro de um blockquote:

Um blockquote padrão é indentado

Um blockquote aninhado é mais indentado

Você pode aninhar em qualquer profundidade.

Listas em um blockquote:

  • Uma lista em um blockquote
  • Com um> e um espaço na frente
    • Uma sublista

Texto pré-formatado em um blockquote:

Indent five spaces total.  The first
one
is part of the blockquote designator.

Imagens

As imagens são exatamente como links, mas têm um ponto de exclamação na frente delas:

XHTML válido.

A palavra entre colchetes é o texto alternativo, que é exibido se o navegador não puder mostrar a imagem. Certifique-se de incluir um texto alternativo significativo para software leitor de tela para usuários cegos.

Assim como os links, as imagens funcionam com sintaxe e títulos de referência:

Esta página é XHTML válido.

"What are you smiling at?"

Nota:

O Markdown não suporta atualmente a sintaxe de referência mais curta para imagens:

Aqui está um quebrado marca de verificação.

Mas você pode usar uma versão um pouco mais detalhada dos nomes de referência implícitos:

Isso marca de verificaçãofunciona.

O nome de referência ( valid icon) também é usado como texto alternativo.

HTML embutido

Se você precisa fazer algo que o Markdown não consegue lidar, você pode apenas usar HTML:

O humor tachado é <strike> engraçado </strike>.

Markdown é inteligente o suficiente para não danificar seu HTML de nível de span:

<u> O Markdown funciona bem aqui. </u>

Elementos HTML de nível de bloco têm algumas restrições:

  1. Eles devem ser separados do texto circundante por linhas em branco.
  2. As marcas de início e fim do elemento de bloco mais externo não devem ser indentadas.
  3. Você não pode usar Markdown em blocos de HTML.

Então:

<div style = “background-color: lightgray”>
Você <em> não </em> pode usar Markdown aqui.
</div>

Texto Pré-formatado

Você pode incluir texto pré-formatado em um documento Markdown.

Para fazer um bloco de código, indente quatro espaços:

printf("goodbye world!");  /* his suicide note
was in C */

O texto será quebrado em tags <pre>e <code>, e o navegador irá exibi-lo em uma fonte monoespaçada. Os primeiros quatro espaços serão removidos, mas todos os outros espaços em branco serão preservados.

Você não pode usar Markdown ou HTML em um bloco de código, o que os torna uma maneira conveniente de mostrar exemplos de sintaxe Markdown ou HTML:

<blink>
You would hate this if it weren't

wrapped in a code block.

</blink>

Código Spans

Você pode fazer <code>tags embutidas usando extensões de código. Use crases para fazer um intervalo de código:

Pressione a <Tab>tecla e digite a $.

(A tecla backtick está no canto superior esquerdo da maioria dos teclados.)

Como os blocos de código, as extensões de código serão exibidas em uma fonte monoespaçada. Markdown e HTML não funcionarão com eles:

Markdown coloca em itálico coisas assim: I *love* it.

Não use a <font>tag; use CSS em vez disso.