Quando você está implantando no Github, criar um arquivo README útil e bem formatado é um ótimo ponto de partida para as pessoas interessadas em seu projeto. Existem muitas ferramentas de visualização do Markdown disponíveis (basta verificar se há plug-ins ou pacotes em seu editor / IDE favorito ou uma ferramenta online como http://markable.in/editor/ ), mas o Github faz as coisas de forma um pouco diferente com seu sabor Markdown e pode ser difícil fazê-lo do jeito que você deseja sem empurrar para o Github e ver o que precisa ser mudado.
Foi aí que encontrei uma ferramenta chamada grip
que é realmente útil. De sua documentação, é um “aplicativo de servidor de linha de comando escrito em Python que usa a API Github Markdown para renderizar um arquivo leia-me local”.
Para instalar o Grip, você primeiro precisa de um gerenciador de pacotes python chamado pip. Se você estiver no Mac OS X ou Linux, provavelmente já tem o Python instalado e o pip deve estar disponível. Se estiver no Windows, você precisará instalar o Python. Se você estiver tendo problemas para configurar, tente as instruções de instalação aqui .
Depois de ter pip, é tão simples quanto pip install grip.
Agora que você o instalou, basta executá-lo gripna mesma pasta do seu README e ele estará disponível e disponibilizado em seu navegador. O padrão é http://localhost:5000. Agora, aproveite a visualização de seu Github Markdown antes de enviar para o repositório!