Com a popularização do GitHub, e também da grande quantidade de novos programadores ultimamente, a demanda para aprender Markdown aumentou bastante. Markdown é uma linguagem de marcação, parecido com a sua companheira HTML.
A maior utilidade dela atualmente certamente é para criar os famosos READMEs para seus repositórios no GitHub, e deixar o seu projeto mais 'apresentável'. E é por isso que hoje trago aqui um guia simples porém definitivo para aprender a tão famosa Markdown e a importancia de um bom README em seu projeto para iniciantes.
Todo projeto seu no GitHub terá seus códigos, seus arquivos, suas pastas todas jogadas lá. Um projeto digno e bem estruturado precisa passar para o leitor o sentido do seu projeto, para que ele serve, como funciona, quais linguagens, sistemas, funcionalidades, ferramentas você utilizou para criar seu programa, como contribuir, e dezenas de outras informações necessárias tem que ficar bem explicitas ao leitor quando o mesmo se deparar com seu repositório.
E para isso existe um arquivinho bem simples chamado 'README.md' ou 'readme.md' em todo repositório no mínimo organizado no GitHub. Perceba que o arquivo possui o sufixo '.md', essa é a terminologia de arquivos Markdown. Ao criar o README.md em seu repositório, ao rolar um pouco para baixo a página inicial, todo o conteúdo formatado em Markdown irá aparecer, contendo todas as informações necessárias para o projeto. Para ver o conteúdo sem formatação, procure um ícone de um lápis, ou até clique no arquivo em si README.md, assim você será encaminhado para a edição do arquivo.
Fica claro aqui, que são todas opicionais, cabe a você desenvolvedor a analisar e escolher quais colocar em seu repositório, lembrando que nem todos pontos a seguir cabem em todos os repositórios, depende do que se trata ele, se é um jogo, um programa, um código-fonte de um site, saiba escolher o que colocar.
- Introdução
Uma breve apresentação sobre o que é o seu projeto, o que ele faz, e algumas informações úteis para serem ditas inicialmente.
- Índice
Assim como nesse readme.md também tem, é interessante ter um índice com os links para os tópicos que vão ser abordados em seu texto.
- Habilidaes adiquiridas ou requisitadas para o projeto
Se tens posse de um projeto que visa a aprendizagem, o seu próprio estudo ou até base para estudos de outras pessoas, é interessante colocar quais habilidades são requeridas para estudar/rodar o seu código, ou habilidades que vão ser adiquiridas se seguirem os seus estudos.
- Como executar
Se tens um programa que faz alguma coisa, um jogo, um código em determinada linguagem, é interessante adicionar a informação de como executar seus códigos, quais programas precisa no computador do usuário, comando para executar os códigos, algumas informaçãoes de quais arquivos precisa ter, entre diversos outros.
- Contribuindo
Se teu projeto é OpenSource, é natural que outros progamadores irão querer melhorar seu projeto, adicionando novos recursos, corrigindo algum bug, implementando alguma tecnologia, entre diversos outros, para isso ele deverá fazer pulls requests em seu código, seria muito interessante implementar algumas informações de como contribuir com o projeto, como fazer um Fork, como fazer o pull request, e até algumas preferências pessoais suas de como queres o pull request
- Créditos e Licença
É interessante também em alguns casos concluir com os créditos do repositório ou até mesmo da licença utilizada nele.
Note que não são todos os pontos a colocar, tão pouco são obrigatórios, pensei apenas em ajudar os iniciantes que estão criando teus repositórios no momento, e alguns pontos que são muito importantes para projetos simples. Claro que projetos mais avançados requerem muito mais pontos a ser colocados, e depende muito de um para outro. O foco destas dicas é pensando nos projetos mais básicos e iniciantes.
- Títulos
- Ênfase
- Linha Horizontal
- Citações
- Listas
- Códigos
- Links
- Imagens
- Links em imagens
- Tabelas
- HTML Embutido
- Créditos
Inicialmente temos os 'Headings', ou Títulos, que é semelhante à linguagem de marcação HTML. Existe uma herança de títulos, em que diferem não só o tamanho da fonte, como também semânticamente. Ou seja, o título número 1 é mais importante que o título número 2, que por sua vez é mais importante que o número 3, e assim por diante.
Existem 6 títulos, que vai do título 1 (mais importante e por conseguinte maior e mais destacado) até o título 6 (menos importante e por conseguinte menor e menos destacado).
A sintaxe é simples:
# Título 1
## Título 2
### Título 3
#### Título 4
##### Título 5
###### Título 6
Vai de acordo com a quantidade de '#'. Exemplos:
Você pode adicionar ênfase ao seu texto, como por exemplo o negrito, o itálico, ou até mesmo negrito e itálico. Lembre-se que além da aparência do seu texto, existe a semântica para ser seguida. Textos em negrito devem ser lidos com força, intensidade, e o itálico significa uma ênfase maior.
Sintaxe do negrito:
Este é **negrito**
This is __strong__
Sintaxe do itálico:
Este é *itálico*
This is _italic_
Sintaxe do negrito e itálico:
**_strong and em_**
Sintaxe do texto riscado:
~~riscado~~
Você pode adicionar linhas horizontais para deixar o texto mais organizado e apresentável. Usando três hífens, três asteriscos ou três underscore:
Hífens
---
Asteriscos
***
Underscore
___
Learning Center:
Hífens
Asteriscos
Underscore
Para criar uma citação em bloco, adicione um '>' na frente de um parágrafo.
As citações em bloco podem conter vários parágrafos. Adicione um '>' nas linhas em branco entre os parágrafos
Sintaxe:
Para citações em uma linha:
> Esta é uma citação
Em várias linhas:
> Citação 1
>
> Citação 2
Resultado:
Para citações em uma linha:
Esta é uma citação
Em várias linhas:
Citação 1
Citação 2
As cotações em bloco podem ser aninhadas. Adicione um '>>' na frente do parágrafo que você deseja aninhar. Por exemplo:
> Citação 1
>
>> Citação 2
E assim temos:
Citação 1
Citação 2
As citações de bloco podem conter outros elementos no formato Markdown. Nem todos os elementos podem ser usados, você precisará experimentar para ver quais funcionam. Exemplo:
> ##### The quarterly results look great!
>
> - Revenue was off the chart.
> - Profits were higher than ever.
>
> *Everything* is going **well**.
Resultado:
- Revenue was off the chart.
- Profits were higher than ever.
Everything is going well.
Você pode organizar listas, podendo ser ordenadas ou não.
Listas Ordenadas
Usando (número)(ponto) você pode ordenar as listas numericamente, como por exemplo:
1. Primeiro
2. Segundo
3. Terceiro
4. Quarto
Vai gerar o seguinte resultado:
- Primeiro
- Segundo
- Terceiro
- Quarto
Itens da lista de aninhamento
Para aninhar itens de linha em uma lista ordenada, recue os itens quatro espaços ou uma guia.
1. Primeiro item
2. Segundo item
3. Terceiro item
1. Indentado item
2. Indentado item
4. Quarto item
Irá gerar:
- Primeiro item
- Segundo item
- Terceiro item
- Indentado item
- Indentado item
- Quarto item
Listas não Ordenadas
Para criar uma lista não ordenada, adicione traços (-), asteriscos (*) ou sinais de adição (+) na frente de itens de linha.
- Exemplo 1
* Exemplo 2
+ Exemplo 3
Vai gerar:
- Exemplo 1
- Exemplo 2
- Exemplo 3
Lista de tarefas
Podemos criar também uma lista de tarefas, com a CheckBox preenchida ou não. Vejamos o exemplo:
- [ ] Esta é uma CheckBox não marcada
- [x] Esta é uma CheckBox marcada
Learning Center:
- Esta é uma CheckBox não marcada
- Esta é uma CheckBox marcada
Para colocar algum código sem que ele esteja formatado, então poderá colocar algum código em Markdown dentro dos trechos de códigos e ele não será formatado, será mostrado exatamento como escreveu, é desse jeito que eu consigo mostrar para vocês os códigos como são originalmente antes de serem formatados em .md.
Temos o trecho simples, sendo de apenas uma linha, usando uma crase para abrir e outra para fechar:
` este é um exemplo `
Resultado:
este é um exemplo
E também temos a mais completa, que podemos colocar quantas linhas de códigos nós quisermos. Use três crases ( ´´´ ) ou três tils ( ~~~ ) para abrir e três para fechar, desse jeito:
```
Este é nosso
Querido Exemplo
**Teste**
Nota que não irá formatar o negrito!
```
Vai gerar:
Este é nosso
Querido Exemplo
**Teste**
Nota que não irá formatar o negrito!
Para especificar qual lingugem seu código é feito, isso ajuda tanto semânticamente como também na coloração do código, basta adicionar o nome da lingugem logo após os três primeiros tils ou crases. Por exemplo:
~~~python
s = "Sintaxe do Pythong"
print s
~~~
s = "Sintaxe do Python"
print sPara saber quais lingugens são suportadas por este mecanismo, clique aqui e veja a listagem do Pygments.
Nota: Para interligar um código dentro do outro, assim como eu fiz de exemplo para vocês: Abra o primeiro trecho de código com as três crases, e feche de imediato. Dentro desse código use a indentação de 4 espaços, e assim poderá abrir outro código sem formatar.
É possível colocar algum link em seu 'Readme', e ainda colocá-lo por debaixo de uma palavra, é o chamado link-âncora, acessando-o ao clicar na palavra. Entre colchetes [ ] a palava que deseja por debaixo dos panos. E entre parentêses ( ) o link para acesso. Vejamos o exemplo do código:
Clique [aqui](https://github.com) para acessar à página do GitHub.
Resultado: Clique aqui para acessar à página do GitHub.
Lembre-se que pode criar links para outros repositórios seus no GitHub, também é possível acessar outro arquivo no mesmo repositório, e até mesmo a posição da página do leitor no mesmo arquivo. Por exemplo, clique aqui para acessar o título 'Sintaxe' neste mesmo arquivo. Tais possibilidades deixam seu README bem mais apresentável, e com uma interatividade maior, demonstrando que o escritor do código entende bem de MarkDown.
Para links sem uma palavra por cima do link, use '< >' para envolver o link desejado, assim o link aparecerá por inteiro ao leitor. Exemplo: https://google.com.br
Semelhante ao mecanismo de adicionar links-âncora, podemos adicionar imagens para nosso aquivos.md também, mas tome cuidado com a resolução da imagem, imagens grandes podem estar em linhas individuais, para serem exibidas em maior tamanho.
A sintaxe é parecida, apenas adicione uma exclamação (!) no início.
Você pode fazer com que uma imagem carregue um link por debaixo dos panos, e ao clicar nela, acesse o link. É uma mescla tanto semânticamente quanto na sintaxe. Vejamos:
Clique na imagem para acessar o Google.
[
Clique na imagem para acessar o Google.
Escolha os títulos das colunas e use | para delimitar as colunas. Depois, utilize hífen - na segunda linha para indicar que acima estão os títulos das colunas, usando novamente o | para delimitar colunas. Veja um exemplo abaixo:
Teste | Exemplo
------- | ------
Teste 1 | Exemplo 1
Teste 2 | Exemplo 2
Teste 3 | Exemplo 3
Teste 4 | Exemplo 4
No Learning Center irá aparecer:
| Teste | Exemplo |
|---|---|
| Teste 1 | Exemplo 1 |
| Teste 2 | Exemplo 2 |
| Teste 3 | Exemplo 3 |
| Teste 4 | Exemplo 4 |
Para especificar o tipo de alinhamento que deseja ter nas tabelas, utilize dois pontos : ao lado do campo horizontal de hífens ---, na segunda linha da sua tabela. Veja abaixo:
- Alinhado a esquerda: usar
:no lado esquerdo (alinhamento padrão) - Alinhado a direita: usar
:no lado direito - Centralizado: usar
:dos dois lados
Exemplo:
Alinhado a esquerda | Centralizado | Alinhado a direita
:--------- | :------: | -------:
Exemplo | Exemplo | Exemplo
Learning Center:
| Alinhado a esquerda | Centralizado | Alinhado a direita |
|---|---|---|
| Exemplo | Exemplo | Exemplo |
Você também pode usar HTML bruto no seu Markdown, e geralmente funcionará muito bem.
Vejamos:
<dl>
<dt>Lista definitiva</dt>
<dd>É algo que as pessoas usam às vezes.</dd>
<dt>Markdown no HTML</dt>
<dd>*Não* funciona **muito bem**. Use as <em>tags</em> do HTML</dd>
</dl>
- Lista definitiva
- É algo que as pessoas usam às vezes.
- Markdown no HTML
- *Não* funciona **muito bem**. Use as tags do HTML
O MarkDown também permite colocar alguns emojis em seus textos, não abuse deles para não parecer um circo de diversões, só em alguns casos bem específicos.
:nome_do_emoji:
Alguns exemplos:
:smile: :fire: :file_folder: :space_invader: :computer:
😄 🔥 📁 👾 💻
Para conferir uma lista com os emojis e suas sintaxes, clique aqui: EMOJIS
Copyright (C) 2020 by Gustavo Mendel