Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yuanqing/rdd
:pencil: Preview your Markdown locally as it would appear on GitHub, with live updating
https://github.com/yuanqing/rdd
github markdown rdd readme
Last synced: 10 days ago
JSON representation
:pencil: Preview your Markdown locally as it would appear on GitHub, with live updating
- Host: GitHub
- URL: https://github.com/yuanqing/rdd
- Owner: yuanqing
- License: mit
- Created: 2015-05-26T13:48:20.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2021-08-15T10:20:20.000Z (about 3 years ago)
- Last Synced: 2024-10-07T14:36:27.340Z (about 1 month ago)
- Topics: github, markdown, rdd, readme
- Language: JavaScript
- Homepage:
- Size: 583 KB
- Stars: 11
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# rdd [](https://www.npmjs.org/package/rdd) [](https://github.com/yuanqing/rdd/actions?query=workflow%3Abuild)
> Preview your Markdown locally as it would appear on GitHub, with live updating
`rdd` is short for [Readme Driven Development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html).
## Quick start
*Requires [Node.js](https://nodejs.org/).*
```
$ 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 `` and `` to [demarcate where the table of contents should be rendered in your Markdown file](https://github.com/jonschlinkert/markdown-toc#tocinsert).
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](https://github.com/isagalaev/highlight.js)) is slightly different from what GitHub actually uses
## Prior art
- [Grip](https://github.com/joeyespo/grip) is a similar tool written in Python
## License
[MIT](/LICENSE.md)