Occasionally, working on some projects hosted on github, we put much time into creating useful & comprehensive README.md file for our project and I think you can benefit from using it to create html pages hosted on github that will be always in sync with the content.
When you might benefit from thing I’m talking about? For example, your README.md is magnificent & useful, you have some static examples hosted on github page but there’s no landing page and no connection between two. Whenever someone lands on your examples, if he knows how github pages work, he might edit the URL in his address bar & land on your repo (not everyone does & that’s quite normal). And on top of that, you don’t have time/skillset to do a cool static page and will be happy with something minimal for lack of better alternative. I turned to do this after I’ve seen I have different content in README.md & static page used for the folder (hosted on github pages) for statically hosted slides project of mine.
How to solve it?
Turn your README.md into static page!
Your repo is already on github, and whenever you push something to branch name
gh-pages it’s being build & published to
%username%.github.io/%reponame% (given it’s enabled in the repo’s settings). Only exception is your very own github space that resides in repo called
%username%.github.io and will be using
master branch to build stuff out.
Github pages use Jekyll - static site generator written in Ruby. There’re some catches to it - you cannot run plugins on Github pages, Github is using some custom markdown parser, - maybe, something else, but those are minor considering how useful this feature is, providing static site hosting & ability to use markdown to create content (you can run your very own blog using Jekyll or Octopress built on top of it and pay noone for that).
‘Code’ to do that
To signal Jekyll that some markdown needs processing, you add YAML syntax FrontMatter in the very beginning, which can be as brief as two sets of triple dashes, separated by newline.
Learned this some time ago when was battling with Jekyll for kottans.org site, which now seems to be a common knowledge, marked as ProTip in the corresponding section of documentation.
But after README.md will be processed it will be output as ‘README.html’, which poses a minor issue. We don’t want to change the name of the file (README.md will rendered by default when looking at repo page using github), but we want to be able to navigate to root path of our project and still be able to see something instead of four-oh-four page, which means we want to have
index.html page probably.
I used something simple as static page that would be redirecting to
README.html. There’re at least 2 different ways to redirect using
<meta> tag and couple of ways to navigate to another page using JS, so it shouldn’t be of too much of a trouble. I ended with following code:
<!DOCTYPE html> <html> <head> <title>Redirecting to main site</title> <meta charset="UTF-8"> <meta http-equiv="refresh" content="0;url=README.html"> </head> <body> Redirecting<i>↻</i> </body> </html>
And that would be pretty much everything that needed to be made in order for your README.md get 2 horizontal rulers on top (those tripple dashes added for jekyll’s sake) & it’s very own html representation on your github pages.
Broken Charset on Localhost &
If you use github-pages gem to bootstrap jekyll locally and directly going to ‘localhost:4000’ URL, you might see some issues with encoding because of lack of specification of proper character encoding. This won’t be a problem when pages are on Github, because Github sets
charset=utf-8 encoding using
Content-Type header. In any case, if that might be a problem for you, you might want to add layout with proper charset. For this, you will need to create
_layouts folder and put
default.html with following markup:
and in your README.md you will have to put
--- layout: default ---
which will render not that pretty when looking at your github project page, but as soon as you do that step you can add all sorts of customization and styling to the page.
Default markdown parser might work differently from Github’s
In process of creating html version page for one of my slides it turned out that markup of
Strike through heading
isn’t working in markup used in jekyll by default.
Thanks to issue#1752 in jekyll repo I was able to go over bunch of different possible engines to render markdown to find the one that worked correctly for page that used github flavored markdown (spoiler: it was
To set an engine used on your gh-pages, you will need to create
_config.yml file in root of your project and put
into it. That did solve the issue of. 😼
Nested folders &
Every folder, especially when it’s a separate entity/project, should have its own README.md to explain how/what/why of the contents. That will mean, that you will have to apply the same changes to the README’s content as to the one in you project root (and add redirecting page).
Be a good person and don’t just throw your stuff over the fence in the world of open source. Share your work, show you care about it & people using it, and you will get tenfold in return. Hope this small note will help you have this while spending less time. Hope it was somewhat useful. 😇