Skip to content

Commit a912040

Browse files
zhongyiiozhongyiio
committed
Release 1.0.0
0 parents  commit a912040

28 files changed

+4709
-0
lines changed

‎.gitignore‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# 依赖目录
2+
node_modules/
3+
pnpm-lock.yaml
4+
package-lock.json
5+
yarn.lock
6+
7+
# 构建输出
8+
dist/
9+
build/
10+
11+
# Plasmo 特有目录
12+
.plasmo/
13+
out/
14+
15+
# 开发环境
16+
.env
17+
.env.local
18+
.env.development.local
19+
.env.test.local
20+
.env.production.local
21+
22+
# 编译缓存
23+
.turbo/
24+
.cache/
25+
*.tsbuildinfo
26+
27+
# 日志
28+
npm-debug.log*
29+
yarn-debug.log*
30+
yarn-error.log*
31+
pnpm-debug.log*
32+
33+
# 编辑器目录
34+
.idea/
35+
.vscode/
36+
.vim/
37+
*.sublime-workspace
38+
*.sublime-project
39+
40+
# 系统文件
41+
.DS_Store
42+
Thumbs.db
43+
ehthumbs.db
44+
Desktop.ini
45+
46+
# 临时文件
47+
*.swp
48+
*.swo
49+
*~
50+
*.tmp
51+
*.bak

‎CHANGELOG.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Changelog
2+
3+
## 1.0.0 (2025-03-26)
4+
5+
### Features
6+
- Initial stable release of ReadLite
7+
- Reader mode for comfortable web reading
8+
- Support for multiple languages
9+
- Customizable reading experience (font, width, theme)
10+
- Language detection for optimal text display
11+
- Browser extension integration
12+
13+
### Technical
14+
- Optimized bundle size
15+
- Removed unused dependencies
16+
- Improved performance

‎README.md‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# ReadLite - Simple Reading Mode
2+
3+
ReadLite is a browser extension focused on user experience, providing clean typography and immersive reading experience similar to physical books. It intelligently extracts webpage content, filters out ads and distracting elements, allowing you to focus on the content itself.
4+
5+
## ✨ Key Features
6+
7+
### 📖 Smart Content Extraction
8+
- Automatically identifies and extracts main content using advanced algorithms
9+
- Effectively filters out ads, popups, and other distracting elements
10+
- Supports various news sites, blogs, documentation, and long-form content
11+
12+
### 🎨 Beautiful Reading Experience
13+
- Multiple themes: Light, Dark, Sepia, and Paper mode
14+
- Customizable fonts, font sizes, line spacing, and page width
15+
- Automatically adapts to different screen sizes for optimal reading
16+
17+
### 🔤 Multilingual Support
18+
- Automatically detects page language and applies appropriate typography rules
19+
- Provides specialized reading experience for Chinese and English content
20+
- Supports switching between Chinese and English interfaces
21+
22+
### ⚡ Convenient Controls
23+
- One-click adjustment for all reading settings
24+
- Automatically remembers your reading preferences
25+
26+
### 🔒 Privacy Focused
27+
- All features process locally, no transmission of your reading content
28+
- No account registration required for full functionality
29+
- Collects no personal data, protecting your privacy
30+
31+
## 🚀 How to Use
32+
33+
1. After installation, browse any page with articles
34+
2. Click the ReadLite icon in the toolbar or press Alt+R
35+
3. The page will immediately convert to comfortable reading mode
36+
4. Customize your reading experience through the settings panel
37+
38+
## 🛠️ Development Guide
39+
40+
### Prerequisites
41+
42+
- Node.js 16+ and npm/yarn
43+
- Chrome, Edge, or other modern browsers
44+
45+
### Install Dependencies
46+
47+
```bash
48+
npm install
49+
# or
50+
yarn install
51+
```
52+
53+
### Development Mode
54+
55+
```bash
56+
npm run dev
57+
# or
58+
yarn dev
59+
```
60+
61+
### Build Extension
62+
63+
```bash
64+
npm run build
65+
# or
66+
yarn build
67+
```
68+
69+
### Testing
70+
71+
```bash
72+
npm run test
73+
# or
74+
yarn test
75+
```
76+
77+
## 📁 Project Structure
78+
79+
```
80+
read-lite/
81+
├── public/ # Static assets
82+
│ ├── assets/ # Icons and images
83+
│ └── manifest.json # Extension config
84+
├── src/
85+
│ ├── background/ # Background scripts
86+
│ ├── content/ # Content scripts
87+
│ ├── popup/ # Popup UI
88+
│ ├── components/ # React components
89+
│ ├── hooks/ # Custom React Hooks
90+
│ ├── utils/ # Utility functions
91+
│ ├── locales/ # Localization
92+
│ ├── styles/ # Global styles
93+
│ └── types/ # Type definitions
94+
└── tests/ # Unit tests
95+
```
96+
97+
## 📄 License
98+
99+
MIT
100+
101+
---
102+
103+
*For Chinese version, please see [README.zh.md](README.zh.md)*

‎README.zh.md‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# ReadLite - 简洁阅读模式
2+
3+
ReadLite 是一款注重用户体验的浏览器扩展，为网页内容提供类纸质书籍的简洁排版和沉浸式阅读体验。它能智能提取网页正文，过滤广告和干扰元素，让您专注于内容本身。
4+
5+
## ✨ 主要功能
6+
7+
### 📖 智能内容提取
8+
- 使用先进算法自动识别并提取网页主要内容
9+
- 有效过滤广告、弹窗和其他干扰元素
10+
- 支持各类新闻、博客、文档和长文本网站
11+
12+
### 🎨 精美阅读体验
13+
- 提供多种主题：明亮、暗黑、护眼、纸张模式
14+
- 可自定义字体、字号、行间距和页面宽度
15+
- 自动适应不同设备屏幕尺寸，提供最佳阅读效果
16+
17+
### 🔤 多语言支持
18+
- 自动检测页面语言并应用最合适的排版规则
19+
- 为中文和英文内容提供专门优化的阅读体验
20+
- 支持中英文界面切换，满足不同用户的偏好
21+
22+
### ⚡ 便捷操作
23+
- 一键调整所有阅读设置
24+
- 自动记忆您的阅读偏好设置
25+
26+
### 🔒 注重隐私
27+
- 所有功能在本地处理，不传输您的阅读内容
28+
- 无需注册账号即可使用全部功能
29+
- 不收集任何个人数据，保护您的隐私
30+
31+
## 🚀 使用方法
32+
33+
1. 安装扩展后，浏览任何含有文章的网页
34+
2. 点击工具栏中的ReadLite图标或按Alt+R快捷键
35+
3. 网页将立即转换为舒适的阅读模式
36+
4. 通过设置面板自定义您的阅读体验
37+
38+
## 🛠️ 开发指南
39+
40+
### 前提条件
41+
42+
- Node.js 16+ 和 npm/yarn
43+
- Chrome、Edge 或其他现代浏览器
44+
45+
### 安装依赖
46+
47+
```bash
48+
npm install
49+
# 或
50+
yarn install
51+
```
52+
53+
### 开发模式
54+
55+
```bash
56+
npm run dev
57+
# 或
58+
yarn dev
59+
```
60+
61+
### 构建扩展
62+
63+
```bash
64+
npm run build
65+
# 或
66+
yarn build
67+
```
68+
69+
### 测试
70+
71+
```bash
72+
npm run test
73+
# 或
74+
yarn test
75+
```
76+
77+
## 📁 项目结构
78+
79+
```
80+
read-lite/
81+
├── public/ # 静态资源
82+
│ ├── assets/ # 图标、图片资源
83+
│ └── manifest.json # 扩展配置文件
84+
├── src/
85+
│ ├── background/ # 后台脚本
86+
│ ├── content/ # 注入页面脚本
87+
│ ├── popup/ # 工具栏弹出页面
88+
│ ├── components/ # React组件库
89+
│ ├── hooks/ # 自定义React Hooks
90+
│ ├── utils/ # 工具函数
91+
│ ├── locales/ # 多语言支持
92+
│ ├── styles/ # 全局样式定义
93+
│ └── types/ # TypeScript类型定义
94+
└── tests/ # 单元测试
95+
```
96+
97+
## 📄 许可证
98+
99+
MIT
100+
101+
---
102+
103+
*英文版请查看 [README.md](README.md)*

0 commit comments

Comments
 (0)