Skip to content

Commit fcd599f

Browse files
committed
docs: 修改文档
1 parent 7f3b603 commit fcd599f

2 files changed

Lines changed: 284 additions & 156 deletions

File tree

README.md

Lines changed: 143 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -27,121 +27,185 @@
2727
</p>
2828

2929
<p>
30-
<img src="https://img.shields.io/github/v/release/ezyshu/linuxdo-scripts?logo=github">
31-
<img src="https://img.shields.io/github/stars/ezyshu/linuxdo-scripts?logo=github&style=flat">
32-
<img src="https://img.shields.io/chrome-web-store/users/fbgblmjbeebanackldpbmpacppflgmlj?style=flat&logo=googlechrome&label=Chrome%20Web%20Store">
33-
<img src="https://img.shields.io/badge/License-AGPLv3-important?logo=gnu">
30+
<img src="https://img.shields.io/github/v/release/ezyshu/linuxdo-scripts?logo=github&label=Version">
31+
<img src="https://img.shields.io/github/stars/ezyshu/linuxdo-scripts?logo=github&style=flat&label=Stars">
32+
<img src="https://img.shields.io/chrome-web-store/users/fbgblmjbeebanackldpbmpacppflgmlj?style=flat&logo=googlechrome&label=ChromeWebStore">
33+
<img src="https://img.shields.io/badge/License-Apache%202.0-blue?logo=apache">
34+
<img src="https://img.shields.io/github/last-commit/ezyshu/linuxdo-scripts?logo=github&label=最后提交">
3435
</p>
3536
</div>
3637

37-
<!-- <img src="https://profile-counter.glitch.me/linuxdo-scripts/count.svg" style="display:none"> -->
38+
## 📖 项目简介
3839

39-
LinuxDo Scripts 是一个功能丰富的浏览器扩展,旨在提升 LinuxDo 论坛的使用体验。它集成了多项实用功能,从基础的界面优化到高级的 AI 辅助功能,让您的论坛浏览和互动体验更加流畅和高效
40+
LinuxDo Scripts 是一个功能丰富的浏览器扩展,专为提升 LinuxDo 论坛的使用体验而设计。它集成了从基础界面优化到高级 AI 辅助的多项实用功能,让您的论坛浏览和互动体验更加流畅高效
4041

41-
![image](https://github.com/user-attachments/assets/13b83ca0-3927-4261-8e29-15e152de4846)
42+
### ✨ 核心亮点
43+
- 🎨 **界面美化** - 多种主题皮肤,个性化定制
44+
- 🤖 **AI 智能** - 话题总结、智能回复生成
45+
- 📚 **内容管理** - 收藏夹、用户标签、内容过滤
46+
-**体验优化** - 快捷操作、自动化功能
47+
- 🔧 **高度可定制** - 支持自定义 CSS、快捷回复等
48+
49+
![功能展示](https://github.com/user-attachments/assets/13b83ca0-3927-4261-8e29-15e152de4846)
4250

4351
<details>
44-
<summary>操作指示/相关截图</summary>
52+
<summary>📸 更多截图展示</summary>
4553

46-
![image](https://github.com/user-attachments/assets/880539ab-7a56-4b2f-aaaa-218ee4f8e699)
47-
![image](https://github.com/user-attachments/assets/6ee3d75c-b4ff-489d-942d-1526a9793f4f)
48-
![image](https://github.com/user-attachments/assets/2d106967-bb7d-49c8-af5a-9a551904cb5d)
54+
![设置面板](https://github.com/user-attachments/assets/880539ab-7a56-4b2f-aaaa-218ee4f8e699)
55+
![功能演示](https://github.com/user-attachments/assets/6ee3d75c-b4ff-489d-942d-1526a9793f4f)
56+
![界面优化](https://github.com/user-attachments/assets/2d106967-bb7d-49c8-af5a-9a551904cb5d)
4957

5058
</details>
5159

52-
## 📥 1. 安装使用
60+
## 📥 快速安装
61+
62+
### 🌐 支持的浏览器
5363

54-
### 浏览器支持
55-
- **Chrome / Edge / Arc / Brave**[Chrome Web Store](https://chromewebstore.google.com/detail/fbgblmjbeebanackldpbmpacppflgmlj)
56-
- **国内用户**[Crx 商店](https://www.crxsoso.com/webstore/detail/fbgblmjbeebanackldpbmpacppflgmlj)
57-
- **Firefox**[Firefox Addons](https://addons.mozilla.org/zh-CN/firefox/addon/linux_do-scripts/)
64+
| 浏览器 | 安装链接 | 备注 |
65+
| ------------------------------- | --------------------------------------------------------------------------------------------- | -------- |
66+
| **Chrome / Edge / Arc / Brave** | [Chrome Web Store](https://chromewebstore.google.com/detail/fbgblmjbeebanackldpbmpacppflgmlj) | 推荐 |
67+
| **Firefox** | [Firefox Addons](https://addons.mozilla.org/zh-CN/firefox/addon/linux_do-scripts/) | 完整支持 |
68+
| **国内用户** | [Crx 商店](https://www.crxsoso.com/webstore/detail/fbgblmjbeebanackldpbmpacppflgmlj) | 无需翻墙 |
5869

70+
### 🚀 安装步骤
71+
1. 点击上方对应浏览器的安装链接
72+
2. 在扩展商店中点击"添加到浏览器"
73+
3. 确认安装权限
74+
4. 访问 [LinuxDo 论坛](https://linux.do) 开始使用
5975

60-
## 2. 主要特性
76+
## 功能特性
6177

6278
### 🔍 浏览体验优化
63-
- 话题列表显示创建时间
64-
- 显示楼层数
65-
- 新标签页打开话题
66-
- 在话题列表直接预览详情及评论
67-
- 中英文混排优化显示
68-
- 优化签名图显示,防止图裂
69-
- 自动切换黑夜模式
79+
- ⏰ 话题列表显示创建时间
80+
- 🏢 显示楼层数和楼主标识
81+
- 🆕 新标签页打开话题
82+
- 👀 话题列表直接预览详情及评论
83+
- 📝 中英文混排优化显示
84+
- 🖼️ 优化签名图显示,防止图片损坏
85+
- 🌙 自动切换黑夜模式
86+
- 📱 超长显示器宽度优化
7087

7188
### 📚 内容管理
72-
- 完善的收藏夹功能
73-
- 用户标签功能
74-
- 强制屏蔽(拉黑)指定用户的话题
75-
- 只看楼主切换功能
89+
- ⭐ 完善的收藏夹功能
90+
- 🏷️ 用户标签系统
91+
- 🚫 强制屏蔽指定用户话题
92+
- 👑 只看楼主切换功能
93+
- 🔍 关键词和标签过滤
94+
- 📅 按时间屏蔽旧帖子
7695

7796
### 💬 互动增强
78-
- 话题快捷回复(支持自定义)
79-
- 评论框表情优化
80-
- 楼层抽奖功能
81-
- 等级信息查询
82-
83-
### 🤖 AI 智能
84-
- AI 话题总结
85-
- 智能生成回复
86-
- AI 辅助回帖
97+
- ⚡ 话题快捷回复(支持自定义模板)
98+
- 😊 评论框表情优化
99+
- 🎲 楼层抽奖功能
100+
- 📊 等级信息查询
101+
- 👍 快捷点赞按钮
102+
- 🔄 自动展开回复
103+
104+
### 🤖 AI 智能助手
105+
- 📋 AI 话题总结
106+
- 💡 智能生成回复
107+
- 🤝 AI 辅助回帖
108+
- 🎯 内容智能分析
109+
110+
### 🎨 个性化定制
111+
- 🎭 多种论坛主题皮肤
112+
- 😀 论坛表情风格切换
113+
- 🎨 自定义 CSS 样式支持
114+
- ☁️ 设置数据云端同步
115+
- 🖼️ 自定义论坛 Logo
116+
- 📑 自定义标签页图标和标题
117+
118+
### � 实用工具
119+
- 📸 话题转图片分享
120+
- 📄 论坛文章导出
121+
- ⬆️ 返回顶部/直达一楼
122+
- 🔕 快速免打扰帖子
123+
- 🎯 查看自己的回复楼层
124+
125+
## 🛠️ 开发指南
126+
127+
### 📋 环境要求
128+
- **Node.js**: `v22.12.0`
129+
- **包管理器**: npm
130+
131+
### 🚀 本地开发
132+
133+
```bash
134+
# 1. 克隆项目
135+
git clone https://github.com/ezyshu/linuxdo-scripts.git
136+
cd linuxdo-scripts
137+
138+
# 2. 安装依赖
139+
npm install
87140

88-
### 🎨 个性化
89-
- 切换论坛主题皮肤
90-
- 切换论坛表情风格
91-
- 支持自定义 CSS 样式
92-
- 设置面板数据同步
141+
# 3. 启动开发服务
142+
npm run dev
143+
```
93144

94-
## 🛠️ 3. 开发指南
145+
### 📦 加载扩展
146+
1. 打开浏览器扩展管理页面
147+
- Chrome: `chrome://extensions/`
148+
- Firefox: `about:addons`
149+
2. 开启"开发者模式"
150+
3. 点击"加载已解压的扩展程序"
151+
4. 选择项目根目录下的 `.output/chrome-mv3` 文件夹
95152

96-
### 环境要求
153+
### 🏗️ 项目架构
97154
```
98-
node: v22.12.0
155+
linuxdo-scripts/
156+
├── entrypoints/ # 入口文件
157+
├── components/ # Vue 组件
158+
├── public/ # 静态资源
159+
├── docs/ # 文档
160+
├── i18n/ # 国际化文件
161+
└── package.json # 项目配置
99162
```
100163

101-
### 本地开发
102-
1. 克隆仓库并安装依赖:
103-
```shell
104-
git clone https://github.com/ezyshu/linuxdo-scripts
105-
npm install
106-
```
164+
### 💡 开发规范
165+
- 🧩 **组件化开发**: 每个功能独立组件,避免冲突
166+
- 📝 **代码规范**: 遵循 ESLint 配置
167+
- 🔄 **提交流程**: PR → 代码审核 → 合并
168+
- 📚 **文档更新**: 新功能需同步更新文档
107169

108-
2. 启动开发服务:
109-
```shell
110-
npm run dev
111-
```
170+
## 🤝 参与贡献
112171

113-
3. 加载扩展:
114-
- 打开本地 `.output` 文件夹
115-
-`chrome-mv3` 文件夹拖拽到 `chrome://extensions/`
172+
### 🎯 贡献方式
173+
- 🐛 [报告 Bug](https://github.com/ezyshu/linuxdo-scripts/issues/new?template=bug_report.yml)
174+
- 💡 [功能建议](https://github.com/ezyshu/linuxdo-scripts/issues/new?template=feature_report.yml)
175+
- 🔧 [提交代码](https://github.com/ezyshu/linuxdo-scripts/pulls)
176+
- 🙍‍♂️ [加入讨论](https://discord.gg/n2pErsD7Kg)
116177

117-
### 开发说明
118-
- 采用组件化开发模式
119-
- 每个新功能以独立组件形式开发,避免冲突
120-
- 提交 PR 后将进行代码审核,无重大问题将尽快合并
178+
### 👥 贡献者
179+
![Contributors](https://contrib.rocks/image?repo=ezyshu/linuxdo-scripts)
121180

122-
## 🚀 4. 贡献者
181+
## 📊 项目统计
123182

124-
![Contributor](https://contrib.rocks/image?repo=ezyshu/linuxdo-scripts)
183+
### ⭐ Star History
184+
[![Star History Chart](https://api.star-history.com/svg?repos=ezyshu/linuxdo-scripts&type=Timeline)](https://www.star-history.com/#ezyshu/linuxdo-scripts&Timeline)
125185

126-
## 🤝 5. 贡献指南
186+
## 📄 开源协议
127187

128-
欢迎提出新的功能想法和改进建议!您可以通过以下方式参与项目:
129-
- 提交 Issue 报告问题或提出建议
130-
- 提交 Pull Request 贡献代码
131-
- 加入 Discord 社区参与讨论
188+
本项目采用 [Apache License 2.0](https://github.com/ezyshu/linuxdo-scripts/blob/main/LICENSE) 开源协议。
132189

133-
## ⭐️ 6. Star History
190+
**您可以自由地:**
191+
- ✅ 使用、复制、修改和分发本软件
192+
- ✅ 用于商业目的
193+
- ✅ 在遵循协议的前提下重新授权
134194

135-
[![Star History Chart](https://api.star-history.com/svg?repos=ezyshu/linuxdo-scripts&type=Timeline)](https://www.star-history.com/#ezyshu/linuxdo-scripts&Timeline)
195+
**但需要:**
196+
- 📋 保留原始版权声明
197+
- 📋 标明对原始代码的修改
136198

137-
## 📄 7. 许可证
138-
139-
本项目采用 [Apache License 2.0](https://github.com/ezyshu/linuxdo-scripts/blob/main/LICENSE) 协议开源。
199+
## ⚠️ 免责声明
140200

141-
您可以自由地分享和修改本项目,但必须标明原作者和来源。
201+
- 本项目为**免费开源**项目,不保证绝对完善无误
202+
- 使用前请自行评估风险,遵守相关法律法规
203+
- 严禁任何形式的滥用行为
204+
- 如有侵权问题,请联系 [ezyshu](https://github.com/ezyshu) 及时处理
142205

143-
## 📖 8. 免责声明
206+
---
144207

145-
本项目免费且开放源代码,但不保证其绝对完善无误,请您在决定使用前自行评估风险。同时,务必遵守所有适用法律法规,严禁任何形式的滥用行为。
146-
147-
如果有任何侵权行为,请联系 [ezyshu](https://github.com/ezyshu),将会及时处理。
208+
<div align="center">
209+
<p>如果这个项目对您有帮助,请考虑给我们一个 ⭐ Star!</p>
210+
<p>Made with ❤️ by <a href="https://github.com/ezyshu">ezyshu</a> and <a href="https://github.com/ezyshu/linuxdo-scripts/graphs/contributors">contributors</a></p>
211+
</div>

0 commit comments

Comments
 (0)