This gem provides a small Sinatra application to preview GitHub README files or any markdown file.
Notes : The app can only serve one file at a time. If you need a more sophisticated rendering system, look at Jekyll ;)
gem install gh-preview
No need to add it to your Gemfile, it will be globally available.
From any directory containing a
README.md file :
nicolas@desktop:~/my/wonderful/application$ gh-preview server
Then open your browser at this url : http://localhost:4000.
Usage: gh-preview server [options] Options: -f, [--file=FILE] # File to serve (default: README.md) -p, [--port=PORT] # Port for server (default 4000)
A big thank to them for their contribution!
You can contribute to this plugin in many ways such as :
- Helping with documentation
- Contributing code (features or bugfixes)
- Reporting a bug
- Submitting translations