Markdown – O que é e Como Funciona?

Hoje eu quero falar sobre o que é markdown e como utilizar essa linguagem de marcação para te auxiliar na formatação de textos!

Markdown é uma linguagem de marcação leve: você formata o texto com sinais simples, como # para título e asteriscos para negrito e itálico, no lugar das tags do HTML. É o padrão dos arquivos .md, dos READMEs do GitHub e das células de texto do Jupyter, usadas para documentar código.

Caso prefira esse conteúdo no formato de vídeo-aula, assista ao vídeo abaixo ou acesse o nosso canal do YouTube!

O que você aprende neste vídeo

Resposta rápida: A aula mostra o Markdown em três lugares: a cheat sheet do Markdown Guide, uma célula do Jupyter trocada de código para Markdown e o README.md da biblioteca Requests no GitHub. Você sai sabendo escrever títulos com #, negrito com ** e listas, e documentar o próprio portfólio; o Markdown complementa o HTML, não o substitui.

Neste vídeo (8 min):

• 0:36 - O site oficial do Markdown Guide e a definição de linguagem de marcação: sinais aplicados ao texto para formatá-lo
• 1:01 - Markdown formata texto de forma mais simples que o HTML e funciona como complemento, não como substituto
• 1:37 - A cheat sheet do site: cabeçalhos com #, ## e ### viram títulos H1, H2 e H3
• 2:11 - Negrito com o texto entre **, itálico com um * e lista ordenada numerada
• 2:30 - No Jupyter, trocar o tipo da célula de código para Markdown e escrever o título # Meu arquivo Markdown
• 3:04 - Rodar a célula exibe o texto formatado; duplo clique nela volta ao código Markdown
• 3:19 - Lista ordenada com item 1, item 2 e item 3 e um subtítulo em tamanho menor que o título
• 4:10 - O mesmo título em HTML pede <h1>Meu arquivo Markdown</h1>, com abertura e fechamento de tag
• 4:47 - Exemplo real: o README da biblioteca Requests, uma das mais usadas do Python, no GitHub
• 5:40 - A extensão .md do README.md indica Markdown, e o código-fonte mostra o # do título e os ** do negrito
• 6:40 - Recomendação: documentar os projetos do portfólio no GitHub com um README escrito em Markdown

Trechos do vídeo:

• Markdown é uma linguagem de marcação: um conjunto de sinais escritos no próprio texto, como # para título e ** para negrito, que definem como ele será exibido
• O Markdown não substitui o HTML: ele serve para escrever e formatar texto com muito menos trabalho do que abrir e fechar tags
• No Jupyter, uma célula do tipo Markdown é tratada como texto formatado e não como código Python, o que permite explicar o notebook entre as células de programa
• Arquivos com extensão .md são escritos em Markdown, e é nesse formato que o README de quase todo projeto no GitHub explica o que o código faz e como usá-lo
• Um README bem formatado ajuda quem visita um portfólio no GitHub a entender rapidamente o que cada projeto resolve

Python Impressionador

Você vai aprender a linguagem de Programação que mais cresce no Mundo para fazer automações incríveis, desenvolver sites, fazer análises de dados, trabalhar com Ciência de Dados, Inteligência Artificial, mesmo que você nunca tenha tido nenhum contato com Programação na vida.

Começar agora

O que é Markdown

Você sabe como funciona o markdown? Já ouviu falar nisso? Sabe onde usar o markdown?

Nessa aula eu vou te mostrar o que é isso, como usar e onde usar essa linguagem de marcação para facilitar a formatação dos seus textos!

Markdown para Formatação de Textos

O markdown nada mais é do que um conjunto de sinais para texto, mas como assim?

É uma ferramenta para construir textos, ou seja, vamos utilizá-la para formatações em textos.

Você já deve ter visto que na parte visual do site (frontend) ou para algumas visualizações, nós normalmente utilizamos o HTML, só que essa linguagem acaba sendo mais complexa e mais demorada para a formatação.

Já com o markdown essas formatações ficam mais fáceis, então é algo bem mais intuitivo, claro que isso não vai substituir o HTML para essas formatações.

Então o markdown é uma linguagem de marcação, um conjunto de sinais para formatação de textos.

Na documentação do próprio markdown, você pode verificar quais são os comandos para criar títulos, colocar texto em negrito, itálico, criar uma lista, entre outros comandos.

https://www.markdownguide.org/cheat-sheet/

Aqui nós temos a sintaxe básica para essas formatações, mas ainda temos algumas outras.

Você já percebe que para inserir um título H1 basta colocar # antes do seu texto, algo que dentro do HTML você precisaria inserir <h1> seu texto </h1>.

Dentro do Jupyter, que é um dos editores de Python que nós utilizamos aqui na Hashtag Treinamentos, nós temos como inserir textos dentro da parte de código até para facilitar a visualização.

Nas aulas nós fazemos isso para deixar tudo mais explicado e mais intuitivo, e dentro dessa opção que já é chamada de Markdown, nós já podemos utilizar esses códigos.

Aqui estamos colocando um título (H1), um subtítulo (H2) e uma lista de itens. Veja que é algo bem simples de formatar.

Aqui já temos o resultado de como fica essa formatação. É claro que você pode olhar na documentação para verificar qual o código de uma formatação específica que queira fazer, mas é uma maneira mais fácil de formatar o seu texto.

Um exemplo prático onde você pode visualizar isso é dentro do GitHub. Nesse exemplo estamos visualizando o arquivo README da biblioteca requests.

Se você clicar em Raw, você vai conseguir visualizar o arquivo como ele é no formato de markdown, por isso o arquivo tem a extensão .md.

Aqui você já consegue visualizar alguns desses códigos de markdown sendo aplicados para formatação do texto de uma forma mais fácil.

Dessa forma a explicação do texto fica muito melhor e mais fácil de entender, até porque fica muito mais detalhado.

Perguntas frequentes

Conclusão

Nessa aula eu te mostrei o que é markdown, como ele funciona e onde você pode utilizar essa linguagem de marcação.

Ela é muito interessante e acaba sendo muito mais fácil de utilizar do que o HTML por exemplo, que tem estruturas mais complexas.

Agora quando for criar seus projetos já pode utilizar essa linguagem de marcação para formatar seus textos!

Hashtag Treinamentos

Para acessar outras publicações de Python, clique aqui!