rdd
Preview your Markdown locally as it would appear on GitHub, with live updating
Last updated 4 months ago by yuanqing .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install rdd -g
SYNC missed versions from official npm registry.

rdd npm Version Build Status

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
$ npm i -g rdd
$ rdd -o -d
Serving on 0.0.0.0:8888/README.md

Here we’re using the -o flag to open the rendered Markdown file in our default web browser, and the -d flag to enable dark mode. 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]
  --dark, -d    Enable dark mode                      [boolean] [default: false]
  --format, -f  Auto-format the Markdown file on save [boolean] [default: false]
  --open, -o    Open the rendered file in your default web browser
                                                      [boolean] [default: false]
  --port, -p    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:

$ 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

Current Tags

  • 3.0.3                                ...           latest (4 months ago)

22 Versions

  • 3.0.3                                ...           4 months ago
  • 3.0.2                                ...           4 months ago
  • 3.0.1                                ...           4 months ago
  • 3.0.0                                ...           4 months ago
  • 2.0.0                                ...           5 months ago
  • 1.0.0                                ...           a year ago
  • 0.6.2                                ...           2 years ago
  • 0.6.1                                ...           2 years ago
  • 0.6.0                                ...           2 years ago
  • 0.5.0                                ...           2 years ago
  • 0.4.1                                ...           2 years ago
  • 0.4.0                                ...           2 years ago
  • 0.3.1                                ...           2 years ago
  • 0.3.0                                ...           2 years ago
  • 0.2.2                                ...           4 years ago
  • 0.2.1                                ...           4 years ago
  • 0.2.0                                ...           4 years ago
  • 0.1.1                                ...           4 years ago
  • 0.1.0                                ...           4 years ago
  • 0.0.2                                ...           4 years ago
  • 0.0.1                                ...           4 years ago
  • 0.0.0                                ...           4 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 19
Dependencies (20)
Dev Dependencies (11)
Dependents (2)

Copyright 2014 - 2016 © taobao.org |