remarkable
Project description
# remarkable
[![Build Status](https://secure.travis-ci.org/michaeljoseph/remarkable.png)](http://travis-ci.org/michaeljoseph/remarkable) [![Stories in Ready](https://badge.waffle.io/michaeljoseph/remarkable.png?label=ready)](https://waffle.io/michaeljoseph/remarkable) [![pypi version](https://badge.fury.io/py/remarkable.png)](http://badge.fury.io/py/remarkable) [![# of downloads](https://pypip.in/d/remarkable/badge.png)](https://crate.io/packages/remarkable?version=latest) [![code coverage](https://coveralls.io/repos/michaeljoseph/remarkable/badge.png?branch=master)](https://coveralls.io/r/michaeljoseph/remarkable?branch=master)
## Overview
A mashup of http://lab.hakim.se/reveal-js and http://remarkjs.com
CLI that processes a MarkDown file and emits a HTML presentation
## Usage
Install remarkable:
pip install remarkable
## CLI
>> docopt
## Documentation
[API Documentation](http://remarkable.rtfd.org)
## Testing
Install development requirements:
pip install -r requirements.txt
Tests can then be run with:
nosetests
Lint the project with:
flake8 changes tests
## API documentation
Generate the documentation with:
cd docs && PYTHONPATH=.. make singlehtml
To monitor changes to Python files and execute flake8 and nosetests automatically, execute the following from the root project directory:
stir
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.