Skip to content

Commit 15e3a19

Browse files
committed
初步整理静态文件
1 parent 1d5a775 commit 15e3a19

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+1287
-561
lines changed
Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,24 @@
1-
---
2-
sidebar_position: 3
3-
---
41
# 了解 Class Widgets
52

63
本文档将为您介绍 Class Widgets 的界面和基本操作。
74
## 小组件(主界面)
85

9-
![widget.png](./widget.png)
6+
![widget.png](/about/widget.png)
107

118
启动 Class Widgets 后,您将看到小组件会从屏幕顶部飞入。小组件将会显示设置好的课程表及当前日程。
129
若需要暂时隐藏 Class Widgets,单击无功能的小组件后小组件将会收起并露出底部。若想再次显示,仅需点击小组件底部。
1310
若想完全隐藏 Class Widgets,请右键[托盘菜单](#托盘菜单)并点击“显示/隐藏主界面”即可,若想恢复,再次点击该按钮即可。
1411
小组件也支持自定义,详见[“自定义”](#自定义)
1512
## 托盘菜单
1613

17-
![tray.png](./tray.png)
14+
![tray.png](/about/tray.png)
1815

1916
Class Widgets 启动后会在系统托盘区创建托盘图标,右键即可展开托盘菜单。若您未能看到托盘图标,请点击左侧的展开按钮。
2017
单击托盘图标,可快捷地让顶部的小组件隐藏;
2118
同时,在托盘菜单中,您可以访问软件的各个功能。
2219
## 自定义
2320

24-
![Image 10.png](./Image_10.png)
21+
![Image 10.png](/about/Image_10.png)
2522

2623
您可以通过“设置”中的“自定义”板块自定义小组件显示样式和信息。您可以在下拉栏选择需要添加的小组件,并根据需要对小组件进行添加/移除,且能更改关于小组件的设置。
2724
此外还能通过拖动列表中的小组件名称来改变排列顺序。
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ sidebar_position: 1
55

66
## 👋 欢迎来到 Class Widgets 社区规范
77
欢迎加入我们的**QQ群**[698599898](https://qun.qq.com/universal-share/share?ac=1&authKey=L5dC%2B02XrjoB5ArYYGFBip7aGqTdreXdEoAb1X5%2BtQJUzwCjYd97t98xGBdsYohR&busi_data=eyJncm91cENvZGUiOiI2OTg1OTk4OTgiLCJ0b2tlbiI6InFaeGdlbnpoOHM1WHllMEp0SUNsUnZxTmdsM280K3FJRmdHbm1UNEFEUGplQk9YdUs2bXFEeWRSaGUvQUJLK2ciLCJ1aW4iOiIxOTg1NDA5NzExIn0=&data=1EBWxjW-zxlIdsZbE--bdpkjBQBz8UG_SHTt8j325Z3iawQVQKMthE6TXv-xA_VVGpTIZDMPqzpIQRfsUP4cVg&svctype=4&tempid=h5_group_info)
8-
![QQ群邀请二维码](./qq.png)
8+
![QQ群邀请二维码](/community/qq.png)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ title: 用户群聊规范
2020
- 其他未提及的敏感/违规/违法的内容
2121
2. ### 提问/求助方式
2222
提问前,请先在这些地方力所能及地查找您提出的问题:
23-
- [Class Widgets 使用文档](/user_docs)
23+
- [Class Widgets 使用文档](/instruction/)
2424
- [GitHub Issues](https://github.com/Class-Widgets/Class-Widgets/issues)
2525
- 搜索引擎(必应、百度、谷歌等)
2626

docs/dev/configuration.mdx

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
title: 配置开发环境
3+
description: 本文将为你介绍如何配置 Class Widgets 的开发环境。
4+
sidebar_position: 2
5+
---
6+
import Tabs from '@theme/Tabs';
7+
import TabItem from '@theme/TabItem';
8+
9+
## 确认系统需求
10+
11+
在配置开发环境之前,请确认您的桌面是否满足以下要求:
12+
13+
:::tip 对于 Windows 7 用户:
14+
15+
~~由于本软件采用的库(PyQt6)已不再支持 Windows 10 以下的操作系统,在将来程序的库将逐步迁移至 PyQt5 以向下兼容 Windows 7。或您也可以尝试修改 Class Widgets 的代码,并打包一份兼容版本。~~
16+
自 1.1.7-Beta4 起,软件已迁移至 PyQt5,现已全面支持 Windows 7。
17+
但对于开发者来说,我们强烈不建议使用 Windows 7 开发。
18+
:::
19+
20+
| 操作系统 | Windows 7 及以上 |
21+
| --- | --- |
22+
| 操作系统 | Windows 7 及以上 |
23+
| 运行内存 | ≥ 4 GB |
24+
25+
若已满足,您还需要安装以下开发工具:
26+
这些资源在互联网上均有大量的安装教程,故不再提供。
27+
- [Python 3.8.10](https://www.python.org/downloads/release/python-3810/)
28+
- [VS Code](https://code.visualstudio.com/)[PyCharm](https://www.jetbrains.com.cn/pycharm/) 等代码编辑器/集成开发环境
29+
- [Git](https://git-scm.com/downloads)
30+
31+
:::tip 速度受网络影响
32+
由于 Python 官网和 git 官网服务器均在国外,下载速度可能极慢。您可以使用镜像站下载。
33+
这里列出了一些镜像站供您选用:
34+
- 华为云
35+
Python:https://mirrors.huaweicloud.com/python/
36+
Git for Windows:https://mirrors.huaweicloud.com/git-for-windows/
37+
Git for macOS:https://mirrors.huaweicloud.com/git-for-macos/
38+
- 阿里云
39+
Python:https://mirrors.aliyun.com/python-release/
40+
:::
41+
42+
## 获取 Class Widgets
43+
44+
### 克隆 Class Widgets
45+
46+
若您要参与 Class Widgets 的开发,则需要克隆 Class Widgets 的代码到本地。以构建您的 Class Widgets 可执行文件,且便于调试插件。
47+
您可以在 GitHub 中复刻(Fork)此项目的副本,再进行 Git 到本地开始开发。
48+
可使用 Windows 自带的“命令行”或“终端”或 VS Code 进行克隆(三种方式任选):
49+
若您希望克隆您复刻的副本,请以您复刻的仓库
50+
首先,在资源管理器中打开要克隆到本地的文件夹,然后在地址栏输入 `cmd`
51+
52+
![](/dev/config-cmd.png)
53+
54+
打开命令行之后即可任选下面三种方式克隆:
55+
<Tabs><TabItem value="https" label="HTTPS" default>
56+
```
57+
58+
git clone https://github.com/{repo_owner}/Class-Widgets.git
59+
60+
```
61+
</TabItem>
62+
<TabItem value="ssh" label="SSH">
63+
```
64+
65+
git clone [email protected]:{repo_owner}/Class-Widgets.git
66+
67+
```
68+
</TabItem>
69+
<TabItem value="ghcli" label="GitHub CLI">
70+
```
71+
72+
gh repo clone {repo_owner}/Class-Widgets
73+
74+
```
75+
</TabItem>
76+
</Tabs>
77+
### 安装 Requirements (依赖)
78+
79+
在刚才执行克隆操作的命令行中输入
80+
81+
```
82+
pip install -r requirements.txt
83+
```
84+
85+
:::tip 速度受网络影响
86+
由于要从国外的服务器下载软件,速度可能极慢。
87+
这里列出了一些镜像站供您选用:
88+
- 华为云 `https://mirrors.huaweicloud.com/repository/pypi/simple`
89+
- 阿里云 `http://mirrors.aliyun.com/pypi/simple/`
90+
- 清华大学 `https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple`
91+
92+
使用如下命令配置镜像源:
93+
```
94+
pip config set global.index-url URL
95+
```
96+
只需要把 `URL` 替换为上面的镜像地址即可。
97+
:::
98+
99+
## 运行 Class Widgets
100+
101+
完成上述操作后,即可按照接下来的步骤运行您的 Class Widgets。
102+
1. 打开 VS Code
103+
2. 点击“打开文件夹”并选择 您克隆的位置
104+
105+
![](/dev/config-open.png)
106+
107+
3. 即可打开 Class Widgets 项目
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)