diff --git a/README.md b/README.md index c14a8b5..a36e16f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # ExamAware 文档 -这是 [ExamAware 文档](https://github.com/ExamAware/ExamAware-docs) 仓库。本文档基于 [VuePress](https://vuejs.press/) 搭建，[在线查看文档](https://examaware.gdata.fun)。 +这是 [ExamAware 文档](https://github.com/ExamAware/ExamAware-docs) 仓库。本文档基于 [VuePress](https://vuejs.press/) 搭建，引入[VuePress Theme Hope](https://theme-hope.vuejs.press/zh/)主题，[查看在线文档](https://examaware.gdata.fun)。 ## 开始之前 @@ -28,6 +28,15 @@ 5. 在浏览器中访问终端输出的链接（默认是[http://localhost:8080](http://localhost:8080)），即可浏览文档。当本地文档做出更改时，浏览器中的文档将自动刷新。 +## 常用命令 +| 命令 | 作用 | +|-|-| +| `npm run docs:build` | 构建项目，生成静态文件 | +| `npm run docs:clean-dev` | 启动开发服务器并清除缓存 | +| `npm run docs:dev` | 启动开发服务器，支持热更新 | +| `npm run docs:update-package` | 更新 VuePress 和相关依赖包 | +| `npm run export-pdf` | 将文档导出为 PDF 文件 | + 本文档使用了 vuepress-plugin-md-enhance 的一些扩展语法，请尽量直接编辑 Markdown 文件，而不是使用可视化 Markdown 编辑器。建议使用 [Visual Studio Code](https://code.visualstudio.com/) 编辑文档。 diff --git a/package.json b/package.json index 37cd607..0f21ce2 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "ExamAware-docs-next", + "name": "ExamAware-docs", "description": "A project of vuepress-theme-hope", "version": "2.0.0", "license": "MIT", diff --git a/src/.vuepress/sidebar/zh.ts b/src/.vuepress/sidebar/zh.ts index e329564..060bdc4 100644 --- a/src/.vuepress/sidebar/zh.ts +++ b/src/.vuepress/sidebar/zh.ts @@ -54,7 +54,7 @@ export const zhSidebar = sidebar({ link: "index.md", children: [ { - text: "部署", + text: "部署教程", link: "deploy.md", icon: "fa-solid fa-server", }, diff --git a/src/.vuepress/theme.ts b/src/.vuepress/theme.ts index 0bee4d6..f6320d5 100644 --- a/src/.vuepress/theme.ts +++ b/src/.vuepress/theme.ts @@ -12,7 +12,7 @@ export default hopeTheme({ iconAssets: "fontawesome-with-brands", - logo: "https://avatars.githubusercontent.com/u/195304368?s=200&v=4", + logo: "/logo.png", repo: "ExamAware/ExamAware-docs", @@ -55,6 +55,13 @@ export default hopeTheme({ editLink: "在 GitHub 上编辑此页", }, + navbarIcon: { + qq: { + icon: "fab fa-qq", + link: "https://qm.qq.com/q/zDiEipHsaI", + }, + }, + // 如果想要实时查看任何改变，启用它。注：这对更新性能有很大负面影响 // hotReload: true, pure: true, diff --git a/src/community/contributing.md b/src/community/contributing.md index 4c508b1..355b6b2 100644 --- a/src/community/contributing.md +++ b/src/community/contributing.md @@ -1,16 +1,19 @@ --- +title: 贡献指南 +index: false icon: code-commit +category: + - 社区 + - 贡献 --- -# 向 ExamAware 文档做贡献 - > [!warning] > > 本页是关于 **ExamAware 文档** 的贡献指南，如果您要为 **ExamAware 系列应用** 做出贡献，请前往对应仓库。 本文档的建设离不开广大用户的支持，感谢您考虑为本文档做出贡献❤️！在为本文档贡献之前，请先阅读本指南。 -本文档基于 [VuePress](https://vuepress.vuejs.org/) 搭建。了解 [VuePress](https://vuepress.vuejs.org/) 的用法对编写本文档很有帮助。 +本文档基于 [VuePress](https://vuepress.vuejs.org/) 搭建，了解 [VuePress](https://vuepress.vuejs.org/) 的用法对编写本文档很有帮助。 本文档目前托管在 [GitHub Pages](https://pages.github.com/) 上。 diff --git a/src/community/index.md b/src/community/index.md index 971e633..5b856ea 100644 --- a/src/community/index.md +++ b/src/community/index.md @@ -1,10 +1,11 @@ --- +title: 社区 +index: false icon: users -index: true +category: + - 社区 --- -# 社区 - > [!warning] > 要加入社区，您需要遵循相应讨论社区的[社区规范](rules.md)。 diff --git a/src/community/rules.md b/src/community/rules.md index 914175c..9dc216e 100644 --- a/src/community/rules.md +++ b/src/community/rules.md @@ -1,10 +1,12 @@ --- -author: Hello8693 +title: 社区规范 +index: false icon: scale-balanced +author: Hello8693 +category: + - 社区 --- -# 社区规范 - > [!note] > > 本规范适用于 ExamAware QQ 群组。 diff --git a/src/introduction/about.md b/src/introduction/about.md index 4fa569f..646c1e9 100644 --- a/src/introduction/about.md +++ b/src/introduction/about.md @@ -6,7 +6,15 @@ category: - 关于 --- ## 项目作者 -- +- [Hello8693](https://github.com/hello8693) ## 贡献者 -- \ No newline at end of file +- [MKStoler](https://github.com/MKStoler1024) +- [jiangyin](https://github.com/jiangyin14) +- [fhzit](https://github.com/fhzit) +- [unDefFtr](https://github.com/unDefFtr) +- [Jursin](https://github.com/Jursin) +- [Alosk](https://github.com/aloisp28) + +> [!tip] +> 本组织主要开发者和贡献者基本都是初高中生。 \ No newline at end of file diff --git a/src/introduction/choose.md b/src/introduction/choose.md index 340cd05..851004a 100644 --- a/src/introduction/choose.md +++ b/src/introduction/choose.md @@ -6,9 +6,11 @@ category: - 应用 --- -## 检查系统需求 +## 检查系统版本 + +> [!note] +> 在使用桌面端或移动端时，请确保您的设备系统满足以下要求! -首先，确保您的设备系统满足以下需求： - 桌面端 - Windows 系统 - Windows 10 及以上版本，x86_64 架构 @@ -22,9 +24,13 @@ category: - iOS 系统 - iOS 13 及以上版本 -## 项目链接 +## 仓库链接 -| 平台 | 🚀 发行版 | 🚧 当前构建 | -| - | - | - | -| 移动端 | QQ 群获取 | *暂无* | -| 网页端 | [ExamSchedule-main](https://github.com/ExamAware/ExamSchedule) | [ExamSchedule-dev](https://github.com/ExamAware/ExamSchedule/tree/dev) | \ No newline at end of file +| 名称 | 简述 | 🚀 发行版 | 🚧 当前构建 | +| - | - | - | - | +| [dsz-exam-showboard](https://github.com/ExamAware/dsz-exam-showboard) | 旧桌面端应用 | [Releases](https://github.com/ExamAware/dsz-exam-showboard/releases) | [Actions](https://github.com/ExamAware/dsz-exam-showboard/actions) | +| [ExamAware2-Desktop](https://github.com/ExamAware/ExamAware2-Desktop) | 全新重构的桌面端应用***（开发中）*** | *暂无* | *暂无* | +| [ExamSchedule](https://github.com/ExamAware/ExamSchedule) | 静态版本的网页端应用 | [ExamSchedule-main](https://github.com/ExamAware/ExamSchedule) | [ExamSchedule-dev](https://github.com/ExamAware/ExamSchedule/tree/dev) | +| [ExamCloudSchedule](https://github.com/ExamAware/ExamCloudSchedule) | 考试云看板 | [Releases](https://github.com/ExamAware/ExamCloudSchedule/releases) | | +| [ExamAware2](https://github.com/ExamAware/ExamAware2) | | | | +| [dsz-examaware-mobile](https://github.com/ExamAware/dsz-examaware-mobile) | 基于旧桌面端应用构建的移动端，搁置中 | [QQ 群](https://qm.qq.com/q/zDiEipHsaI) 群文件 | | \ No newline at end of file diff --git a/src/introduction/config-edit.md b/src/introduction/config-edit.md index 01301d3..7a4ed64 100644 --- a/src/introduction/config-edit.md +++ b/src/introduction/config-edit.md @@ -8,6 +8,9 @@ category: 本应用配置文件记录了考试名称、提示信息，考试信息（科目名称、开始/结束时间、结束提醒时间）。 +> [!important] +> 本系列应用共用这一套配置文件，请仔细阅读本页配置文件编写教程！ + 您可以按照模板手动编写配置文件，也可以直接使用[配置文件编辑器（legacy）](https://github.com/ExamAware/DSZExamShowBoardEditor/releases/latest)编写配置文件。 > [!tip] diff --git a/src/management/ExamCloudSechdule.md b/src/management/ExamCloudSechdule.md new file mode 100644 index 0000000..5cdfdf1 --- /dev/null +++ b/src/management/ExamCloudSechdule.md @@ -0,0 +1,83 @@ +--- +title: 考试云看板 +index: false +icon: server +category: + - 使用指南 +--- + +[ExamCloudSechdule 考试云看板](https://github.com/ExamAware/ExamCloudSchedule) 是一个用于管理和查看考试安排的系统，包括以下几个主要功能： + +1. **考试看板配置查询**：用户可以通过输入配置 ID 来获取考试安排的详细信息。 +![ec-query.png](./images/ec-query.png) +2. **考试安排显示**：显示考试的详细安排，包括科目、开始时间和结束时间。 +![ec-exam.png](./images/ec-exam.png) +3. **管理员后台**：管理员可以登录后台管理考试配置文件，包括创建、编辑和删除配置文件。 +![ec-admin.png](./images/ec-admin.png) +4. **明暗色主题**: 随心所欲切换主题。 + +## 文件结构 + +- `/index.php`：考试看板配置查询页面。 +- `/ExamCloudSchedule`：考试安排显示页面。 +- `/admin/login.php`：管理员登录页面。 +- `/admin/index.php`：管理员后台主页，显示所有配置文件。 +- `/admin/edit.php`：编辑或创建新的考试配置文件。 +- `/admin/detete.php`: 删除指定配置文件。 +- `/includes`: 管理员认证目录。 +- `/configs`: 安排存放目录。 + +## 使用方法 + +### 考试看板配置查询 + +1. 打开根目录页面。 +2. 输入配置 ID，例如 `room301`。 +3. 点击“获取配置”按钮，查看考试安排的详细信息。 +4. 点击“进入”按钮，跳转到考试安排显示页面。 + +### 考试安排显示 + +1. 上一部操作后会打开 `ExamCloudSchedule/index.html` 页面。 +2. 页面会自动根据 URL 参数 `configId` 显示相应的考试安排。 + +### 管理员后台 + +1. 点击 `管理后台` 或者，手动打开 `admin` 目录，输入管理员用户名和密码进行登录。 +> [!tip] +> +> 管理员用户名和密码初始均为 `admin`。 + +2. 登录后，跳转到 `admin/index.php` 页面，显示所有配置文件。 +![ec-admin.png](./images/ec-admin.png) +3. 点击“新建配置”按钮，跳转到 `admin/edit.php` 页面，创建新的配置文件。 +![ec-add.png](./images/ec-add.png) +4. 在配置文件列表中，可以点击“编辑”按钮编辑配置文件，点击“删除”按钮删除配置文件，点击“预览”按钮查看配置文件的详细信息。 + +## 开发环境 + +- PHP 7.4+ +- HTML5 +- JavaScript +- CSS3 + +## 安装和运行 + +1. 克隆项目到本地 +2. 将项目文件放置到 Web 服务器的根目录下 +3. 确保 Web 服务器支持 PHP，并启动服务器 +4. 访问 `index.php` 页面，开始使用系统 + +## CodeSpace 开发提示 + +```bash +# 初始化 Codespace 时运行： + +sudo sed -i 's/Listen 80$//' /etc/apache2/ports.conf +sudo sed -i 's//ServerName 127.0.0.1\n/' /etc/apache2/sites-enabled/000-default.conf +apache2ctl start + +# 以后直接运行： + +apache2ctl start +``` \ No newline at end of file diff --git a/src/management/client-identify.md b/src/management/client-identify.md index d2dc060..450f786 100644 --- a/src/management/client-identify.md +++ b/src/management/client-identify.md @@ -1,9 +1,13 @@ -# 客户端识别 +--- +title: 客户端识别 +index: false +icon: id-card +category: + - 使用指南 +--- 您可以为每个 ExamAware 实例自定义一个 id，来标识每个实例。您可以将自定义 id 设置为班级名、教室编号等易于识别的名称。只有服务器段的 id 与客户端重复，客户端才能获得信息。 - - ## url 模板 在调用集控清单中的 url 时，ExamAware 可以根据客户端的信息，将对应信息填入 url 模板中，实现为每个 ExamAware 实例分配特定的对象。 diff --git a/src/management/images/bt01.png b/src/management/images/bt01.png deleted file mode 100644 index 77bff8a..0000000 Binary files a/src/management/images/bt01.png and /dev/null differ diff --git a/src/management/images/bt02.png b/src/management/images/bt02.png deleted file mode 100644 index eb6e9d3..0000000 Binary files a/src/management/images/bt02.png and /dev/null differ diff --git a/src/management/images/ec-add.png b/src/management/images/ec-add.png new file mode 100644 index 0000000..f1d317c Binary files /dev/null and b/src/management/images/ec-add.png differ diff --git a/src/management/images/ec-admin.png b/src/management/images/ec-admin.png new file mode 100644 index 0000000..e266959 Binary files /dev/null and b/src/management/images/ec-admin.png differ diff --git a/src/management/images/ec-exam.png b/src/management/images/ec-exam.png new file mode 100644 index 0000000..4f31a3d Binary files /dev/null and b/src/management/images/ec-exam.png differ diff --git a/src/management/images/ec-main.png b/src/management/images/ec-main.png new file mode 100644 index 0000000..d2858d5 Binary files /dev/null and b/src/management/images/ec-main.png differ diff --git a/src/management/images/ec-query.png b/src/management/images/ec-query.png new file mode 100644 index 0000000..748eba0 Binary files /dev/null and b/src/management/images/ec-query.png differ diff --git a/src/management/images/gh01.png b/src/management/images/gh01.png deleted file mode 100644 index 4f20457..0000000 Binary files a/src/management/images/gh01.png and /dev/null differ diff --git a/src/management/images/iis01.png b/src/management/images/iis01.png deleted file mode 100644 index 3a0d11d..0000000 Binary files a/src/management/images/iis01.png and /dev/null differ diff --git a/src/management/images/iis02.png b/src/management/images/iis02.png deleted file mode 100644 index f58dd49..0000000 Binary files a/src/management/images/iis02.png and /dev/null differ diff --git a/src/management/images/iis03.png b/src/management/images/iis03.png deleted file mode 100644 index 246d466..0000000 Binary files a/src/management/images/iis03.png and /dev/null differ diff --git a/src/management/images/iis04.png b/src/management/images/iis04.png deleted file mode 100644 index 3607acd..0000000 Binary files a/src/management/images/iis04.png and /dev/null differ diff --git a/src/management/images/iis05.png b/src/management/images/iis05.png deleted file mode 100644 index a7a56e5..0000000 Binary files a/src/management/images/iis05.png and /dev/null differ diff --git a/src/management/images/iis06.jpg b/src/management/images/iis06.jpg deleted file mode 100644 index 2054cb3..0000000 Binary files a/src/management/images/iis06.jpg and /dev/null differ diff --git a/src/management/images/iis07.png b/src/management/images/iis07.png deleted file mode 100644 index 85b7529..0000000 Binary files a/src/management/images/iis07.png and /dev/null differ diff --git a/src/management/images/iis08.png b/src/management/images/iis08.png deleted file mode 100644 index 984cdd3..0000000 Binary files a/src/management/images/iis08.png and /dev/null differ diff --git a/src/management/images/iis09.png b/src/management/images/iis09.png deleted file mode 100644 index 2204bde..0000000 Binary files a/src/management/images/iis09.png and /dev/null differ diff --git a/src/management/images/iis10.png b/src/management/images/iis10.png deleted file mode 100644 index 6a41327..0000000 Binary files a/src/management/images/iis10.png and /dev/null differ diff --git a/src/management/index.md b/src/management/index.md index 8165e9d..ab7b972 100644 --- a/src/management/index.md +++ b/src/management/index.md @@ -8,17 +8,10 @@ category: 学校/组织的 IT 可以通过集控功能向学校内的 ExamAware 实例统一分发时间表和科目等信息，并且可以集中调整软件设置，提高管理的便利性。 - - ## 开始使用 -本功能支持通过静态配置文件部署，也可以通过管理服务器部署。您可以根据情况自由选择部署方式。 - - - +本功能支持通过静态配置文件部署，也可以通过管理服务器部署，您可以根据情况自由选择部署方式。 ### 集控服务器 [🚀入门教程](client-identify.md) - - diff --git a/src/web/deploy.md b/src/web/deploy.md index 7a2d7b0..b45c33f 100644 --- a/src/web/deploy.md +++ b/src/web/deploy.md @@ -1,8 +1,10 @@ -# 部署教程 - -> [!important] -> -> 请先准备好配置文件，详情请参阅[编写配置文件](../introduction/config-edit.md)。 +--- +title: 部署教程 +index: false +icon: server +category: + - 使用指南 +--- ## 使用Python部署 - 确保已安装 [Python](https://www.python.org/downloads/) 环境 diff --git a/src/web/index.md b/src/web/index.md index ffdd1ad..510ce1e 100644 --- a/src/web/index.md +++ b/src/web/index.md @@ -6,11 +6,9 @@ category: - 使用指南 --- -由于 ExamAware 桌面端受限制于框架问题，无法在除[指定系统平台](../introduction/choose.md#检查系统需求)外的老旧平台系统上运行。因此，为了更好地满足用户需求，我们推出了网页端考试看板。 -![iis-10](../web/images/es.png) - - +由于 ExamAware 桌面端受限制于框架问题，无法在除[指定系统平台](../introduction/choose.md#检查系统版本)外的老旧平台系统上运行。因此，为了更好地满足用户需求，我们推出了网页端考试看板 [ExamSchedule])https://github.com/ExamAware/ExamSchedule) 。 +![ExamSchedule](../web/images/es.png) ## 功能 @@ -49,6 +47,6 @@ category: ![time](../web/images/es-time.png) -## 开始使用/如何部署？ +## 开始部署 请参阅[部署教程](../web/deploy.md)。