rdd.js
Preview your README.md
locally as it would appear on Github, with changes reflected on-the-fly. Useful for Readme Driven Development.
Quick start
Requires Node.js.
$ ls
README.md
$ npm i -g rdd
$ rdd -o
Serving on localhost:8888
Here we’re using the -o
flag to open the rendered page in our default web browser. The page will be updated automatically when 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 BROWSER Open the rendered Markdown file in the specified browser.
Uses your default browser if not specified.
-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 i -g 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
Changelog
License
MIT