GitHub Data In Your Website
Software collaboration goes beyond just working on the code. In addition to writing a lot of code, software involves writing a lot of words. Prose shows up in documentation, tutorials, blog posts, and so on.
Another recent improvement that Ben “I am now a lawyer” Balter wrote about is the ability to surface GitHub metadata in your site without having to make API calls. Since GitHub hosts your GitHub Pages site, this metadata is directly available.
This opens up some cool opportunities.
Give credit to your blog collaborators
Every blog post in my blog has an edit link under the title. Even this one! That link takes you to an editor that lets you edit the blog post and submit your changes as a pull request. It’s so easy anyone can do it!
I really appreciate when folks send me corrections. So much so that I just added a page to give credit to those who have collaborated with me on my blog. This uses the new metadata that’s available to every GitHub Pages site.
GitHub Pages Demo Repository
If you want to understand how this works, I set up a minimal GitHub Pages Demo repository here. It includes a bare minimum Jekyll site with a page that shows how to display GitHub metadata. The goal of this page is to help you get started with your own content.
You can visit the actual rendered page here. It uses one of the built-in GitHub Pages themes by externally referencing it. That keeps all that theme code out of my repository. Nice!
The Repository metadata on GitHub Pages page provides more information about what GitHub metadata is available to your blog.
Whether you are building a documentation site for your repository, a personal blog that shows off your GitHub repositories, or whatever, this metadata is extremely useful.