ez-reads
v1.0.0
Published
Turn any research paper into a beautiful static website
Downloads
85
Maintainers
Readme
ez-reads
Turn any research paper into a beautiful, interactive static website.
Paste an ArXiv URL or DOI, and ez-reads will fetch the paper, distill it into structured sections using an LLM, and generate a polished React site — complete with an AI chat assistant that can answer questions about the paper.
Features
- Automatic distillation — Extracts key contributions, methodology, results, stats, significance, limitations, glossary, and more
- Beautiful sites — React + Tailwind sites with scroll animations, color themes, and responsive design
- AI chat assistant — Each generated site includes a chat widget powered by Groq so visitors can ask questions about the paper
- Paper library — An auto-generated index page lists all your papers with search
- ArXiv + DOI support — Works with ArXiv URLs and DOIs from any publisher
- Figure extraction — Automatically downloads and displays paper figures
Requirements
- Node.js 18+ (uses native
fetch()) - Groq API key — free at console.groq.com/keys
Install
npm install -g ez-readsOr run it directly without installing:
npx ez-readsUsage
ez-readsOn first run, you'll be prompted for your Groq API key. The key powers both:
- Paper distillation — extracting structured data from the paper via LLM
- Chat assistant — the interactive Q&A widget on each generated site
Model used: qwen/qwen3-32b (available on Groq's free tier)
Skip the prompt
Set your key in the environment to skip the interactive prompt:
export GROQ_API_KEY=gsk_your_key_here
ez-readsOr create a .env file in the directory where you save the key:
GROQ_API_KEY=gsk_your_key_hereHow it works
📄 paper → 🔬 distill → ✨ generate → 🌐 site- Fetch — Scrapes the paper content from ArXiv or resolves a DOI
- Distill — Sends the paper through 5-6 LLM calls to extract structured JSON (title, abstract, methodology, results, stats, glossary, etc.)
- Generate — Builds a React + Tailwind static site and serves it locally
Output goes to ./ez-reads-output/ in your current directory.
Commands
| Command | Description |
|---|---|
| ez-reads or paper-site | Start the interactive CLI |
| npm run rebuild | Rebuild all existing sites (after template changes) |
Generated site structure
ez-reads-output/
├── index.html # Library page (lists all papers)
└── <paper-slug>/
├── index.html # Paper site
├── assets/ # JS/CSS bundles
├── figures/ # Downloaded figures
├── meta.json # Metadata for library index
└── data.json # Full distilled data (for rebuilds)Chat assistant
Every generated site includes a floating chat button in the bottom-right corner. Visitors can ask questions about the paper and get answers powered by the same Groq API key used during generation.
Note: Your Groq API key is embedded in the generated site's JavaScript bundle to power the chat assistant. This is fine for local use or private hosting. If you plan to host generated sites publicly, be aware that the key is visible in the page source.
License
MIT
