Introdução ao Markdown¶

Notebooks, como o Jupyter Notebook, permitem a inclusão de células em Markdown, possibilitando que os usuários adicionem texto formatado, explicações, títulos e outros elementos de documentação diretamente ao lado do código. Isso facilita a criação de documentos interativos e bem estruturados, combinando código executável com descrições detalhadas e visualizações.

A linguagem Markdown, desenvolvida por John Gruber e Aaron Swartz, é amplamente utilizada nesses notebooks devido à sua simplicidade e eficiência. Projetada para converter texto em HTML (HyperText Markup Language), ela permite que os usuários formatem conteúdos de maneira intuitiva, tornando a documentação mais clara e acessível.

Curiosidade:

A linguagem Markdown foi desenvolvida por Aaron Swartz, um os fundadores do Reddit. Ela é amplamente utilizada em foruns, blogs, páginas web, aplicativos como Slack, aplicativos de notação como Obsidian e na escrita de documentos.

Tarefa:

Todo o texto deste Notebook está escrito em Markdown. Clique duas vezes sobre o texto e verá o código em Markdown.

Título¶

Inicialmente temos os Headings, ou Títulos.

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

Em resumo, vai de acordo com a quantidade de #.

Comentários¶

Comentários são parte de códigos que não aparecem no trecho final.

<!--Esta frase não vai aparecer pois é um comentário.-->

Esta frase vai aparecer, pois não é um comentário.

Resulta em:

Esta frase vai aparecer, pois não é um comentário.

Observe que a parte do texto que estava entre <!-- e --> não aparece no seu texto final, pois é um comentário. Somente a frase de baixo, que não é um comentário, aparece.

Comentários multi-linha¶

Podemos escrever comentários em mais de uma linha. utilizando entre o comentário os delimitadores <!--- e -->:

<!---  
Este é um comentário multi-linha.
Portanto eu posso pular uma linha e continuar escrevendo o comentário.
-->
Esta frase vai aparecer, pois não é um comentário.

Resulta em:

Esta frase vai aparecer, pois não é um comentário.

Curiosidade:

A notação de comentário apresentada é uma notação da linguagem de marcação de texto HTML. Utilizamos a notação em HTML sempre que queremos fazer algo que não é possível no Markdown nativamente.

Quebra linha¶

Para quebrar uma linha em Markdown devemos utilizar dois espaços no final da frase. Podemos utilizar, também, um espaçamento de uma linha entre uma frase e outra.

Tarefa:

<!--- 
Vamos tentar escrever duas palavras embaixo da outra sem nada adicional:
-->
Arroz
Feijão

<!--- 
Por fim, vamos utilizar o primeiro exemplo. Porém vamos adicionar dois spaços depois de "Arroz", resultando em "Arroz  "
-->
Arroz  
Feijão
​```

Novo parágrafo¶

Para criar um novo parágrafo é simples, basta adicionar mais de um quebra linha entre duas frase. Veja o exemplo:

Estou criando o primeiro parágrafo para o meu texto.

Agora vou criar mais um parágrafo para o meu texto.

Resulta em:

Estou criando o primeiro parágrafo para o meu texto.

Agora vou criar mais um parágrafo para o meu texto.

Tarefa: Tente reproduzir a sentença abaixo:

Animais que começam com "i":

Índio

Igreja

Ira

Ênfase¶

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.

Negrito¶

Sintaxe do negrito:

Este é **Negrito**
Este também é __negrito__

Resulta em:

Este é Negrito
Este também é negrito

Em resumo, envolve-se o termo por dois asteriscos (**) ou por dois underlines (__).

Tarefa: Tentando escrever as frases em Markdown:

O rato roeu a roupa do rei de roma.
Eu gosto de pizza

Dica:

Lembre-se de usar o quebra linha (Dois espaços).

Itálico¶

Sintaxe de itálico:

Este é *itálico*
Este também é _itálico_

Resulta em:

Este é itálico
Este também é itálico

Isto é, envolve-se o termo por um asterisco (*) ou um underline (_).

Tarefa:

Normalmente colocamos palavras estrangeiras em itálico. Coloque a palavra software em itálico.

Engenharia de software é uma profissão que tem crescido na última década.

Negrito e itálico¶

Podemos combinar a notação de negrito e itálico:

Está em _**negrito e itálico**_
Isto também está em *__negrito e itálico__*

Tarefa:

Coloque todo texto em negrito e a palavra software em itálico.

Engenharia de software é uma profissão que tem crescido na última década.

Linha divisória¶

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

___

Código¶

Código em linha¶

Podemos escrever um trecho de código em uma frase utilizando o caractere crase.

Para imprimir "Olá mundo!" em python utilizamos o "comando" `print("Olá mundo")`.

Resulta em:

Para imprimir "Olá mundo!" em python utilizamos o "comando" print("Olá mundo").

Observe que o comando "print("Olá mundo")" é apresentado em um fundo diferente, indicando que é um código.

Tarefa:

Reproduza a frase abaixo:

"Um triângulo é formados por 3 lados, os lados a, b e c."

Código multi-linha¶

Podemos criar um código que funciona em mais de uma linha. Para isso vamos utilizar a seguinte notação

Fizemos acima um código genérico. Se quisermos especificar a linguagem de programação devemos usar:

```linguagem
Aqui vai mostrar o código no modo texto
​```

Por exemplo, se considerarmos a linguagem Markdown:

```markdown
<!---
Isto aqui é um comentário multi-linha.
E esta é a segunda linha do comentário
-->  
Se eu executar esta célula o comando de **negrito** irá aparecer. 
​```

Tarefa:

Agora tente criar um bloco de código no Markdown com a linguagem Python:

# Este código será apresentado na forma de texto, em Markdown
ling = "python"

if ling != "python":
    print("Não é uma boa linguagem.")
else:
    print("Melhor linguagem.")

Código multi-linha sem ênfase¶

A especificação da linguagem permite realçar algumas notações de sintaxe da linguagem, facilitando a visualização no seu texto final. Porém é possível criar um bloco de código multi-linha sem realçe. Para isso basta não colocar não colocar o nome da linguagem. Como mostra abaixo:

# Este código será apresentado na forma de texto, em Markdown
ling = "python"

if ling != "python":
 print("Não é uma boa linguagem.")
else:
 print("Melhor linguagem.")

Citações¶

Podemos escrever citações ao utilizar o sinal de maior (>). Veja como:

> Agir, eis a inteligência verdadeira. 
> Serei o que quiser. Mas tenho que querer o que for. 
> O êxito está em ter êxito, e não em ter condições de êxito. 
> Condições de palácio tem qualquer terra larga, 
> mas onde estará o palácio se não o fizerem ali?

Resulta em:

Agir, eis a inteligência verdadeira.
Serei o que quiser. Mas tenho que querer o que for.
O êxito está em ter êxito, e não em ter condições de êxito.
Condições de palácio tem qualquer terra larga,
mas onde estará o palácio se não o fizerem ali?

Tarefa:

Reproduza a seguinte frase dentro de uma citação:

Água mole pedra dura tanto bate até que fura

Listas¶

Listas não ordenada¶

Para trabalhar com listas não ordenadas podemos utilizar o sinal - ou + antes da frase:

- item 1
- item 2
- item 3

Resulta em:

• item 1
• item 2
• item 3

Ou ainda:

+ item 1
+ item 2
+ item 3

Tarefa:

Faça uma lista de compras de supermercado.

Lista ordenada¶

Veja como faz uma lista ordenada:

**Lista ordenada:**
1. Elemento 1
2. Elemento 2
3. Elemento 3

Resulta em:

Lista ordenada:

1. Elemento 1
2. Elemento 2
3. Elemento 3

Tarefa:

Crie uma lista ordenada, considerando a numeração como ordem de prioridade.

Dica:

Músicas favoritas, filmes favoritos, série favoritos, linguagens de programação favoritas, etc

Lista dentro de lista¶

Podemos criar uma lista dentro de uma lista adicionando uma endentação, como mostra abaixo:

1. item 1
   - item 1.1
   - item 1.2
   - item 1.3
2. item 2
   - item 2.1
   - item 2.2
   - item 3.3
3. item 3

Resulta em:

1. item 1

• item 1.1
• item 1.2
• item 1.3

2. item 2

• item 2.1
• item 2.2
• item 3.3

3. item 3

Tarefa:

Abaixo tem uma receita de bolo. Tente reproduzir em Markdown o exemplo abaixo:

1. Ingredientes:
   • Ovo
   • Farinha de trigo
   • Leite
   • Fermento
2. Modo de preparo:
   • Bata no liquidificador o leite com o ovo
   • Jogue a farinha de trigo na mistura
   • Bote para assar

Criando um cabeçalho¶

Utilizando todos os conhecimentos que você aprendeu em Markdown crie um cabeçalho na primeira célula, logo após título principal.

Dica:

Clique na primeira célula, entre no modo de comando e aperte A de Above.

Agora crie o seu cabeçalho.

Dica:

Não se esqueça dos dois espaços para quebrar a linha.

O meu ficou assim:

---
__Nome do(a) aluno(a)__: Lucas Lima  
__Instituição__: UFAC  
---

Dicas: Se você conhece, você pode usar em HTML e CSS para deixar o seu texto ainda mais rico. Mais informações aqui. Evite usar muitos títulos no seu cabeçalho (#, ##, etc) no seu cabeçalho pois isso pode atrapalhar na geração de índice ao exportar seu Notebook para pdf, LaTeX ou HTML.

Ah, não se esqueça de criar os títulos e cabeçalhos das próximas atividades 😉