## Fluxo de Trabalho

Como Visualizar README.md do GitHub Localmente no Mac

Publicado em março de 2026

Você editou o README. Agora quer ver como ele fica antes de fazer push. Aqui estão três maneiras de fazer isso, do mais pesado ao instantâneo.

## Por Que Visualizar Localmente

Por que visualizar localmente?

  • Verificar a formatação antes do push. Tabelas quebradas, links com erro e blocos de código malformados são constrangedores em um repositório público. Corrija antes do git push.
  • Trabalhar offline. Aviões, trens, cafés com wifi ruim. Seu README não deveria precisar de conexão com a internet para ser revisado.
  • Revisar alterações de documentação em PRs. Quando um pull request atualiza o README, você quer ver o resultado renderizado junto com o diff do código.
  • Evitar o ciclo commit-push-verificar. Fazer push de um commit só para ver como o README aparece no GitHub polui seu histórico git e desperdiça tempo.

## Método 1

grip (ferramenta CLI)

pip install grip
grip README.md

O grip renderiza seu Markdown usando a API do GitHub, então você obtém renderização pixel-perfect do GitHub no seu navegador em localhost:6419.

Prós

  • Renderização exata do GitHub (usa a API deles)

Contras

  • Requer Python instalado
  • Precisa de um token da API do GitHub para uso intenso (limitado por taxa caso contrário)
  • Roda um servidor local que você precisa iniciar e parar
  • Não funciona offline (chama a API do GitHub)

## Método 2

Preview embutido do VS Code

Abra README.md no VS Code
Cmd + Shift + V → painel de preview

O VS Code tem um preview de Markdown embutido. Abra o arquivo, use o atalho de teclado e um painel lateral mostra a saída renderizada.

Prós

  • Já instalado para a maioria dos desenvolvedores
  • Funciona offline

Contras

  • Abrir uma IDE completa para visualizar um README é exagero
  • A renderização do preview não corresponde exatamente ao GitHub (sem suporte a callouts, estilo de tabela diferente)
  • Preso ao seu editor — não dá para simplesmente dar duplo clique em um arquivo

## Método 3 (Recomendado)

ShowMeMyMD — basta dar duplo clique

git clone <repo>
Duplo clique em README.md
Pronto.

ShowMeMyMD é um visualizador de Markdown nativo para macOS. Defina-o como seu app padrão para arquivos .md e todo README abre como um preview renderizado instantaneamente. Sem CLI. Sem servidor. Sem configuração.

Suporte completo a GitHub-Flavored Markdown:

  • Tabelas com alinhamento
  • Listas de tarefas com checkboxes
  • Blocos de código com syntax highlighting
  • Callouts estilo GitHub: NOTE, TIP, WARNING, IMPORTANT, CAUTION

Clone, duplo clique em README.md, pronto.

## Comparação

Comparação lado a lado

FerramentaConfiguraçãoPrecisão GFMVelocidadeOffline
gripPython + pip installExata (API do GitHub)Lento (rede)Não
VS CodeJá instaladoParcialRápidoSim
ShowMeMyMDInstale uma vez pela Mac App StoreGFM completo + calloutsInstantâneoSim

## Continue Lendo

Saiba mais sobre o ShowMeMyMD como visualizador de Markdown para Mac. Veja como ele se encaixa em um fluxo de trabalho de desenvolvedor. Ou leia nosso guia sobre callouts estilo GitHub.

Pare de fazer push para verificar seu README

Dê duplo clique em qualquer arquivo .md e veja-o renderizado instantaneamente. GitHub-Flavored Markdown, syntax highlighting, quatro temas. $2,99 na Mac App Store.

Baixar naMac App Store