Instant Preview for Github's README formats
JavaScript Ruby
Pull request Compare This branch is 104 commits behind kei-s:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
help
public
spec
views
.gitignore
Gemfile
Gemfile.lock
README.markdown
app.rb
config.ru

README.markdown

Github Preview

App on Heroku

http://github-preview.herokuapp.com/

Preview script

Put this into your path at e.g. ~/bin/github-preview and chmod +x it.
Then github-preview someproject/Readme.markdown

#!/usr/bin/env ruby
# open a given markdown file via github preview app
raise "gime a file!!" unless ARGV[0]

require 'cgi'
content = File.read(ARGV[0])
url = 'http://github-preview.herokuapp.com/'

exec "open '#{url}/?text=#{CGI.escape content}&format=markdown'"

Local development

bundle
bundle exec rspec spec
bundle exec rackup
open http://localhost:9292