{"id":18034683,"url":"https://github.com/yuanqing/rdd","last_synced_at":"2025-10-04T01:32:03.474Z","repository":{"id":47745894,"uuid":"36298871","full_name":"yuanqing/rdd","owner":"yuanqing","description":":pencil: Preview your Markdown locally as it would appear on GitHub, with live updating","archived":false,"fork":false,"pushed_at":"2021-08-15T10:20:20.000Z","size":597,"stargazers_count":11,"open_issues_count":2,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-17T23:40:20.640Z","etag":null,"topics":["github","markdown","rdd","readme"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yuanqing.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-05-26T13:48:20.000Z","updated_at":"2023-08-24T15:01:23.000Z","dependencies_parsed_at":"2022-07-22T02:18:22.464Z","dependency_job_id":null,"html_url":"https://github.com/yuanqing/rdd","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuanqing%2Frdd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuanqing%2Frdd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuanqing%2Frdd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuanqing%2Frdd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yuanqing","download_url":"https://codeload.github.com/yuanqing/rdd/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235208997,"owners_count":18953003,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github","markdown","rdd","readme"],"created_at":"2024-10-30T11:13:24.859Z","updated_at":"2025-10-04T01:31:58.151Z","avatar_url":"https://github.com/yuanqing.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rdd [![npm Version](https://img.shields.io/npm/v/rdd?cacheSeconds=1800)](https://www.npmjs.org/package/rdd) [![build](https://github.com/yuanqing/rdd/workflows/build/badge.svg)](https://github.com/yuanqing/rdd/actions?query=workflow%3Abuild)\n\n\u003e Preview your Markdown locally as it would appear on GitHub, with live updating\n\n`rdd` is short for [Readme Driven Development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html).\n\n## Quick start\n\n*Requires [Node.js](https://nodejs.org/).*\n\n```\n$ ls\nREADME.md\n$ npx rdd --open\nServing on 0.0.0.0:8888/README.md\n```\n\nHere 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`.\n\n## Usage\n\n\u003c!-- ``` markdown-interpolate: node src/js/cli.js --help --\u003e\n```\nrdd [file]\n\nRender and serve the given Markdown file\n\nCommands:\n  rdd format [files..]  Auto-format the given Markdown files      [aliases: fmt]\n  rdd serve [file]      Render and serve the given Markdown file       [default]\n  rdd toc [files..]     Insert a table of contents into the given Markdown files\n\nPositionals:\n  file                                                                  [string]\n\nOptions:\n      --help     Show help                                             [boolean]\n      --version  Show version number                                   [boolean]\n  -d, --dark     Enable dark mode                     [boolean] [default: false]\n  -f, --format   Auto-format the Markdown file on save[boolean] [default: false]\n  -o, --open     Open the rendered file in your default web browser\n                                                      [boolean] [default: false]\n  -p, --port     Set the preferred port to serve the rendered file\n                                                        [number] [default: 8888]\n```\n\u003c!-- ``` end --\u003e\n\nUse `\u003c!-- toc --\u003e` and `\u003c!-- tocstop --\u003e` to [demarcate where the table of contents should be rendered in your Markdown file](https://github.com/jonschlinkert/markdown-toc#tocinsert).\n\nTo “commit” the table of contents to the file, do:\n\n```\n$ npx rdd toc\n```\n\n## Installation\n\n```\n$ npm install --global rdd\n```\n\n## Known issues\n\n- Syntax highlighting for code blocks (using [Highlight.js](https://github.com/isagalaev/highlight.js)) is slightly different from what GitHub actually uses\n\n## Prior art\n\n- [Grip](https://github.com/joeyespo/grip) is a similar tool written in Python\n\n## License\n\n[MIT](/LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuanqing%2Frdd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyuanqing%2Frdd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuanqing%2Frdd/lists"}