Markdown é uma linguagem simples de marcação que converte texto simples para html, ou seja, o markdown é:
- uma sintaxe de formatação de texto; e
- uma ferramenta de software, escrito em Perl, que converte o texto plano para html.
A documentação do projeto pode ser vista em Daring Fireball e a sintaxe pode ser testada usando o online Dingus. O markdown é utilizado pelo Github Pages para formatação dos textos.
Algumas opções de sintaxes que serão vistas nesse tutorial:
- Cabeçalho
- Listas
- Citações
- Bloco de códigos
- Linhas horizontais
- Links
- Imagens
- Tabelas
- Enfâse
- Notas de rodapé
- Abreviações
- Caractere de Escapes
1. Cabeçalho
Markdown suporta dois estilos de cabeçalhos:
=
para primeiro nível e-
para segundo nível:
- O
#
pode ser usado de 1-6 no início da linha correspondendo aos níveis 1-6:
O resultado será:
h1
h2
h3
h4
h5
h6
2. Listas
Para listas não ordenadas use *
, +
e -
como marcador de lista:
É equivalente a:
E:
O resultado será:
- Vermelho
- Verde
- Azul
Para lista ordenadas use números:
O resultado será:
- Vermelho
- Verde
- Azul
Se, ao invés você escrever a lista assim:
ou:
Você terá o mesmo resultado. Caso você queira usar uma sequência diferente, como anos, você pode usar o caractere de escape \
assim:
O resultado será:
2017. Ano que criei esse site “victorholanda21.github.io”.
3. Citações
Para citações coloque >
no início da linha:
O resultado será (pré-formatado pelo css do tema):
Esta é uma citação com dois parágrafos. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse id sem consectetuer libero luctus adipiscing.
Você pode também colocar somente um >
no início do primeiro parágrafo e também terá o mesmo resultado:
Você pode colocar cabeçalhos, lista e bloco de códigos dentro de citações:
O resultado será:
Cabeçalho.
- Primeiro item.
- Segundo item.
Exemplo de código:
return shell_exec("echo $input | $markdown_script");
4. Bloco de códigos
Bloco de códigos pré-formatados são usados por programadores para marcação de código fonte. Para produzir em markdown simplesmente inicie cada linha do bloco com ao menos 4 espaços ou 1 tab. Por exemplo:
No Jekyll você também pode usar:
5. Linhas horizontais
Você pode criar linhas horizontais de três maneiras ou mais, usando hífen, asteriscos ou underline. Cada exemplo você terá o mesmo resultado:
6. Links
Markdown suporta dois estilos de links: “inline” e referência. Em ambos, o texto do link é delimitado por colchetes [ ]
e o link delimitado por parênteses ( )
.
Para links “inline” você pode:
Para referência você usa um segundo grupo de colchetes e dentro você coloca um rótulo de sua escolha para a identificação do link. Exemplo:
Em qualquer lugar do documento você irá definir o destino do link:
O nome de definição pode consistir de letras, números, espaço e pontuação, mas eles não são case sensitive, ou seja, não há diferença entre letras maiúsculas e minúsculas.
Você pode adicionar atributos ao link como id
, class
ou target
envolvendo pelas chaves { }
cada atributos, por exemplo:
7. Imagens
Para inserir imagens você pode usar os mesmo estilos e uma sintaxe parecida com a utilizada em links. Exemplo:
Obs.: O nome da imagem é o nome que irá aparecer ao colocar o mouse em cima da imagem ou quando a imagem não for visualizada, por alguma falha de download, por exemplo.
8. Tabelas
Para criar uma tabela simples com cabeçalho utilize o tubo |
(pipe, em inglês) para separar as colunas.
O resultado será:
Cabeçalho | Cabeçalho |
---|---|
Conteúdo | Conteúdo |
Conteúdo | Conteúdo |
Se preferir pode organizar da seguinte forma que também terá o mesmo resultado:
Você pode especificar o alinhamento da coluna adicionando o sinal de dois pontos :
. Se adicionado na esquerda a coluna será alinhada à esquerda; se adicionado na direita a coluna será alinha à direita; e em ambos os lados a coluna será centralizada:
O resultado:
Número | Item | Valor |
---|---|---|
1 | Computador | R$1.600,00 |
2 | Mouse | R$12,00 |
3 | Mousepad | R$1,00 |
9. Enfâse
Markdown trata asteriscos *
e underscores _
como indicador de ênfases. Envolvendo o texto com um *
ou _
o texto ficará em itálico; dois *
ou _
o texto ficará em negrito:
O resultado será:
um asterisco
um underscore
dois asteriscos
dois underscores
10. Notas de rodapé
As notas de rodapés são definidas de forma parecida dos links por referência:
11. Abreviações
Markdown também permite usar abreviações. Funciona da seguinte forma, crie uma definição de abreviação como:
E em qualquer lugar do texto use a palavra, abreviações são case sensitive:
12. Caractere de Escapes
Markdown usa a barra invertida \
para providenciar um escape, ou seja, para para os caracteres serem literalmente utilizado e não serem interpretados:
Resultado:
*asterisco*