• Stars
    star
    105
  • Rank 328,196 (Top 7 %)
  • Language
    Ruby
  • License
    MIT License
  • Created over 13 years ago
  • Updated almost 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Instant Preview for GitHub's README formats

GitHub Preview TravisCI Dependency Status PullReview stats Code Climate Test Coverage

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 thin start
open http://localhost:3000

Copy to Clipboard

Using ussy/clippy. Thanks a lot!