Os geradores de página do github são muito legais, eles permitem que você carregue o arquivo leia-me do projeto e faça o layout de seu conteúdo em um conjunto de bons modelos pré-fabricados
isso é bom e torna minha vida mais fácil se eu atualizar regularmente meu arquivo leia-me, mas e se eu quisesse adicionar uma parte específica do código à página do projeto (digamos um botão de tweet)?
claro que posso, mas perderei a funcionalidade interessante de atualizar meu arquivo leia-me.
então, como podemos hackear um modelo de projeto e manter o processo de atualização elegante?
a resposta é usar essência, e aqui está como
1. coloque todo o seu readmeconteúdo em um gistarquivo
2. vá para a gh-pagesfilial do seu projeto
3. hackear index.htmlsubstituindo o conteúdo da página pelo gistscript
<script src="https://gist.github.com/4375063.js"></script>4. adicione um pedaço de código para desativar os estilos de essência incorporados
$(function() {
$('section link').prop('disabled', true);
});e agora está feito, cada vez que você atualizar o arquivo gist, a página do seu projeto é atualizada automaticamente e você pode injetar qualquer código que quiser no branch gh-pages.
Usei essa técnica em meu projeto minúsculo recente jQuery.ajax.fake: