Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Socket
Sign inDemoInstall

rdd

Package Overview
Dependencies
Maintainers
1
Versions
25
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

rdd

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


Version published
Weekly downloads
287
decreased by-11.15%
Maintainers
1
Weekly downloads
 
Created
Source

rdd npm Version Build Status

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

Keywords

FAQs

Package last updated on 02 Apr 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc