Skip to content

Commit 1e85dca

Browse files
committed
docs: 修改文档说明
1 parent fcd599f commit 1e85dca

3 files changed

Lines changed: 148 additions & 77 deletions

File tree

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,6 @@ LinuxDo Scripts 是一个功能丰富的浏览器扩展,专为提升 LinuxDo
9696
### 💬 互动增强
9797
- ⚡ 话题快捷回复(支持自定义模板)
9898
- 😊 评论框表情优化
99-
- 🎲 楼层抽奖功能
10099
- 📊 等级信息查询
101100
- 👍 快捷点赞按钮
102101
- 🔄 自动展开回复

README_EN.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,6 @@ LinuxDo Scripts is a feature-rich browser extension designed to enhance the user
9696
### 💬 Interaction Enhancement
9797
- ⚡ Quick reply to topics (supports custom templates)
9898
- 😊 Optimized emoji in comment boxes
99-
- 🎲 Floor lottery feature
10099
- 📊 User level information query
101100
- 👍 Quick like button
102101
- 🔄 Auto-expand replies

docs/docs/guide/0-home/home.md

Lines changed: 148 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[简体中文](README.md) | [English](README_EN.md)
2+
13
```
24
_ _ ____ ____ _ _
35
| | (_)_ __ _ ___ _| _ \ ___ / ___| ___ _ __(_)_ __ | |_ ___
@@ -17,121 +19,192 @@
1719
<p>
1820
<a href="https://discord.gg/n2pErsD7Kg">Discord</a>
1921
·
20-
<a href="https://linuxdo-scripts.zishu.me">文档</a>
22+
<a href="https://linuxdo-scripts.zishu.me">使用文档</a>
2123
·
2224
<a href="https://github.com/ezyshu/linuxdo-scripts/issues/new/choose">问题反馈</a>
2325
·
2426
<a href="https://github.com/ezyshu/linuxdo-scripts/releases/latest">最新版本</a>
2527
</p>
2628

2729
<p>
28-
<img src="https://img.shields.io/github/v/release/ezyshu/linuxdo-scripts?label=Version">
29-
<img src="https://img.shields.io/github/stars/ezyshu/linuxdo-scripts?style=flat&label=Github%20Stars">
30-
<img src="https://img.shields.io/chrome-web-store/users/fbgblmjbeebanackldpbmpacppflgmlj?style=flat&label=Chrome%20Web%20Store">
31-
<img src="https://img.shields.io/github/license/ezyshu/linuxdo-scripts?style=flat&">
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=最后提交">
3235
</p>
3336
</div>
3437

35-
![Visitor Count](https://profile-counter.glitch.me/ezyshu-linuxdo-scripts/count.svg)
38+
## 📖 项目简介
3639

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

39-
LinuxDo Scripts 是一个功能丰富的浏览器扩展,旨在提升 LinuxDo 论坛的使用体验。它集成了多项实用功能,从基础的界面优化到高级的 AI 辅助功能,让您的论坛浏览和互动体验更加流畅和高效。
42+
### ✨ 核心亮点
43+
- 🎨 **界面美化** - 多种主题皮肤,个性化定制
44+
- 🤖 **AI 智能** - 话题总结、智能回复生成
45+
- 📚 **内容管理** - 收藏夹、用户标签、内容过滤
46+
-**体验优化** - 快捷操作、自动化功能
47+
- 🔧 **高度可定制** - 支持自定义 CSS、快捷回复等
4048

41-
| 设置面板 | 操作指示 |
42-
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
43-
| ![image](https://github.com/user-attachments/assets/8824696c-f2d4-4cfd-8273-901a3d007a39) | ![image](https://github.com/user-attachments/assets/a052a816-3209-4e3d-ba5d-252b6518bf55) |
49+
![功能展示](https://github.com/user-attachments/assets/13b83ca0-3927-4261-8e29-15e152de4846)
4450

45-
## ✨ 主要特性
51+
<details>
52+
<summary>📸 更多截图展示</summary>
53+
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)
57+
58+
</details>
4659

47-
### 🔍 浏览体验优化
48-
- 话题列表显示创建时间
49-
- 显示楼层数
50-
- 新标签页打开话题
51-
- 在话题列表直接预览详情及评论
52-
- 中英文混排优化显示
53-
- 优化签名图显示,防止图裂
54-
- 自动切换黑夜模式
60+
## 📥 快速安装
5561

56-
### 📚 内容管理
57-
- 完善的收藏夹功能
58-
- 用户标签功能
59-
- 强制屏蔽(拉黑)指定用户的话题
60-
- 只看楼主切换功能
62+
### 🌐 支持的浏览器
6163

62-
### 💬 互动增强
63-
- 话题快捷回复(支持自定义)
64-
- 评论框表情优化
65-
- 楼层抽奖功能
66-
- 等级信息查询
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) | 无需翻墙 |
69+
70+
### 🚀 安装步骤
71+
1. 点击上方对应浏览器的安装链接
72+
2. 在扩展商店中点击"添加到浏览器"
73+
3. 确认安装权限
74+
4. 访问 [LinuxDo 论坛](https://linux.do) 开始使用
6775

68-
### 🤖 AI 智能
69-
- AI 话题总结
70-
- 智能生成回复
71-
- AI 辅助回帖
76+
## ✨ 功能特性
7277

73-
### 🎨 个性化
74-
- 切换论坛主题皮肤
75-
- 切换论坛表情风格
76-
- 支持自定义 CSS 样式
77-
- 设置面板数据同步
78+
### 🔍 浏览体验优化
79+
- ⏰ 话题列表显示创建时间
80+
- 🏢 显示楼层数和楼主标识
81+
- 🆕 新标签页打开话题
82+
- 👀 话题列表直接预览详情及评论
83+
- 📝 中英文混排优化显示
84+
- 🖼️ 优化签名图显示,防止图片损坏
85+
- 🌙 自动切换黑夜模式
86+
- 📱 超长显示器宽度优化
7887

79-
## 📥 安装使用
88+
### 📚 内容管理
89+
- ⭐ 完善的收藏夹功能
90+
- 🏷️ 用户标签系统
91+
- 🚫 强制屏蔽指定用户话题
92+
- 👑 只看楼主切换功能
93+
- 🔍 关键词和标签过滤
94+
- 📅 按时间屏蔽旧帖子
8095

81-
### 浏览器支持
82-
- **Chrome / Edge / Arc / Brave**[Chrome Web Store](https://chromewebstore.google.com/detail/fbgblmjbeebanackldpbmpacppflgmlj)
83-
- **国内用户**[Crx 商店](https://www.crxsoso.com/webstore/detail/fbgblmjbeebanackldpbmpacppflgmlj)
84-
- **Firefox**[Firefox Addons](https://addons.mozilla.org/zh-CN/firefox/addon/linux_do-scripts/)
96+
### 💬 互动增强
97+
- ⚡ 话题快捷回复(支持自定义模板)
98+
- 😊 评论框表情优化
99+
- 📊 等级信息查询
100+
- 👍 快捷点赞按钮
101+
- 🔄 自动展开回复
102+
103+
### 🤖 AI 智能助手
104+
- 📋 AI 话题总结
105+
- 💡 智能生成回复
106+
- 🤝 AI 辅助回帖
107+
- 🎯 内容智能分析
108+
109+
### 🎨 个性化定制
110+
- 🎭 多种论坛主题皮肤
111+
- 😀 论坛表情风格切换
112+
- 🎨 自定义 CSS 样式支持
113+
- ☁️ 设置数据云端同步
114+
- 🖼️ 自定义论坛 Logo
115+
- 📑 自定义标签页图标和标题
116+
117+
### � 实用工具
118+
- 📸 话题转图片分享
119+
- 📄 论坛文章导出
120+
- ⬆️ 返回顶部/直达一楼
121+
- 🔕 快速免打扰帖子
122+
- 🎯 查看自己的回复楼层
85123

86124
## 🛠️ 开发指南
87125

88-
### 环境要求
89-
```
90-
node: v22.12.0
91-
```
126+
### 📋 环境要求
127+
- **Node.js**: `v22.12.0`
128+
- **包管理器**: npm
92129

93-
### 本地开发
94-
1. 克隆仓库并安装依赖:
95-
```shell
96-
git clone https://github.com/ezyshu/linuxdo-scripts
130+
### 🚀 本地开发
131+
132+
```bash
133+
# 1. 克隆项目
134+
git clone https://github.com/ezyshu/linuxdo-scripts.git
135+
cd linuxdo-scripts
136+
137+
# 2. 安装依赖
97138
npm install
98-
```
99139

100-
2. 启动开发服务:
101-
```shell
140+
# 3. 启动开发服务
102141
npm run dev
103142
```
104143

105-
3. 加载扩展:
106-
- 打开本地 `.output` 文件夹
107-
-`chrome-mv3` 文件夹拖拽到 `chrome://extensions/`
144+
### 📦 加载扩展
145+
1. 打开浏览器扩展管理页面
146+
- Chrome: `chrome://extensions/`
147+
- Firefox: `about:addons`
148+
2. 开启"开发者模式"
149+
3. 点击"加载已解压的扩展程序"
150+
4. 选择项目根目录下的 `.output/chrome-mv3` 文件夹
108151

109-
### 开发说明
110-
- 采用组件化开发模式
111-
- 每个新功能以独立组件形式开发,避免冲突
112-
- 提交 PR 后将进行代码审核,无重大问题将尽快合并
152+
### 🏗️ 项目架构
153+
```
154+
linuxdo-scripts/
155+
├── entrypoints/ # 入口文件
156+
├── components/ # Vue 组件
157+
├── public/ # 静态资源
158+
├── docs/ # 文档
159+
├── i18n/ # 国际化文件
160+
└── package.json # 项目配置
161+
```
113162

114-
## 🚀 贡献者
163+
### 💡 开发规范
164+
- 🧩 **组件化开发**: 每个功能独立组件,避免冲突
165+
- 📝 **代码规范**: 遵循 ESLint 配置
166+
- 🔄 **提交流程**: PR → 代码审核 → 合并
167+
- 📚 **文档更新**: 新功能需同步更新文档
115168

116-
![Contributor](https://contrib.rocks/image?repo=ezyshu/linuxdo-scripts)
169+
## 🤝 参与贡献
117170

118-
## 🤝 贡献指南
171+
### 🎯 贡献方式
172+
- 🐛 [报告 Bug](https://github.com/ezyshu/linuxdo-scripts/issues/new?template=bug_report.yml)
173+
- 💡 [功能建议](https://github.com/ezyshu/linuxdo-scripts/issues/new?template=feature_report.yml)
174+
- 🔧 [提交代码](https://github.com/ezyshu/linuxdo-scripts/pulls)
175+
- 🙍‍♂️ [加入讨论](https://discord.gg/n2pErsD7Kg)
119176

120-
欢迎提出新的功能想法和改进建议!您可以通过以下方式参与项目:
121-
- 提交 Issue 报告问题或提出建议
122-
- 提交 Pull Request 贡献代码
123-
- 加入 Discord 社区参与讨论
177+
### 👥 贡献者
178+
![Contributors](https://contrib.rocks/image?repo=ezyshu/linuxdo-scripts)
124179

125-
## ⭐️ Star History
180+
## 📊 项目统计
126181

182+
### ⭐ Star History
127183
[![Star History Chart](https://api.star-history.com/svg?repos=ezyshu/linuxdo-scripts&type=Timeline)](https://www.star-history.com/#ezyshu/linuxdo-scripts&Timeline)
128184

129-
## 📄 许可证
185+
## 📄 开源协议
130186

131-
本项目基于 MIT 许可证开源,详细信息请查看 [LICENSE](LICENSE) 文件
187+
本项目采用 [Apache License 2.0](https://github.com/ezyshu/linuxdo-scripts/blob/main/LICENSE) 开源协议
132188

133-
## 📖 免责声明
189+
**您可以自由地:**
190+
- ✅ 使用、复制、修改和分发本软件
191+
- ✅ 用于商业目的
192+
- ✅ 在遵循协议的前提下重新授权
134193

135-
本项目是一个免费且开源的项目,但并不保证其完全无BUG,使用前请自行承担风险;使用时请遵守相关法律法规,不得滥用。
194+
**但需要:**
195+
- 📋 保留原始版权声明
196+
- 📋 标明对原始代码的修改
136197

137-
如果有任何侵权行为,请联系 [ezyshu](https://github.com/ezyshu),将会及时处理。
198+
## ⚠️ 免责声明
199+
200+
- 本项目为**免费开源**项目,不保证绝对完善无误
201+
- 使用前请自行评估风险,遵守相关法律法规
202+
- 严禁任何形式的滥用行为
203+
- 如有侵权问题,请联系 [ezyshu](https://github.com/ezyshu) 及时处理
204+
205+
---
206+
207+
<div align="center">
208+
<p>如果这个项目对您有帮助,请考虑给我们一个 ⭐ Star!</p>
209+
<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>
210+
</div>

0 commit comments

Comments
 (0)