0.01
No commit activity in last 3 years
No release in over 3 years
Gist-compile will compile Github gists into an intelligible, book like, form.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 1.6.6, ~> 1.6.6
>= 0.9, ~> 0.9.0
>= 1.7.2, ~> 1.7.2
>= 0.19.1, ~> 0.19.1
 Project Readme

gist-compile

Join the chat at https://gitter.im/claymcleod/gist-compile Gem Version

"gist-compile" is a tool I created to index your Github Gists (and the backend to a website I created, called Gnippets. Currently, the supported outputs are JSON, Markdown, and HTML. View the results here. The usage is simple:

Downloading using Rubygems

  1. Install the gem using Rubygems gem install gist-compile
  2. Start gist-compile! gist-compile start -u "claymcleod"

Downloading manually

  1. Clone the repo
  2. Change the gist-compile directory cd <gist-compile folder location>
  3. Make the binary executable chmod +x bin/gist-compile
  4. Start gist-compile! bin/gist-compile start -u "claymcleod"

Formatting your gists

Before you run gist-compile, you should format each Gist you want compiled like so:

# Title: Simple Ruby Datamining Example
# Authors: Clay McLeod
# Description: La tee
#               da
# Section: Learning Ruby
# Subsection: Simple Examples

...code...

A few rules:

  1. This comment must be at the top of your gist file (shebangs are the only thing that may go above them)
  2. You must format your comment using single line comment character (multi-line comments not supported!)
  3. You must include a section and a subsection.