You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

rdd

Package Overview
Dependencies
20
Maintainers
1
Versions
25
Alerts
File Explorer

Advanced tools

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
Maintainers
1
Created

Readme

Source

rdd npm Version build

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

Keywords

FAQs

Package last updated on 16 Oct 2020

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

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc