( Postando novamente esta resposta com algumas edições.)
Um pouco tarde para o jogo, mas escrevi uma pequena CLI em Python. É chamado de Grip (Github Readme Instant Preview) . Acrescentando à resposta de Patrick, isso permitirá que você "revise meus documentos localmente em meu navegador".
Instale-o com:
$ pip install grip
E para usá-lo, basta:
$ grip
Em seguida, visite localhost:5000
para visualizar o readme.md
arquivo nesse local.
Você também pode especificar seu próprio arquivo:
$ grip CHANGES.md
E mude a porta:
$ grip 8080
Ou combine os dois anteriores:
$ grip CHANGES.md 8080
Você pode até renderizar Markdown com sabor do GitHub (ou seja, como os comentários e problemas são renderizados), opcionalmente com o contexto de repo para referências de hiperlink automático para outros problemas:
$ grip --gfm --context=username/repo issue.md
Para resumir, veja o resto das opções e seus detalhes usando a ajuda da CLI:
$ grip -h
Recursos notáveis:
- Renderiza as páginas para que apareçam exatamente como no GitHub
- Blocos cercados
- API Python
- Navegar entre os arquivos vinculados
- Exportar um documento renderizado para um arquivo
Espero que isto ajude. Dê uma olhada .