rdd
Preview your Markdown locally as it would appear on GitHub, with live updating.
Quick start
Requires Node.js.
$ ls
README.md
$ npm i -g rdd
$ rdd -o
Serving on 0.0.0.0:8888
Here we’re using the -o
flag (--open
works, too) to open the rendered page in our default web browser. The page will be updated automatically whenever we change README.md
. This is useful for Readme Driven Development.
Usage
$ rdd -h
Usage: rdd [file] [options]
File:
If not specified, tries to find a Markdown 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 preferred port to serve the rendered file.
-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
Prior art
- Grip is a similar tool written in Python
License
MIT