O Que É Markdown? Markup Leve Explicado

Markdown é uma linguagem de markup leve, em texto puro, que usa símbolos simples para formatar texto em headings, listas, links e blocos de código.

Markdown permite que você escreva documentos formatados em texto puro usando um punhado de símbolos intuitivos. É o formato de arquivos README, issues e descrições de pull request do GitHub, e de muita documentação. Como é apenas texto, ele vive no controle de versão e renderiza de forma limpa em todo lugar - incluindo resumos de job de CI.

O que Markdown é

Markdown usa convenções de texto puro para implicar formatação: uma cerquilha para um heading, asteriscos para ênfase, traços para itens de lista, e backticks para código inline. Um renderizador transforma esse texto em HTML. O ponto é que o código-fonte bruto ainda é legível mesmo antes de ser renderizado.

Flavors e extensões

Há vários dialetos. CommonMark é o núcleo estrito e padronizado, e o GitHub Flavored Markdown adiciona tabelas, task lists, strikethrough e blocos de código cercados com syntax highlighting. A maioria das ferramentas que você encontra no CI renderiza GitHub Flavored Markdown.

Por que Markdown combina com controle de versão

Como o Markdown é texto puro, os diffs são significativos, os merges funcionam, e ele não te prende a um editor proprietário. Isso o torna o formato natural para docs que vivem ao lado do código e são revisados em pull requests como qualquer outra mudança.

Markdown em resumos de job de CI

GitHub Actions permite que um job escreva Markdown em um arquivo de resumo especial, que então renderiza como um relatório rico na página da execução - tabelas de resultados de teste, links, ou um resumo de deploy. Escrever nesse arquivo é como você transforma a saída bruta do job em um relatório legível sem sair da execução.

# Write a Markdown job summary in GitHub Actions
steps:
  - run: |
      echo "## Build report" >> $GITHUB_STEP_SUMMARY
      echo "- Status: passing" >> $GITHUB_STEP_SUMMARY

Nota da Latchkey

O mecanismo GITHUB_STEP_SUMMARY faz parte do runner padrão, então resumos de job em Markdown renderizam de forma idêntica nos runners gerenciados da Latchkey - útil para exibir relatórios de build e deploy diretamente na página da execução.

Principais conclusões

• Markdown é markup em texto puro que usa símbolos simples para formatar headings, listas, links e código.
• GitHub Flavored Markdown adiciona tabelas, task lists e blocos de código cercados sobre o CommonMark.
• No CI você pode escrever Markdown no arquivo de resumo do job para produzir relatórios de execução ricos e legíveis.

Guias relacionados