What is mdshot?
mdshot turns Markdown into beautiful PNG screenshots with GitHub-flavored styling for headings, lists, tables, code blocks, and blockquotes. Built in TypeScript and powered by Takumi for rendering and MD4x for parsing, it solves the hassle of manually screenshotting READMEs or docs for presentations, social posts, or changelogs. Run it via CLI on local files, npm packages like `npx mdshot npm:vue`, or public GitHub repositories with `npx mdshot gh:unjs/mdshot`.
Why is it gaining traction?
It stands out with dead-simple CLI access to remote content—no cloning repos or installing browsers—and features like regex-based section selection, live watch mode, and customizable themes, dimensions, and fonts including Geist and system emojis. Developers love the consistent, high-quality output mimicking GitHub's look without setup overhead, plus programmatic API for automation. The beautiful render quality rivals tools like BeautifulSoup for HTML but handles Markdown and JavaScript-rendered elements effortlessly.
Who should use this?
Open source maintainers generating polished README previews for release notes or Twitter threads. Docs writers automating screenshots for tutorials or API references. Marketers pulling beautiful renders from GitHub repositories for landing pages or newsletters. Frontend devs testing Markdown components in CI without headless browsers.
Verdict
Grab it for quick, reliable Markdown screenshots—CLI and API are polished with solid docs—but its 19 stars and 1.0% credibility score signal early maturity, so test in non-critical workflows first. Ideal starter for render GitHub Markdown needs, worth watching as it evolves.
(198 words)
