Wednesday, June 27, 2012

Sharing Blog Example Code

I've been blogging since 2005, using various tools for publishing readable code. Originally you'd just put code out there, no colors, just a pre tag and some indention. Then 'export to html' became pretty standard in various editors, and everyone's life got better. These days, people want code examples available to play with - and I use GitHub to make that possible.

I've been toying with different formats for sharing code, and my last blog entry demonstrates what I've settled on.
  • Each blog entry with a non-trivial amount of code will live in a repository owned by blog-jayfields-com
  • Commits will contain working code that can be executed (if possible)
  • I'll use gist-it to embed code that can be found in the GitHub repo
  • I'll create a gh-pages index.html with the content of the blog entry, for people to review and provide feedback.
Hopefully the extra integration with GitHub will make it easier to try out any code that I publish. As always, please drop me a line in the comments if you have any suggestions.

No comments:

Post a Comment

Note: Only a member of this blog may post a comment.