[](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
Metadata
Release files for remarkable 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| remarkable-0.3.1.tar.gz | 148.3 kB | Without provenance | Details for remarkable-0.3.1.tar.gz |
Release files / remarkable-0.3.1.tar.gz
| Download URL | remarkable-0.3.1.tar.gz |
|---|---|
| Size | 148.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
212d36d32348245e4eaad8a0f80f7f5f3fa5f7821708a9c8fdf4001e0bca7186
|
|
BLAKE2b-256 checksum How to use checksums |
48c42bba8baa331b13a15b7cd155bc621889188966952528ffa2c7f96d556d7e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for remarkable 0.3.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.