Uma introdução ao Markdown

Markdown

Markdown é uma ferramenta de conversão de texto em HTML. Hoje se tornou o sinônimo de fato para uma classe de linguagens de descrição de marcação leves. Ele usa uma sintaxe de formatação de texto simples. A ideia por trás do Markdown era tornar a escrita de páginas da web e, especialmente, entradas de blog tão fácil quanto escrever um e-mail. Na época de novembro de 2017, a meta foi alcançada e o Markdown, bem como suas derivações Asciidoc, Asciidoctor e Asciidoctor-pdf estão amplamente em uso.

Markdown se concentra apenas em texto simples e se abstém de todas as outras complexidades encontradas em HTML. É fácil de aprender porque é simples, portanto também mais rápido, pois o mínimo de caracteres são usados, o que também leva a menos chances de erro no final. Veja a figura 1 para um documento básico mostrado no editor Markdown Stackedit. No lado esquerdo você vê o código-fonte e no lado direito a saída HTML correspondente. Você pode notar que os títulos são simplesmente marcados com um número de # de acordo com o nível de hierarquia do título.

Conversão de Texto

O texto simples é conversível para XHTML (HTML) e muitos outros formatos usando as ferramentas de linha de comando como Markdown ou Pandoc. Basicamente, ambas as ferramentas criam apenas fragmentos HTML e gravam a saída em stdout. O Pandoc oferece a opção “-o nome do arquivo” para gravar a saída HTML no arquivo fornecido. Como visto abaixo, o arquivo de saída é denominado básico.html e contém o fragmento HTML - dois títulos e um parágrafo.

$ pandoc -o basic.html básico.md $ cat basic.html 
Como fazer para criação de pacotes Debian
 
Prefácio
 Ser responsável por uma máquina significa cuidar do hardware, bem como dos componentes de software. Como visto na vida cotidiana como um administrador de sistema, é muito melhor instalar o software como um pacote de software ao invés de um monte de arquivos fonte. Isso reduz os custos de manutenção adequada do sistema. $ 

Para criar documentos HTML autônomos com um cabeçalho HTML completo, o Pandoc aceita a opção “-s” da seguinte maneira:

$ pandoc -o basic.html -s basic.md $ cat basic.html           
Como fazer para criação de pacotes Debian
 
Prefácio
 Ser responsável por uma máquina significa cuidar do hardware, bem como dos componentes de software. Como visto na vida cotidiana como um administrador de sistema, é muito melhor instalar o software como um pacote de software ao invés de um monte de arquivos fonte. Isso reduz os custos de manutenção adequada do sistema.   

A vantagem de manter o conteúdo separado de sua exibição visual é que isso não atrapalhará a aparência de seu site. Versão 1.0.1, que foi desenvolvido por John Gruber e Aaron Swartz foi lançado em dezembro de 2004 e está disponível como software livre (veja os links no final deste artigo).

Elementos de texto

Manchetes

De acordo com o nível HTML correspondente, os títulos são escritos com um número de # da seguinte maneira:

# H1 ## H2 ### H3 #### H4 ##### H5 ####### H6 

Para H1 e H2 duas formas alternativas de escrita são aceitas:

H1 == H2 -- 

Observe que o número de sinais de igual ou travessões deve corresponder ao número de caracteres do título.

Enfatizando o Texto

Para enfatizar o texto, esses elementos são suportados:

• itálico: asteriscos simples ou sublinhados simples
  --
  * importante * e _também importante_
  --
• texto em negrito: asteriscos duplos ou sublinhados duplos
  --
  ** importante ** e __também importante__
  --
• texto riscado: til duplo
  --
  ~~ texto ~~
  --

Listas

Markdown suporta listas não ordenadas e ordenadas. Listas ordenadas começam com um asterisco, um sinal de mais ou menos. Listas ordenadas apenas começam com um dígito. Para criar sublistas, recue o item de lista em dois espaços (Markdown, StackEdit) ou quatro espaços (Pandoc) como você vê abaixo:

1. frutas * maçã * banana 2. bebidas + água + leite 

Imagens

A maneira mais fácil é usar o estilo embutido da seguinte maneira:

![O logotipo do Debian] (debian-logo.png “Logo Debian”) 

Isso exibe a imagem referenciada. Assim que você mover o ponteiro do mouse sobre a imagem, você verá o texto de descrição correspondente.

Destaque de código e sintaxe

Existem duas variantes - código embutido e blocos de código. O código embutido é enquadrado em três crases como “'print (“ Olá, mundo!”)“ '. Os blocos de código também começam e terminam com três crases, mas em linhas separadas da seguinte maneira:

"print (“ Olá, mundo!”)"

Markdown não suporta realce de sintaxe, mas dialetos como Markdown Aqui,.

Mesas

Markdown não suporta tabelas, mas extensões como GFM e Markdown Aqui,.

Citações em bloco

Blockquotes apenas começam com um sinal “>”. É muito útil citar texto.

> "Oh! é absurdo ter uma regra rígida sobre o que se deve ler e o que não se deve. Mais da metade da cultura moderna depende do que não se deve ler.">> A importância de ser zeloso. (Oscar Wilde) 

Links

Os links referem-se a outros documentos ou seções do atual. O estilo de escrita é semelhante às imagens e consiste na descrição do link entre colchetes e o URL entre colchetes regulares.

[Sou um link de estilo embutido] (https: // linuxhint.com) 

Além disso, você pode adicionar um texto alternativo:

[Sou um link de estilo embutido com texto adicional] (https: // linuxhint.com “LinuxHint”) 

Os links podem ser referenciados da seguinte forma:

[LinuxHint] [1] ... algum texto ... [1]: https: // linuxhint.com 

Isso permite que você crie facilmente listas de referências no final do seu documento, pois é comum em documentos científicos.

Conclusão

Markdown é muito simples e obrigatório para todos que fazem documentação e publicam conteúdo regularmente. É um grande prazer usá-lo.

Referências

• StackEdit, https: // stackedit.io / editor
• Pandoc, http: // pandoc.org /
• Markdown, https: // daringfireball.net / projects / markdown /
• Cheatsheet de Markdown, https: // github.com / adam-p / markdown-here / wiki / Markdown-Cheatsheet