III Semana de História do campus dos Malês, IHLM/UNILAB

Uma introdução ao Markdown e suas possibilidades no ensino e divulgação científica

Prof. Eric Brasil


Markdown é uma sintaxe baseada em texto simples para formatação de documentos. Possui muitas opções interessantes para produção de materiais didáticos, apresentações entre outros.


Índice

Ementa

O que é a sintaxe Markdown. Estrutura básica: cabeçalhos, parágrafos, tabelas, imagens, gifs, links, códigos, listas, html. Editores de markdown. "Sabores" e temas. Exportando e colocando online.


Esse minicurso é inspirado e utiliza como base a lição Introdução ao Markdown, de Sarah Simpkin, publicada no ProgrammingHistorian e traduzida para o português por João Gilberto Saraiva


Vamos começar!

gato


A Sintaxe

A sintaxe Markdown foi criada em 2004 e é um modo de formatar arquivos de textos simples, utilizando algumas marcações com símbolos como #, *, []() etc.

Esses arquivos são salvos com a extensão .md e podem ser abertos com editores de texto simples, como Gedit, Notepad, etc. Assim, podem ser abertos em diferentes sistemas operacionais.

Além disso, muitas plataformas de publicação e sites aceitam arquivos arquivos .md, muitas vezes renderizando o arquivo automaticamente para HTML.

Atualmente, existem inúmeros programas gratuitos e de código aberto para edição de Markdown, possibiltando a configuração de muitos recursos, temas (ou "flavours") e opções de exportação (seja em html, pdf, doc, etc).


Pq usar Markdown para suas aulas e apresentações?

ppt


Estrutura báscia

Vamos agora entender a estrutura básica de um arquivo em .md.


Cabeçalhos


Renderiza como:

Primeiro nível de cabeçalho

Segundo nível de cabeçalho

Terceiro nível de cabeçalho

Quarto nível de cabeçalho


Parágrafos e Quebras de linha

Os parágrafos devem ser separados por uma linha vazia.

Por exemplo:

Isso renderiza assim:

Vamos aprender markdown?

Para separar parágrafos precisamos inserir um linha em branco para criar um parágrafo.


Ênfases

Para colocar um texto em itálico é só colocá-lo entre * ou _ e em negrito entre ** ou __.

A III Semana de História do campus dos Malês será um sucesso.


Blocos de citação

Para inserir um bloco de destaque para uma citação é só incluir > no início do parágrafo:

Eu sou uma citação bonita de um texto qualquer.


Tabelas

É possível inserir tabelas separando as colunas com | e hífens para demarcar a linha de títulos.

Por exemplo:


Isso é renderizado como:

Coluna 1Coluna 2Coluna 3
Linha 1, coluna 1Linha 1, coluna 2Linha 1, coluna 3
Linha 2, coluna 1Linha 2, coluna 2Linha 2, coluna 3
Linha 3, coluna 1Linha 3, coluna 2Linha 3, coluna 3

É possível definir o alinhamento da coluna incluíndo : na linha do cabeçalho:


Alinhado à esquerdaCentralizadoAlinhado à direita
MaçãsVermelho5000
BananasAmarelo75

Linhas horizontais

Para separar seu documento e criar quebra de sessões, é possível inserir linhas horizontais utilizando --- ou ***


Imagens e gifs

Para inserir imagen basta escrever o seguinte:


Imagem com caminho em meu computador:

unilab


Imagem com url:

logo hist

OBS: Se vc pretende configurar mais elementos de sua imagem, como tamanho, alinhamento, legenda, será preciso utilizar html. Veremos algumas dicas assim abaixo.


Acrescentar links no documento é bem simples e segue padrão similar à inserção de imagens. Basta colocar o texto entre colchetes e o link entre parênteses na sequência []():

[Introdução ao Markdown](https://programminghistorian.org/pt/licoes/introducao-ao-markdown)

Isso renderiza assim:

Introdução ao Markdown


Códigos

É possível escrever blocos de código utilizando três acentos graves para abrir e fechar bloco:


Ou ainda, escrever o código em linha usando um acento grave abrindo e fechando

sudo apt install pandoc


Listas

É possível incluir listas ordenadas e não ordenadas

A lista ordenada é criada inserindo - ou * no início de cada linha.


Renderiza como:


Listas ordenadas são criadas numerando cada linha e colocando um . após cada número:


Renderiza como:

Lista ordenada

  1. od

  2. od

    1. od
  3. od

  4. od


HTML

O Markdown possui limitações e ainda não é um formato amplamente aceito no meio acadêmico. Muitos recursos de editores de texto como Word, LibreOffice não estão disponíveis em Markdown.

Entretanto, é possível inserir mais opções utilizando um pouco de html em seu documento.


Ex 1: Tamanho de uma imagem

seriously


seriously


Ex 2: Alinhamento da imagem

seriously


seriously


Editores de markdown

Escrever o texto direto num editor de texto simples, sem visualizar o resultado final instantaneamente, pode ser um desafio no início.

Entretanto, exixtem vários editores de markdown que facilitam muito sua vida e ainda possuem vários "sabores" [flavours] ou temas para trabalhar.


Apps

On-line


Avançado

Exportando e colocando online.

Slides, blogs e livros

PDF e artigos científicos

Deploy


Contatos

  1. E-mails

  2. Twitter: @ericbrasiln

  3. Instagram: ericbrasiln

  4. Site pessoal: ericbrasiln.github.io

  5. Github: ericbrasiln

  6. Lattes

  7. Orcid

  8. ResearchGate

  9. Academia.edu

  10. YouTube


Agradecimentos

Obrigado pela paciência e participação.

baby yoda

Viva o Sus!