rsshub-rule-generator

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

rsshub-rule-generator

(★ 11)

No description available.

rsshub-rule-generator Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# RSSHub Rule Generator 🚀

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/xiongsircool/rsshub-rule-generator/main/LICENSE)
![Version](https://img.shields.io/badge/version-1.0.0-green)
![Build](https://img.shields.io/badge/build-passing-brightgreen)

[中文文档](README_zh.md)

**AI-powered RSSHub rule generation tool.**

No coding required. Leveraging LLM capabilities (DeepSeek/OpenAI), it intelligently analyzes webpage structures (including SPA/React dynamic sites), automatically generates high-quality RSSHub route code, and supports **local real-time preview**.

![Execution Demo](https://raw.githubusercontent.com/xiongsircool/rsshub-rule-generator/main/images/execution-demo.png)

## ✨ Core Features (v1.0)

- **🧠 Smart HTML Analysis**: Proprietary `Smart DOM Cleaning` algorithm that intelligently removes ads/noise while preserving `data-testid` (Twitter/React), images, timestamps, and other critical information.
- **📸 Visual Extraction**: Beyond just titles and links! Automatically extracts:
  - **Cover Images**
  - **Long Descriptions**
  - **Publication Dates** (Smart `time/datetime` recognition)
  - **Author Information**
- **⚡️ SPA/Dynamic Site Support**: Perfect support for Twitter (X), Juejin, and other React/Vue-based dynamic single-page applications.
- **👀 Real-time Sandbox Preview**: After code generation, run parsing logic directly within the extension to instantly see rich results with images and text.
- **🎨 Modern UI**:
  - Minimalist design with **5 themes**: Dark/Light/Starry Purple/Cyberpunk and more
  - Lucide icon system
- **🛡️ Privacy First**: Chrome extension architecture, **zero backend**, API keys are encrypted and stored locally in the browser only.

## 📦 Quick Start

### Option 1: Load Development Version

1. Clone the repository:
   ```bash
   git clone https://github.com/your-repo/rsshub-rule-generator.git
   cd rsshub-rule-generator/extension
   ```
2. Install dependencies and build:
   ```bash
   npm install
   npm run build
   ```
3. Load the extension:
   - Open Chrome -> `chrome://extensions/`
   - Enable "Developer mode"
   - Click "Load unpacked" and select the `extension/dist` directory

### Option 2: Development Mode (Hot Reload)

```bash
npm run dev
```

## 🔧 Usage Guide

1. **Configure API**
   - Click "Settings" in the top right corner of the extension
   - Enter an OpenAI-compatible API Key (DeepSeek-V3/R1 recommended)
   - Customize Base URL if needed

2. **One-Click Generation**
   - Browse the webpage you want to subscribe to (e.g., Twitter user page, tech blogs)
   - Click the extension icon -> **⚡ Generate Rule**
   - Wait for AI analysis (typically 3-5 seconds)

3. **Preview & Debug**
   - After successful generation, a preview list appears below
   - Verify titles, links, and images are correct
   - Copy the generated code to your RSSHub project

### Example Results

**Juejin Article List Parsing:**

![Juejin Example](https://raw.githubusercontent.com/xiongsircool/rsshub-rule-generator/main/images/juejin-example.png)

**CNKI Literature Parsing:**

![CNKI Parsing Example](https://raw.githubusercontent.com/xiongsircool/rsshub-rule-generator/main/images/知网解析示意图.png)

## 🗺️ Roadmap

### Phase 1 - Core Features (Completed ✅)
- [x] Smart HTML cleaning & compression (Smart Cleaning)
- [x] Multi-model LLM support
- [x] Code generation with syntax highlighting
- [x] **Local sandbox preview (with images/timestamps)**
- [x] UI theme system (Dark/Light/Cyberpunk)

### Phase 2 - Advanced Support (Completed ✅)
- [x] **SPA dynamic site support** (preserving `data-testid`)
- [x] Smart selector extraction algorithm
- [x] Error self-repair mechanism

### Phase 3 - Future Plans 🚀
- [ ] **Interactive Selection**: Click webpage elements to auto-lock selectors
- [ ] **Puppeteer Mode**: Generate Puppeteer scripts for heavily protected sites
- [ ] **API Sniffing**: Auto-intercept XHR/Fetch requests to generate API routes
- [ ] **Rule Cloud Sync**: Save your rule library

## 🛠️ Tech Stack

- **Core**: React 18 + TypeScript + Vite
- **Extension**: CRXJS Vite Plugin
- **Styling**: Vanilla CSS (Variables) + Lucide React
- **Parsers**: Cheerio (Rule Execution) + DOMParser (Local Analysis)

## 📄 License

rsshub-rule-generator

rsshub-rule-generator Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

rsshub-rule-generator

rsshub-rule-generator Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README