remarkable 0.3.1

remarkable

# remarkable

[](http://travis-ci.org/michaeljoseph/remarkable)
[](https://waffle.io/michaeljoseph/remarkable) [](http://badge.fury.io/py/remarkable)
[](https://crate.io/packages/remarkable?version=latest)
[](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 an HTML presentation

## Usage

Install `remarkable`:

pip install remarkable

## CLI

Run the cli:

```
remarkable.

Usage:
remarkable [options] remark <path-to-markdown-file> [<title>]
remarkable [options] reveal <path-to-markdown-file> <title>

remarkable -h | --help

Options:
--debug Debug.

-h --help Show this screen.
```

Example:
```
$ remarkable remark application-to-platform.md
INFO:remarkable.cli:Created remark.html

$ remarkable reveal application-to-platform.md application-to-platform
INFO:remarkable.cli:Created application-to-platform/index.html
```

## 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