reloadlive icon indicating copy to clipboard operation
reloadlive copied to clipboard

Reloadlive is a command line tool to easily preview your github-markup files

Reloadlive Gem Version Dependency Status Code Climate Bitdeli Badge

Reloadlive is a command line tool that renders your markup files in your browser without hitting the reload button.

You need only to save them. The last saved file will be rendered.

If the extension of the file is unknown, the content will be rendered in the browser without modification.

demo.gif

Markups

The following markups are supported. The dependencies listed are required if you wish to run the library.

  • .markdown, .mdown, .md -- gem install redcarpet (https://github.com/vmg/redcarpet)
  • .textile -- gem install RedCloth
  • .rdoc -- gem install rdoc -v 3.6.1
  • .org -- gem install org-ruby
  • .creole -- gem install creole
  • .mediawiki -- gem install wikicloth
  • .rst -- easy_install docutils
  • .asciidoc -- brew install asciidoc
  • .pod -- Pod::Simple::HTML comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN.

Installation

$ gem install reloadlive

Usage

In the directory containings your files run:

$ reloadlive

and open http://localhost:4567 in your browser.

$ reloadlive --help

prints the help

Notes

  • Reloadlive can be used instead of gollum or jekyll --auto
  • Internal wiki links don't work yet (to be done).
  • The user cannot use his own layout (to be done).
  • The current layout is not responsive (to be fixed).

Links

Credits

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