@shivamsharma11/readme-live
v1.0.4
Published
A lightweight CLI for 1:1 GitHub-flavored README previews with live-reload
Downloads
401
Maintainers
Readme
@shivam/readme-live
A lightweight, zero-config CLI tool to preview your GitHub README files locally with instant live-reload. See exactly how your README will look on GitHub without constant committing and pushing.
Features
- GitHub-Flavored Markdown (GFM): Uses the actual GitHub API for 1:1 accuracy.
- Live Reload: Instant updates in the browser using WebSockets.
- Dark Mode: Built-in GitHub Dark Theme styling.
- Token Support: Support for GitHub Personal Access Tokens to avoid rate limits.
Installation
You can run it instantly without installation:
npx @shivamsharma11/readme-live