docs: update docs

修改了文档
This commit is contained in:
fhzit 2025-02-04 22:34:02 +08:00
parent 30c620422c
commit 214a7cfb8b
28 changed files with 232 additions and 33 deletions

View File

@ -3,5 +3,7 @@ import { navbar } from "vuepress-theme-hope";
export const zhNavbar = navbar([ export const zhNavbar = navbar([
"/", "/",
"/app/", "/app/",
"/management/" "/web/",
"/management/",
"/community/",
]); ]);

View File

@ -28,42 +28,39 @@ export const zhSidebar = sidebar({
], ],
}, },
], ],
"/management/": [ "/web/": [
{ {
text: "集控和网页版应用帮助", text: "网页端",
children: [ children: [
"README.md", "README.md",
{
text: "ExamCloud 云配置",
collapsible: true,
expanded: true,
prefix: "examcloud/",
children: [
"client-identify.md",
],
icon: "fa-solid fa-file-lines"
},
{
text: "ExamShowboard 配置",
collapsible: true,
expanded: true,
prefix: "examshowboard/",
children: [
"static-config.md",
],
icon: "fa-solid fa-file-lines"
},
{ {
text: "ExamSchedule 配置", text: "ExamSchedule 配置",
collapsible: true, collapsible: true,
expanded: true, expanded: true,
prefix: "examschedule/", prefix: "examschedule/",
children: [ children: [
"management-config.md", "web-deploy.md",
], ],
icon: "fa-solid fa-file-lines" icon: "fa-solid fa-file-lines"
}, },
], ],
}, },
], ],
"/management/": [
{
text: "集控",
children: [
"README.md",
],
},
],
"/community/": [
{
text: "社区",
children: [
"README.md",
"rules.md"
],
},
],
}); });

View File

@ -38,7 +38,7 @@ export default hopeTheme({
sidebar: zhSidebar, sidebar: zhSidebar,
// autocorrect-disable // autocorrect-disable
footer: "Copyright (c) 2024 ExamAware | " + footer: "Copyright (c) 2025 ExamAware | " +
'本文档以 CC BY-NC-SA 4.0 许可协议授权。', '本文档以 CC BY-NC-SA 4.0 许可协议授权。',
// autocorrect-enable // autocorrect-enable

View File

@ -10,7 +10,7 @@ heroImageStyle:
bgImageStyle: bgImageStyle:
background-attachment: fixed background-attachment: fixed
heroText: ExamAware 文档 heroText: ExamAware 文档
tagline: 示当前时间与考试详细信息的工具 tagline: 一款展示当前时间与考试详细信息的工具
actions: actions:
- text: 使用说明 - text: 使用说明
icon: lightbulb icon: lightbulb
@ -21,7 +21,7 @@ actions:
link: https://github.com/ExamAware/ link: https://github.com/ExamAware/
- text: GitHub 仓库 - text: GitHub 仓库
link: https://github.com/ExamAware/dsz-exam-showboard link: https://github.com/ExamAware/ExamAware2-Desktop
--- ---
@ -47,13 +47,23 @@ ExamAware 系列软件是显示当前时间与考试详细信息的工具,可
<div class="vp-card-container"> <div class="vp-card-container">
<VPCard <VPCard
title="桌面应用帮助" title="桌面应用帮助"
desc="了解应用的基本使用方法。" desc="了解应用的基本使用方法。"
link="./app/" link="./app/"
/> />
<VPCard <VPCard
title="集控和网页版应用帮助" title="网页端应用帮助"
desc="查看这部分文档包含了关于集控的帮助,以及网页版应用部署的教程。" desc="查看这部分文档包含了关于网页段应用帮助和部署的教程。"
link="./web/"
/>
<VPCard
title="集控帮助"
desc="查看这部分文档包含了关于集控帮助和部署的教程。"
link="./management/" link="./management/"
/> />
<VPCard
title="社区"
desc="了解如何参与 ExamAware 社区。"
link="./community/"
/>
</div> </div>

View File

@ -1,5 +1,5 @@
--- ---
title: 桌面端应用帮助 title: 桌面端
index: false index: false
icon: lightbulb icon: lightbulb
category: category:

18
src/community/README.md Normal file
View File

@ -0,0 +1,18 @@
---
icon: users
index: true
---
# 讨论社区
> [!warning]
> 要加入讨论社区,您需要遵循相应讨论社区的[社区规范](./rules.md)。
您也可以加入这些社区**寻求帮助**
- [QQ 群](https://qm.qq.com/q/zDiEipHsaI)
这个群组比较活跃,平时灌水比较多,!!~~并且有些抽象~~!!。喜欢闲聊的用户也可以加入这个群组。
- [GitHub Discussions](https://github.com/ExamAware/ExamAware2-Desktop/discussions)
您也可以来 GitHub Discussion 提问以及和其它成员交流。
如果您确定您遇到的问题是一个 **Bug**,或者您要提出一项**新的功能**,请[提交 Issue](https://github.com/ExamAware/ExamAware2-Desktop/issues/new/choose)。

View File

@ -0,0 +1,61 @@
---
icon: code-commit
---
# 向 ClassIsland 文档做贡献
::: warning 注意
本文章是面向 _**ClassIsland 文档**_ 贡献者的贡献指南。如果您要为 **ClassIsland 本体** 做出贡献,请参阅 [ClassIsland 贡献指南](https://github.com/ClassIsland/ClassIsland/blob/master/CONTRIBUTING.md)。
:::
<img src="./image/contributing/Firefly_Sticker_01.png"
width="85"
alt="流萤 - 比心"/>
本文档的建设离不开广大用户的支持,感谢您考虑为本文档做出贡献❤️!在为本文档贡献之前,请先阅读本指南。
本文档基于 [VuePress](https://vuepress.vuejs.org/) 搭建。了解 [VuePress](https://vuepress.vuejs.org/) 的用法对编写本文档很有帮助。
本文档目前托管在 [GitHub Pages](https://pages.github.com/) 上。
## 贡献准则
- 使用小写文件名
VuePress 对 URL 链接大小写敏感,使用包含大写字母的文件名可能会出现一些问题。在命名文档和文件夹时请使用小写字母,并用`-`分割每个单词,例如:
``` plaintext
example-doc.md
example-folder/
|- another-doc.md
```
- 将图片放置在仓库文件中
插入图片时请尽量直接将源文件插入到仓库文件中,不使用额外的 CDN / 图床承载图片,以便发布文档时自动将图片等文件打包到 GitHub Pages 上。插入的图片请放置在 `(文档目录)/image/(文档文件名)`下,例如:
``` plaintext
example-doc.md
example-doc-2.md
image/
|- example-doc/
| |- image1.png
| |- image2.png
|- example-doc-2/
|- image1.png
|- image2.png
```
- 编写简单易读的文档
在编写文档时请尽量做到简单易读。必要时可以插入图片、Mermaid 图表等便于读者理解。
## 合并更改
您可以向本项目发起 [Pull Request](https://github.com/ClassIsland/classisland-docs-next/pulls) 来合并您的更改。在发起 Pull Request 时,请简要地描述您做的更改。
更改合并以后,您可以在 [最新版文档](https://classisland.github.io/classisland-docs-next/) 中看到您的更改。
## 还有疑问?
您可以[加入 QQ 群](https://qm.qq.com/q/4NsDQKiAuQ)与开发者和其他用户讨论。

Binary file not shown.

After

Width:  |  Height:  |  Size: 249 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 285 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

80
src/community/rules.md Normal file
View File

@ -0,0 +1,80 @@
---
author: HelloWRC
icon: scale-balanced
---
# 社区规范
> [!note]
> 本规则适用于 ExamAware QQ 群组。
<img src="./image/rules/1732327850480.png"
width="85"
alt="光辉矢愿_遨游"/>
欢迎来到 ExamAware 用户交流社区!您可以在这里讨论 ExamAware 软件相关内容,或者提出问题,也可以吹水闲聊。为保证良好的交流环境,在交流时请遵守以下规则:
## 基本
1. 交流时请遵守相关法律法规,禁止发布以下内容:
- 涉黄、涉赌、涉毒、恐怖暴力等违法违规内容
- 涉政、涉宗等敏感言论
- 侵犯他人隐私或冒充他人的内容
- 其它违反相关法律法规的内容
2. 禁止发布包含病毒、木马等恶意内容的文件和链接。
3. 可以适度复读,不得单人刷屏。
4. 在邀请机器人进群时请先征得管理员同意。
5. 不要频繁催更。
6. 不提倡讨论 LGBTQ 相关内容。
7. 如果您不确定您要发的东西会不会违反上述规定,那最好就别发。
## 提问/求助
1. 提问前请在这些地方查找您要问的问题:
- [本文档](https://docs.classisland.tech)
- [常见问题](../app/faq/faq.md)
- [Issues](https://github.com/ExamAware/ExamAware2-Desktop/issues?q=is%3Aissue)
- 搜索引擎([必应](https://cn.bing.com/)、[百度](https://www.baidu.com/)等)
如果这些地方没能解答您的问题,再在社区里提问。
> [!note]
> 如果您的问题能轻易地在上面列举的链接中通过搜索等方式找到,很可能没有人会回答您的提出的问题。
2. 提问和求助时请提供足够的信息,提供越多有效信息越能得到帮助。您至少应该提供这些信息:
- 系统环境(如操作系统版本等)
- [程序日志](../app/faq/reporting-issue.md#收集日志)
- 错误堆栈信息(如有)
> 在没有错误日志的情况下诊断任何问题无异于闭眼开车
> —— Apache 官方文档 Gettings Started 篇章
3. 如果您要反馈软件的 Bug或者要提出一个功能请求建议[提交一个 Issue](https://github.com/ExamAware/ExamAware2-Desktop/issues/)。开发者可能会遗漏在聊天里提出的 Bug 反馈和功能请求。
如果您不知道如何有效、精准地表述您的问题,我们建议您先阅读[《提问的智慧》](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md)。
## 违规处理
如果您违反上述规定,可能会视情节轻重受到下述处罚:
- 口头警告、撤回违规内容
- 禁言4h -> 24h -> 14d
- 移出群聊并添加黑名单
处罚力度会随着违规次数增加而升级。如果您对处理结果有异议,请在处理后 48 小时内联系管理员申诉。
如果您发现讨论区有发现异常情况,可以通过私聊向管理员反映。
## 结语
感谢您对本规范的支持与配合!希望大家能共同营造一个友好、和谐的交流社区。
::: right
Hello8693
2025 年 1 月 4 日
:::

View File

@ -1,5 +1,5 @@
--- ---
title: 集控和网页版应用帮助 title: 集控
index: false index: false
icon: server icon: server
category: category:

31
src/web/README.md Normal file
View File

@ -0,0 +1,31 @@
---
title: 网页端
index: false
icon: server
category:
- 使用指南
---
由于 ExamAware 桌面端受限制于框架问题,无法在除[指定系统平台](/app/setup.md)外上运行。因此,为了更好地满足用户需求,我们推出了网页端应用。
<a id="get-started"></a>
## 开始使用
本应用支持多种方式部署。您可以根据情况自由选择部署方式。
<a id="get-started-static"></a>
### 使用静态配置文件
您可以手动编写集控配置文件,并将其托管到静态网站上。
[🚀入门教程](examschedule/management-config.md)
<a id="get-started-server"></a>
### 集控服务器
[🚀入门教程](examcloud/client-identify.md)
<a id="get-started-compare"></a>

View File

@ -1,4 +1,4 @@
# 部署网页 # 部署教程
## 前置条件 ## 前置条件

View File

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 66 KiB

View File

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View File

Before

Width:  |  Height:  |  Size: 98 KiB

After

Width:  |  Height:  |  Size: 98 KiB

View File

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

View File

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 66 KiB

View File

Before

Width:  |  Height:  |  Size: 85 KiB

After

Width:  |  Height:  |  Size: 85 KiB

View File

Before

Width:  |  Height:  |  Size: 85 KiB

After

Width:  |  Height:  |  Size: 85 KiB

View File

Before

Width:  |  Height:  |  Size: 169 KiB

After

Width:  |  Height:  |  Size: 169 KiB

View File

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

View File

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 31 KiB

View File

Before

Width:  |  Height:  |  Size: 111 KiB

After

Width:  |  Height:  |  Size: 111 KiB

View File

Before

Width:  |  Height:  |  Size: 85 KiB

After

Width:  |  Height:  |  Size: 85 KiB

View File

Before

Width:  |  Height:  |  Size: 1.1 MiB

After

Width:  |  Height:  |  Size: 1.1 MiB