Skip to main content


Project description

# remarkable

[![Build Status](](
[![Stories in Ready](]( [![pypi version](](
[![# of downloads](](
[![code coverage](](


## Overview

A mashup of and

* CLI that processes a MarkDown file and emits an HTML presentation

## Usage

Install `remarkable`:

pip install remarkable

## CLI

Run the cli:


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

remarkable -h | --help

--debug Debug.

-h --help Show this screen.

$ remarkable remark
INFO:remarkable.cli:Created remark.html

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

## Documentation

[API Documentation](

## Testing

Install development requirements:

pip install -r requirements.txt

Tests can then be run with:


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:


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for remarkable, version 0.3.1
Filename, size File type Python version Upload date Hashes
Filename, size remarkable-0.3.1.tar.gz (148.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page