For a long time, I have wanted to insert the READMEs of my GitHub projects on my static website (to control the theme, to insert asciinema scripts, etc…). The problem is, you can’t insert it verbatim, you need to add things like a bit of yaml metadata at the top or some code to insert the asciinema player.
So I’ve written an awk script to use HTML comments in the README you host on GitHub and insert/remove the small bits that need to differ between GitHub and your site. Why awk? It’s quite fast (see the benchmark session), ubiquitous (don’t add one more dependency in your CI) and felt like a good fit for this.
If that sounds interesting, please give it a try and let me know what you think! It’s really easy to run, you just need to download a small file.
Comments
For a long time, I have wanted to insert the READMEs of my GitHub projects on my static website (to control the theme, to insert asciinema scripts, etc…). The problem is, you can’t insert it verbatim, you need to add things like a bit of yaml metadata at the top or some code to insert the asciinema player.
So I’ve written an awk script to use HTML comments in the README you host on GitHub and insert/remove the small bits that need to differ between GitHub and your site. Why awk? It’s quite fast (see the benchmark session), ubiquitous (don’t add one more dependency in your CI) and felt like a good fit for this.
If that sounds interesting, please give it a try and let me know what you think! It’s really easy to run, you just need to download a small file.