Skip to content

Latest commit

 

History

History
387 lines (242 loc) · 8.46 KB

markdown-tutorial.md

File metadata and controls

387 lines (242 loc) · 8.46 KB

FORMATAÇÃO MARKDOWN PARA GITHUB

Índice

Formato Sintaxe Exemplo
Títulos # h1
## h2
### h3
#### h4
##### h5
###### h6

Título h3

Parágrafos Deixar linha em branco entre as frases Linha1

Linha2
Negrito **Conteúdo** Conteúdo
Itálico *Conteúdo* Conteúdo
Negrito e itálico ***Conteúdo*** Conteúdo
Rasurado ~~Conteúdo~~ Conteúdo
Citações > Conteúdo
Conteúdo
Citações aninhadas >> Conteúdo
Conteúdo
Listas ordenadas 1. item 1
2. item 2
  1. item 1
  2. item 2
Listas não-ordenadas -item
-item
  • item
  • item
Subitens 1. Item 1
1. subitem 1
2. subitem 2
2. Item 2
-subitem
-subitem
  1. item 1
    1. subitem i
    2. subitem ii
  2. item 2
    • item
    • item
Lista de Tarefas - [ ] A
- [x] B
Veja aqui
Bloco de código ```Conteúdo``` Veja aqui
Código `Conteúdo` Conteúdo
Preformatação                          Comece cada linha com dois espaços ou mais                          Veja aqui
Linha horizontal --- ou ___ ou ===
Imagens ![Alt](/link.png) github-icon
Imagens com legenda ![Alt](/link.png "legenda") github-icon
Links [Conteúdo](/link) Conteúdo
Links com legenda [Conteúdo](/link "legenda") Conteúdo
Índice [Conteúdo](#título) Conteúdo
Email e URL <[email protected]> [email protected]
Imagem com link [![Alt](/link.png)](/link) github-icon
Lista de referência [Conteúdo][1]
[1]: link
Veja aqui
Escape characters Barra invertida antes do símbolo Veja aqui
Tabelas | Título 1 | Título 2 | Título 3 |
|----------|:----------:|----------:|
| col 1 lin 1 | col 2 lin 1 | col 3 lin 1 |
Veja aqui
Emojis :código-do-emoji: 😄
Notas de rodapé Conteúdo[^1] [^1]: Nota Veja aqui

Títulos

Utiliza-se o símbolo # :

# h1
## h2
### h3
#### h4
##### h5
###### h6

Parágrafos

Basta separar o texto por uma linha em branco.

  • Não deixe espaços em branco antes do texto.

Para pular mais de uma linha é necessário deixar dois espaços em cada linha em branco.

Indentação

Utilizar espaços antes do texto pode causar conflitos. Utilizamos &nbsp; (equivale a 1 espaço) antes do texto. Para um espaçamento maior, repetimos o comando.

    Isso é um parágrafo indentado.

Formatação de Texto

Negrito

Coloque o conteúdo entre **:

Texto em **negrito**

Itálico

Coloque o conteúdo entre *:

Texto em *itálico*

Negrito e Itálico

Coloque o conteúdo entre ***:

Texto em ***negrito e itálico***

Rasurado

Coloque entre ~~:

Texto ~~rasurado~~

Citações

Utilize > seguido de espaço no início do texto:

> Citação

Citações aninhadas

Utilize mais de um > (com apenas um espaço após o último) no início do texto:

>> Citação aninhada

Listas

Listas ordenadas

Utilize números seguidos de ponto:

  1. 1. Item 1
  2. 2. Item 2
  3. 3. Item 3

Listas não-ordenadas

É possível utilizar -, * ou + no início do texto:

  • - Item
  • - Item
  • - Item

Subitens

Utilize 4 espaços ou 1 tabulação e insira o markdown da lista ordenada ou não-ordenada:

  1. 1. Item 1
    1. 1. SubItem i
    2. 2. SubItem ii
  2. 2. Item 2
    • - Item
    • - Item

Lista de Tarefas

Utilize -[ ] antes do item, e -[x] para um item checked:

  • -[ ] A
  • -[ ] B
  • -[ ] C
  • -[x] D

Blocos de código

Coloque o conteúdo entre ```:

    ```
     <tag>
        <tag2>
        </tag2>
    </tag>
    ```

Code

Coloque o conteúdo entre ` :

`conteúdo`

Preformatação

Comece o conteúdo com dois espaços ou mais:

texto   pre-formatado
 É similar ao bloco de código.
    Interpreta todos os       espaços

Linhas horizontais

Utilize um desses ***, --- ou ___:


  • Por convenção, deixe linhas em branco em cima e embaixo.

Imagens

Utilize o modelo abaixo:

![Alt](/link.png)

github-icon

Imagens com legenda

Utilize o modelo abaixo:

![Alt](/link.png "legenda")

github-icon

Links

Utilize o modelo abaixo:

[Texto Linkado](/link)

Link com legenda

Utilize o modelo abaixo:

[Texto linkado](/link "legenda")

Índices

[Título linkado](#título)

  • Utilize o nome dos títulos como pontos de referência na página.

Email e URL

Para transformar um email ou URL clicável:

<link> ou <[email protected]>

[email protected]

  • No caso do email, torna-se equivalente a <mailto:[email protected]>. Será encaminhado a alguma plataforma de envio de emails (Outlook, Gmail, etc).

Imagem com link

Utilize o código abaixo

[![Alt](/link.png)](/link)

github-icon

Lista de Referências

São duas partes, a primeira é:

[texto][n]

Onde n é o número que se referencia ao item da lista na segunda parte:

[n]: link

Exemplo

Escape Characters

Alguns caracteres são utilizados para comandos. Caso precise utilizá-los literalmente, adicione uma barra invertida antes (\).

Exemplos de alguns caracteres para dar escape:

  • {}
  • ()
  • []
  • <>
  • #
  • .
  • +
  • -
  • *
  • _
  • `
  • !
  • |
  • \

Tabelas

Título1 | Título2
--------- | ------
A     | 1
B     | 2
C     | 3
D     | 4

Modelo:

Título1 Título2
A 1
B 2
C 3
D 4

Alinhando itens da tabela

No tracejado horizontal, insira : na direção do alinhamento. Para centralizar, basta colocar dos dois lados:

Título1 | Título2
:---------: | ------:
A     | 1
B    | 2
C   | 3
D  | 4
Título1 Título2
A 1
B 2
C 3
D 4

Emojis

Insira o atalho do emoji entre :. Os atalhos podem ser encontrados aqui 😄

:smile:

Notas de Rodapé

Similar à lista de links, mas o link aparecerá sobrescrito1:

palavra[^1]
[^1]: Texto da footnote.

Footnotes

  1. A anotação de rodapé aparece somente no final do documento, mesmo que [^1]: Nota seja declarada no meio.