🥇 Converta seu README em uma página do GitHub

Eu amo as páginas do github, mas manter o README do seu projeto independentemente da página index.html das páginas do github é uma fonte de frustração.

Corrigi o problema com um script simples que sincroniza README.md do branch master com o index.md no branch gh-pages.

Aqui está como eu publico um README.md na página estilizada do projeto.

$readme2ghpage

Fácil né?

readme2ghpage é um script Ruby simples que executa o seguinte.

* Checkout the gh-pages branch
* Checkout the README.md file from master
* Convert the README.md to index.md
  * add Jekyll front matter
  * change backticks to Liquid extension for syntax
  * update headers so they are linkable
* Remove the README.md

Aqui está o script. https://gist.github.com/2967061

Aproveitar!

Acho que o Github deve focar seus temas de página gh no direcionamento da saída do Markdown, em vez de gerar o próprio HTML.

Estou ansioso para ver o Gitub ter uma solução sólida para isso.

Related Posts