Idiomdrottning’s homepage

README file → blog post

This tiny little script uses the include_absolute plugin for Jekyll to link README files from your programming projects into blog posts. The file doesn’t actually have to be called README, but I’ll use that as an example.

The slug of the blog post is based on the directory that the README is in.

Edit the last two lines of the script to match your own Jekyll category _posts directory.

Usage: [FILE]

It creates an empty post that just has an include tag to the full text of the README file, which it expects to be in markdown. You can later edit that file to add more text outside of the include that’ll only show up in the blog, not in the README.

If you are using other static blogging systems I hope you feel inspired to make something similar. Feel free to use this as a starting point.

Repo at git clone