Slax Reader API

Simple tools for a relaxed life

English | 简体中文

Home Page | Channel | Live Site

This is the Slax Reader API service developed based on Cloudflare Worker, designed to work with the Slax Reader Web / Slax Reader APP projects. This document provides deployment and development instructions. If you want to use Slax Reader directly, please visit Slax Reader or Slax Reader Bot.

✨ Get Slax Reader

If you want to use Slax Reader directly, you can:

Read on web

• Web: visit Slax Reader to create your free account (no downloads needed).

• Browser Extensions (save links in one click):

  • Chrome Web Store (also works on Edge)

Read on mobile

• Slax Reader Bot: save articles directly from your phone.

Coming soon

• iOS/Android/Desktop apps (under active development).

🚀 Self-Deploy

Cloudflare Deploy

Vercel Deploy

Self-Hosting

🎉 Feature List

• Support for bookmarking webpages via URL / browser extension / Telegram
• Support for website parsing using server-side Fetch / Puppeteer / ApiFY
• Support for multilingual error messages and notifications
• Support for highlighting, commenting, replying, sharing, starring, and archiving bookmarked content
• Support for AI conversation, AI summarization, highlight discussions, and AI tag generation for bookmarks
• Support for hybrid search combining full-text search and vector search
• AI features support multiple service providers, degradation handling, and Function Call
• Support for importing bookmarks from Omnivore
• Optimization for content from WeChat Official Accounts / X / Medium / YouTube and series with overly simplified Readability
• Support for message pushing via Websocket / Browser Push
• Support for image proxying and asynchronous lazy saving for bookmarks

TODO List

• Support for message notifications via Telegram
• Support for runtime environments like Nodejs / Deno, enabling operation outside of Cloudflare Worker
• Complete refactoring of external data sources to adapt to more data sources (e.g., MySQL...)
• Support for one-click deployment to Docker, Cloudflare, Kubernetes, and other platforms
• Native support for more AI service providers (currently only supports OpenAI-compatible API integration)
• Complete Typescript-style ESLINT code
• Support for one-click deployment of cloudflare scripts

🤝 How to Contribute

You can contribute code to make our product better by understanding our development, deployment, and basic standards. Documentation

💖 Contributors

💖 Thank you to every contributor who helps make Slax Reader better 💖

🙏 Acknowledgements

During the development of Slax Reader API, we have used many excellent open-source projects and tools. We would like to express our sincere gratitude to the contributors of these projects:

• 🚀 Cloudflare Workers
• 🗄️ Prisma
• 🔄 itty-router
• 📖 readability
• 🤖 grammy
• 📝 TypeScript
• 🔍 ESLint
• ✨ Prettier
• ✂️ jieba-rs
• ✂️ jieba-wasm
• 💬 cf-webpush

📝 License

Slax Reader is licensed under the Apache License 2.0. The community version is completely free, open-source, and will remain so forever.