Light

kei-s / github-preview Goto Github PK

View Code? Open in Web Editor NEW

105.0 4.0 44.0 152 KB

Instant Preview for GitHub's README formats

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

License: MIT License

Ruby 56.95% JavaScript 22.28% HTML 20.78%

github-preview's Introduction

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

Copy to Clipboard

Using ussy/clippy. Thanks a lot!

github-preview's People

Contributors

Stargazers

Watchers

github-preview's Issues

Add support for GFM tables

Example:

Foo	Bar	Baz
foo	bar	baz

Does not display tripple-backticks-language correctly

http://github-preview.herokuapp.com/?text=%23+Installation%0A%0A++++gem+install+bump%0A%0A%23+Usage%0A%0ACurrent+version+of+your+gem%3A%0A%0A++++bump+current%0A%0ACurrent+version%3A+0.1.2%0A%0ABump+your+gemfile+%28major%2C+minor%2C+patch%29%3A%0A%0A++++bump+patch%0A%0ABump+version+0.1.2+to+0.1.3%0A%0A%23%23%23+Rake%0A%0A%60%60%60Ruby%0A%23+Rakefile%0Arequire+%22bump%2Ftasks%22%0A%60%60%60%0A%0A++++rake+bump%3Apatch%0A++++rake+bump%3Acurrent%0A%0A%23+Supported+locations%0A+-+VERSION+file+with+%221.2.3%22%0A+-+gemspec+with+%60gem.version+%3D+%221.2.3%22%60%0A+-+lib%2F%2A%2A%2Fversion.rb+file+with+%60VERSION+%3D+%221.2.3%22%60%0A%0A%23+Todo%0A%0A+-+Handle+options+properly%0A+-+%60VERSION+%3D+%221.2.3%22%60+in+lib%2F%2A.rb%0A+-+gemspec+with+%60Gem%3A%3ASpecification.new+%22gem-name%22%2C+%221.2.3%22+do%60%0A%0A%23+Author%0AGregory%3Cbr%2F%3E%0ALicense%3A+MIT%3Cbr%2F%3E%0A%5B%21%5BBuild+Status%5D%28https%3A%2F%2Ftravis-ci.org%2Fgregorym%2Fbump.png%29%5D%28https%3A%2F%2Ftravis-ci.org%2Fgregorym%2Fbump%29%0A%0A%0A

https://github.com/grosser/bump/tree/rake

_ の取り扱いが GFM と違う

以下のような文字の次にアンダースコアが来るようなときは、
イタリックに変換されないように GFM はなっているのですが、
イタリックに変換されているようです。

kei_s t_wada

Thank you

Hi,

Perfect for my first README. I was new about gitHub and markDown
Thanks a lot :)
jm

favicon

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.