Project

markedly

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Markedly offers live preview feature to your favorite browser.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
>= 0
>= 0

Runtime

 Project Readme

Markedly

Build Status Coverage Status Code Climate

Markedly is live-reloadable markdown previewer.

Markedly converts markdown document and opens it with default browser. Browser automatically reloads using WebSocket when you modify the document.

Installation

$ gem install markedly

Usage

Preview using default github css:

$ markedly README.md

Preview using custom css:

$ markedly README.md -c /path/to/custom.css
$ markedly README.md -c http://example.com/custom.css

Show options:

$ markedly -h

Special Thanks

Github style css is originally from:

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request