menu

Introdução

Uma visão geral do Markdown, como ele funciona e o que você pode fazer com ele.

O que é o Markdown?

Markdown é uma linguagem de marcação leve que você pode usar para adicionar elementos de formatação a documentos de texto. Criado por John Gruber em 2004, o Markdown agora é uma das linguagens de marcação mais populares do mundo.

O uso do Markdown é diferente do uso de um editor WYSIWYG. Em um aplicativo como o Microsoft Word, você clica nos botões para formatar palavras e frases, e as alterações são visíveis imediatamente. Markdown não é assim. Ao criar um arquivo em Markdown, você adiciona a sintaxe da linguagem ao texto para indicar quais palavras e frases devem ser formatadas.

Por exemplo, para indicar um cabeçalho, você adiciona um sinal de número antes dele (# Título Um). Ou, para enfatizar uma frase com negrito, adicione dois asteriscos antes e depois do conteúdo (**este texto está em negrito**). Pode demorar um pouco para se acostumar com a sintaxe Markdown, especialmente se você sempre usou aplicativos WYSIWYG. A captura de tela abaixo mostra um arquivo Markdown exibido no editor de texto Atom.

Você pode formatar um arquivo em Markdown usando qualquer editor de texto simples. Ou você pode usar um dos muitos, digo, muitos aplicativos Markdown para os sistemas operacionais macOS, Windows, Linux, iOS e Android. Existem também várias ferramentas baseadas na Web projetadas especificamente para formatar texto usando a sintaxe do Markdown.

Alguns editor de Markdown possuem um recurso que converte em tempo real as formatações do Markdown enquanto você digita, porém, mesmo que isso não aconteça, o documento ainda é extremamente legível, já que o MD foi projetado justamente pensando nisso.

Nas palavras do criador:

O objetivo principal da sintaxe de formatação do Markdown é torná-lo o mais legível possível. A idéia é que um documento no formato Markdown seja publicável como está, sem parecer que foi marcado com tags ou instruções de formatação.

Por que usar o Markdown?

Você pode estar se perguntando por que as pessoas usam o Markdown em vez de um editor WYSIWYG (What You See Is What You Get). Por que escrever com o Markdown quando você pode pressionar botões em uma interface para formatar seu texto? Bom, existem algumas razões pelas quais as pessoas usam o Markdown em vez dos editores que oferecem formatação rich-text.

  • Markdown pode ser usado para tudo. Você pode criar sites, documentos, notas, livros, apresentações, mensagens de e-mail e documentação técnica, etc.
  • Markdown é portátil. Arquivos que contêm texto no formato Markdown que podem ser abertos usando praticamente qualquer aplicativo. Se você não gostar de um app, basta importar seus arquivos para outro. Isso contrasta fortemente com editores de processamento de texto como o Microsoft Word que bloqueiam seu conteúdo em um formato de arquivo proprietário.
  • O Markdown é independente de plataforma. Você pode criar texto no formato Markdown em qualquer dispositivo executando qualquer sistema operacional.
  • Markdown é um formato independente. Mesmo que o seu editor pare de funcionar, você ainda poderá ler o texto no formato MD usando um programa de edição qualquer. Isso é algo a se considerar quando falamos sobre livros, teses universitárias e outros documentos importantes que precisam ser preservados indefinidamente.
  • Markdown está em todo lugar. Sites como o Reddit e o GitHub suportam o Markdown, inúmeros aplicativos, seja ele para web ou desktop, também são compatíveis com o Markdown.

Pegando no tranco

A melhor maneira de aprender Markdown é praticando. Na era da internet, isso é mais fácil do que nunca, graças a uma variedade de ferramentas gratuitas disponíveis online.

Você nem precisa baixar nada. Basta acessar o site da ferramenta e começar a digitar. Dillinger é um dos melhores editores compatíveis com o Markdown. A ferramenta é dividida em dois painéis, a esquerda você entra com a marcação e a direita é uma pré-visualização do conteúdo renderizado em HTML.

Se tiver dúvidas de qual editor escolher consulte a nossa seção de ferramentas para mais informações.

Para iniciar o aprendizado abra o nosso editor online Markeditor em outra aba do navegador, assim você aprende e pratica ao mesmo tempo.

Posteriormente quando adquirir mais experiência editando documentos com Markdown baixe um aplicativo para o seu computador, celular ou tablet, claro, se isso for necessário.

Como funciona?

Mesmo que você esteja usando um editor com recurso de conversão em tempo real é importante entender o que acontece por trás das câmeras.

Um documento em Markdown é apenas um texto simples, sem absolutamente nenhuma formatação, compilação ou criptografia, a única coisa que identifica o formato do seu arquivo é a extensão, nesse caso .md ou .markdown.

Mas então como a mágica acontece? Como meu arquivo simples no formato Markdown é convertido em HTML? Ou até mesmo em um documento pronto para impressão?

A resposta mais direta é que nós precisamos de um conversor, ou seja, uma ferramenta que transforme o nosso simples arquivo MD em um documento HTML.

Vale ressaltar que, a conversão para HTML é interessante pois o seu documento poderá ser interpretado e apresentado em navegadores como o Google Chrome, Mozilla Firefox e o Microsoft Edge.

Como é feita a conversão?

Os aplicativos Markdown possuem internamente um processador Markdown (também conhecido como "analisador" ou "implementação").

Esse processador usa um Parser para vasculhar o seu documento a procura de marcações compatíveis com o Markdown.

Quando uma marcação é encontrada o processador relaciona a formatação Markdown com a formatação HTML (exemplo: # Meu Título <h1>Meu Título</h1>

Nesse ponto, seu documento pode ser visualizado em um navegador da Web ou combinado com uma folha de estilos e impresso.

Abaixo você confere uma representação gráfica de todo o processo.

Obs: O aplicativo e o processador Markdown são dois componentes separados. Por questão de simplicidade, eu os combinei em um elemento, representado por Markdown App na figura abaixo.

Em resumo, esse é um processo dividido em quatro etapas:

  • Crie um documento Markdown usando um editor de texto ou um aplicativo Markdown dedicado. O arquivo deve ter uma extensão .md ou .markdown.
  • Abra o arquivo em um aplicativo Markdown.
  • Use o aplicativo Markdown para converter o arquivo de md para HTML.
  • Visualize o arquivo HTML em um navegador da Web ou use o aplicativo Markdown para convertê-lo em outro formato de arquivo, como PDF.

É claro que esse processo pode variar um pouco dependendo da ferramenta usada. Por exemplo, o Dillinger combina essencialmente as etapas 1, 2 e 3 em uma interface única e integrada - tudo o que você precisa fazer é digitar no painel esquerdo e a saída renderizada magicamente aparece no painel direito. Mas se você usar outras ferramentas, como um editor de texto com um gerador de site estático, verá que as etapas de conversão são bem mais explicitas.

Para que serve o Markdown?

O Markdown se sobressai pela simplicidade, facilidade é a palavra-chave aqui, seja para fazer anotações, criar conteúdo para um site ou produzir documentos prontos para impressão, essa linguagem de marcação é imbatível.

Não leva muito tempo para aprender a sintaxe, e depois que você souber como usá-la, poderá desenvolver qualquer documento usando o MD. O uso mais comum do Markdown é para criar web content, ou seja, conteúdo para a web, mas o Markdown é bom para formatar tudo, desde mensagens de e-mail até lista de compras.

Abaixo segue uma lista de exemplos do que podemos fazer com o Markdown.

Websites

O Markdown foi desenvolvido para a internet, portanto, não é surpresa que existam muitos aplicativos projetados especificamente para a criação de conteúdo web.

Se você está procurando a maneira mais simples possível de criar um site com arquivos Markdown, consulte blot.im e smallvictori.es. Depois de se inscrever em um desses serviços, eles criam uma pasta Dropbox no seu computador. Basta arrastar e soltar seus arquivos do Markdown na pasta e - puf! - eles estão no seu site. Mamão com açúcar.

Se você tem familiaridade com HTML, CSS e versionamento, confira o Jekyll, um gerador de site estático extremamente popular que pega arquivos do Markdown e cria um site em HTML. Uma vantagem dessa abordagem é que o GitHub Pages (Páginas do GitHub) fornece hospedagem gratuita para sites gerados através do Jekyll. Não curtiu o Jekyll? Opções não faltam, dá uma olhadinha nessa lista de geradores de sites estáticos.

Se você deseja usar um sistema de gerenciamento de conteúdo (CMS) para alimentar seu site, confere o Ghost. É uma plataforma de blog gratuito e de código aberto com um bom editor de Markdown. Se você é adepto do WordPress, ficará feliz em saber que há suporte ao Markdown para sites hospedados no WordPress.com. Sites WordPress auto-hospedados podem usar o plugin Jetpack.

Documentos

O Markdown não possui todos os enfeites de natal de um processador de texto como o Microsoft Word, mas é bom o suficiente para criar documentos básicos, como uma lista de tarefas ou uma carta de amor .

O documento em formato md pode ser convertido para, basicamente, qualquer formato, basta ter a ferramenta ou o utilitário correto.

Abaixo segue uma lista de aplicativos de criação de documentos do Markdown que eu recomendo:

Dica: O iA Writer fornece modelos para visualizar, imprimir e exportar documentos no formato Markdown. Por exemplo, o modelo "Academic - MLA Style" recua parágrafos e adiciona espaçamento entre frases duplas.

Notas

Em quase todos os aspectos, o Markdown é a sintaxe ideal para fazer anotações. Infelizmente, o Evernote e o OneNote, dois dos aplicativos de anotação mais populares, bota populares nisso, atualmente não oferecem suporte ao Markdown.

Em contrapartida, não faltam aplicações compatíveis com o Markdown, segue a lista:

  • Simplenote é um aplicativo gratuito de anotações bem simples disponível para todas as plataformas.
  • Notable é um aplicativo de anotações que pode ser executado em uma variedade de plataformas.
  • O Bear é um aplicativo semelhante ao Evernote disponível para dispositivos Mac e iOS. Ele não usa o Markdown por padrão, mas você pode ativar o modo de compatibilidade, e, voila!.
  • O Boostnote se autodenomina como um "aplicativo de anotações de código aberto desenvolvido para programadores".

Se você não pode dar adeus ao Evernote, consulte o Marxico, um editor de Markdown PAGO compatível com o Evernote ou use o Markdown Here com o site do Evernote.

Quer mais aplicativos? Se esparrame na nossa seção de ferramentas.

Livros

Procurando publicar automaticamente um romance? Experimente o Leanpub, um serviço que pega seus arquivos no formato Markdown e os transforma em um livro eletrônico. O Leanpub produz seu livro no formato de arquivo PDF, EPUB e MOBI. Agora, se você não é fã de e-Book ou precisa de cópias físicas, bom, basta carregar o arquivo PDF em um outro serviço, como por exemplo o Kindle Direct Publishing. Para saber mais sobre como escrever e publicar um livro usando o Markdown, leia esta postagem no Medium (em inglês).

Apresentações

Acredite ou não, você pode gerar apresentações a partir de arquivos md.

A criação de apresentações em formato Markdown é um pouco esquisita no começo, mas depois que você pega o jeito, é muito mais rápido e fácil do que usar um aplicativo como o PowerPoint ou o Keynote.

O Remark (projeto no GitHub) é uma ferramenta popular de apresentação de slides baseada em, adivinha?

O Cleaver (projeto no GitHub) também é interessante.

Se você usa o Mac e prefere usar um aplicativo, consulte Deckset ou Marked.

E-mail

Eu envio muitos e-mails e estou cansado dos controles de formatação disponíveis na maioria dos provedores.

Que tal usarmos Markdown para criar nossos e-mails?

O Markdown Here é uma extensão de navegador gratuita e de código aberto que converte texto formatado em Markdown para HTML, e o melhor, pronto para o envio.

Documentação

Markdown e documentação técnica, o casamento perfeito. Empresas como o GitHub estão cada vez mais migrando para o Markdown para gerar suas documentações - confira esse post (em inglês) no blog deles de como migraram sua documentação no formato Markdown para o Jekyll.

Se você precisa desenvolver documentações para produtos e/ou serviços, as ferramentas abaixo podem te ajudar:

  • Read The Docs pode gerar um site de documentação a partir dos seus arquivos Markdown. Basta conectar seu repositório GitHub ao serviço e dar um push - Read the Docs faz o resto. Eles também têm um serviço para entidades comerciais.
  • O MkDocs é um gerador de site estático simples e rápido. Os arquivos de origem são formatados em Markdown, a configuração fica em um documento YAML. O MkDocs possui vários temas disponíveis por padrão, incluindo uma adaptação do tema do Read The Docs para usar com o MkDocs. Um dos temas mais usados é o MkDocs Material.
  • O Docusaurus é um gerador de site estático projetado exclusivamente para criar sites de documentação. Ele suporta traduções, pesquisa e controle de versão, vale dizer que foi desenvolvido pela galera do Facebook.
  • O VuePress é um gerador de site estático desenvolvido com o Vue e otimizado para escrever documentação técnica.
  • Jekyll foi mencionado anteriormente na seção website, mas também é uma boa opção para gerar um site de documentação a partir de arquivos Markdown. Se você seguir esse caminho, verifique o tema da documentação do Jekyll.

Sabores do Markdown

Um dos aspectos mais confusos do uso do Markdown é que praticamente todos os aplicativos que são compatíveis com o md implementam uma versão ligeiramente diferente em relação a sintaxe da linguagem. Essas variantes do Markdown são comumente chamadas de sabores.

Para entender o conceito de sabores do Markdown, pode ser útil pensar neles como dialetos linguísticos. As pessoas em Ciudad Juárez falam espanhol, assim como as pessoas em Barcelona, mas há diferenças substanciais entre os dialetos usados nas duas cidades. O mesmo vale para pessoas que usam diferentes aplicativos Markdown. Usar o Dillinger para escrever com Markdown é uma experiência muito diferente do que usar Ulysses.

E agora? Quando um aplicativo dá suporte ao Markdown ele é compatível apenas com os elementos básicos da sintaxe, ou com os elementos básicos e também os estendidos? Ou é uma combinação arbitrária? Pra resolver isso nós podemos consultar a documentação do programa, ou usar a boa e velha tática da tentativa e erro.

Se você está apenas começando, o melhor conselho que posso dar é escolher um aplicativo com um bom suporte ao Markdown, como esse aqui. Isso ajudará muito a manter a portabilidade dos seus arquivos.

Você pode usar o nosso diretório de ferramentas para encontrar um aplicativo que atenda às suas necessidades.

Recursos adicionais

Existem muitos recursos que você pode usar para aprender o Markdown. Segue a lista abaixo: