Publicar em

Guia de escrita Markdown

Autor
  • avatar
    Nome
    Kevin Diego
    Twitter

Observações importantes

Este artigo tem finalidades de facilitação para os iniciantes da tecnologia como eu, minha ideia é mostrar de um ponto de vista mais simples possível.

Introdução

Criado por John Gruber e Aaron Swartz com o intuito de que as pessoas pudessem criar estruturas para a Web de maneira simples, o Markdown tornou-se muito utilizado em casos onde precisamos criar estruturas rápidas de texto.

Aaron Swartz

Aaron Hillel Swartz foi um programador, escritor, ativista político e hacktivista estadunidense. Desde muito cedo já considerado um prodígio, Aaron é considerado um grande marco na história da tecnologia. Para saber mais veja o documentário sobre sua história O menino da internet.

O que é Markdown?

Markdown é uma maneira de estilizar texto na web. Você controla a exibição do documento; formatar palavras como negrito ou itálico, adicionar imagens e criar listas são apenas algumas das coisas que podemos fazer com o Markdown. Principalmente, Markdown é apenas um texto regular com alguns caracteres não alfabéticos inseridos, como # ou *.

Guia

Aqui está uma visão geral da sintaxe do Markdown que você pode usar em qualquer lugar no GitHub.com ou em seus próprios arquivos de texto.

Headers

# Isto é uma tag H1

## Isto é uma tag H2

#### Isto é uma tag H4

Isto é uma tag H1

Isto é uma tag H2

Isto é uma tag H4

Ênfases

_Adicionando efeito itálico_

**Adicionando efeito negrito**

_Podemos **também** combinar as estilizações_

Adicionando efeito itálico

Adicionando efeito negrito

Podemos também combinar as estilizações

Listas

Não ordenada

- Item 1
- Item 2
  - Item 2a
  - Item 2b
  • Item 1
  • Item 2
    • Item 2a
    • Item 2b

Ordenada

1. Item 1
1. Item 2
1. Item 3
   1. Item 3a
   1. Item 3b
  1. Item 1
  2. Item 2
  3. Item 3
    1. Item 3a
    2. Item 3b

Imagens

![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)
Format: ![Alt Text](url)

GitHub Logo

http://github.com - automatic!
[GitHub](http://github.com)

http://github.com - automatic! GitHub

Blocos

Motivos da reúnião:

> Metas anuais.
> Alinhamento do novo processo.

Motivos da reúnião:

Metas anuais. Alinhamento do novo processo.

Código em linha

Precisamos conclúir aquela <strong>Sprint</strong> dentro do prazo previsto.

Precisamos conclúir aquela Sprint dentro do prazo previsto.

Sintaxe highlighting

Guia completo GitHub Flavored Markdown:

```js:fancyAlert.js
function fancyAlert(arg) {
  if (arg) {
    $.facebox({ div: '#foo' })
  }
}
```

E aqui está como fica - bem colorido com títulos de código estilizados!

fancyAlert.js
function fancyAlert(arg) {
  if (arg) {
    $.facebox({ div: '#foo' })
  }
}

Notas de rodapé

Aqui está uma nota de rodapé simples[^1]. Com algum texto adicional depois dele.

[^1]: Minha referência.

Aqui está uma nota de rodapé simples1. Com algum texto adicional depois dele.

Lista de tarefas

- [x] Criar componente de rotas
- [x] Criar Footer da aplicação
- [ ] Fazer o commit das alterações
  • Criar componente de rotas
  • Criar Footer da aplicação
  • Fazer o commit das alterações

Tabelas

Você pode criar tabelas reunindo uma lista de palavras e dividindo-as com hífens - (para a primeira linha) e, em seguida, separando cada coluna com uma barra vertical |:

| Primeiro                | Segundo                 |
| --------------------------- | ---------------------------- |
| Conteúdo da célula 1       | Conteúdo da célula 2          |
| Conteúdo da primeira coluna | Conteúdo da segunda coluna |
PrimeiroSegundo
Conteúdo da célula 1Conteúdo da célula 2
Conteúdo da primeira colunaConteúdo da segunda coluna

Tachado

Qualquer palavra com dois tils (como ~~this~~) aparecerá riscada.

Footnotes

  1. Minha referência.