rdd
Preview your README.md
locally as it would appear on GitHub, with live updating. Useful for Readme Driven Development.
Quick start
Requires Node.js.
$ ls
README.md
$ npm install --global rdd
$ rdd --open
Serving on 0.0.0.0:8888
Here we’re using the --open
flag (-o
works, too) to open the rendered page in our default web browser. The page will be updated automatically whenever we change README.md
.
Usage
Usage: rdd [file] [options]
File:
If not specified, tries to find a Readme file (eg. README.md) in the
current directory.
Options:
-o, --open Open the rendered Markdown file in your default web browser
-p, --port PORT Set the port to serve the rendered file. Serves on port
8888 if not specified.
-h, --help Print this message.
Installation
Install via npm:
$ npm install --global rdd
Or yarn:
$ yarn global add rdd
Known issues
- Syntax highlighting for code blocks (using Highlight.js) is slightly different from what GitHub actually uses
- Does not support Task Lists
Prior art
- Grip is a similar tool written in Python
License
MIT