Preview your `README.md` locally as it would appear on Github, with live updating. Useful for Readme Driven Development.
Preview your
README.mdlocally as it would appear on Github, with live updating. Useful for Readme Driven Development.
Requires Node.js.
$ ls
README.md
$ npm i -g rdd
$ rdd -o
Serving on localhost:8888
Here we’re using the -o flag to open the rendered page in our default web browser. The page will be updated automatically when we change README.md.
Usage: rdd [file] [options]
File:
If not specified, tries to find a Readme file (eg. README.md) in the
current directory.
Options:
-o, --open BROWSER Open the rendered Markdown file in the specified browser.
Uses your default browser if not specified.
-p, --port PORT Set the port to serve the rendered file. Serves on port
8888 if not specified.
-h, --help Print this message.
Install via npm:
$ npm i -g rdd
0.1.1
FAQs
Preview your Markdown locally as it would appear on GitHub, with live updating
The npm package rdd receives a total of 207 weekly downloads. As such, rdd popularity was classified as not popular.
We found that rdd demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Company News
Socket safeguards companies from software supply chain attacks by detecting and preventing threats in open source code and empowering developers to secure their applications and critical services against malware and other security risks.
Product
Socket is launching Ruby support for all users. Enhance your Rails projects with AI-powered security scans for vulnerabilities and supply chain threats. Now in Beta!
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!