rdd

Preview your Markdown locally as it would appear on GitHub, with live updating

rdd is short for Readme Driven Development.

Quick start

Requires Node.js.

$ ls
README.md
$ npx rdd --open
Serving on 0.0.0.0:8888/README.md

Here we’re using the --open flag to open the rendered Markdown file in our default web browser. The rendered page will be updated automatically whenever we edit and save README.md.

Usage

rdd [file]

Render and serve the given Markdown file

Commands:
  rdd format [files..]  Auto-format the given Markdown files      [aliases: fmt]
  rdd serve [file]      Render and serve the given Markdown file       [default]
  rdd toc [files..]     Insert a table of contents into the given Markdown files

Positionals:
  file                                                                  [string]

Options:
      --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]
  -d, --dark     Enable dark mode                     [boolean] [default: false]
  -f, --format   Auto-format the Markdown file on save[boolean] [default: false]
  -o, --open     Open the rendered file in your default web browser
                                                      [boolean] [default: false]
  -p, --port     Set the preferred port to serve the rendered file
                                                        [number] [default: 8888]

Use <!-- toc --> and <!-- tocstop --> to demarcate where the table of contents should be rendered in your Markdown file.

To “commit” the table of contents to the file, do:

$ npx rdd toc

Installation

$ npm install --global 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

Changelog

3.2.0

• Automatically redirect / to /README.md if ./README.md exists

3.1.0

• Allow spaces in the file name

3.0.0

• Split to commands format, serve, toc
• Add a --dark flag to support dark mode

2.0.0

• Modernise syntax
• Use yargs instead of nopt
• Use sirv instead of ecstatic
• Set .innerHTML instead of leveraging morphdom
• Support automatically rendering a table of contents in the page
• Add a --toc flag to allow “committing” the table of contents to the original Markdown document

1.0.0

• First stable release

0.6.0

• Minor refactor
• Resolve the port more intelligently

0.5.0

• Omit the id attribute from headers

0.4.1

• Add standard
• Bump dependencies

0.4.0

• Add support for GitHub emojis

0.3.0

• Major rewrite

0.2.0

• Make the -o flag a boolean; opens the page in the default web browser

0.1.1

• Add a border around the rendered page

0.1.0

• First stable release