HTML5 Zone is brought to you in partnership with:

I'm software developer and microISV, with a lot of passion to technologies.. having a fun writing code, writing blog posts and giving public speeches. For about 10 years of total experince I've been working in many branches of software development, including management and QA. I try to follow and adopt agile practices and signed up for software craftsmenship manifesto. Alexander is a DZone MVB and is not an employee of DZone and has posted 63 posts at DZone. You can read more from them at their website. View Full User Profile

GitHub as a blogging platform

  • submit to reddit

No, I'm not going to talk about creating some github-backed blogging system. I would like to talk about a blogging style I tried to apply recently.

The problem is, technical blogging is difficult. I usually have a lot of ideas or know-how's while I create some code. It's just hard to blog about. As you didn't do the blog post during coding, you might forget some details or simply loose the encouragement to blog about it.

As I mentioned in my previous post I recently created some code that contains Backbone.js + Express.js boilerplate code that could be a great start for building single page applications. I felt I needed to document it somehow, so even I will remember what's going on there. So, I put some README files there. Usually, I don't write much documentation, but during writing it I realized that it's a kind of blog post or tutorial I'm writing immediately after I created something.

I liked  how it went. First of all, Markdown is great for technical blogging. I still use HTML and feel a bit ashamed by that fact. It's so easy to format and place code examples inside with Markdown (and it looks minimalistic and great on github). Second, the content of the resulting readme file pleased me much... I felt it's the same as blogging, but a bit... more interesting, or so? So, I tweeted about it and to my great surprise, my repository got 200 stars and 20 forks, got mentioned on JavaScript Weekly and raised some questions.

The same as blogging, but instead post have repo with README + some valuable code. Instead of comments, you get issues and pull requests. That was a really motivating experience. I think I would like to repeat it from time to time.

Published at DZone with permission of Alexander Beletsky, author and DZone MVB. (source)

(Note: Opinions expressed in this article and its replies are the opinions of their respective authors and not those of DZone, Inc.)