Skip to content

Commit

Permalink
docs: minors
Browse files Browse the repository at this point in the history
  • Loading branch information
zhangt2333 committed Jul 13, 2024
1 parent 440f348 commit b9d5609
Show file tree
Hide file tree
Showing 6 changed files with 69 additions and 51 deletions.
7 changes: 7 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
* text=auto
* text eol=lf

# Don't do anything with binaries
*.png binary
*.jpg binary
*.svg binary
*.jpeg binary

*.js linguist-language=Java
*.css linguist-language=Java
*.ts linguist-language=Java
Expand Down
15 changes: 7 additions & 8 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: gh-pages

on:
workflow_dispatch: # add manually button
workflow_dispatch: # allow running this workflow manually from the Actions tab
push:
branches:
- main
Expand All @@ -22,26 +22,25 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- uses: actions/setup-node@v3
with:
node-version: 18
cache: "yarn"
cache-dependency-path: website/yarn.lock

- name: Setup Pages
id: pages
uses: actions/configure-pages@v3

- name: Build
run: |
cd website
yarn
yarn build
- name: Setup Pages
uses: actions/configure-pages@v5

- name: Upload artifact
uses: actions/upload-pages-artifact@v2
uses: actions/upload-pages-artifact@v3
with:
path: "./website/build"

Expand All @@ -54,4 +53,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
uses: actions/deploy-pages@v4
55 changes: 31 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,31 @@
<p align="center">
[中文]
<a href="./README_EN.md">[English]</a>
简体中文
|
<a href="./README_EN.md">English</a>
</p>


<br>

<img align="right" src="website/static/img/sduoj-logo.svg" width=200 />

*如果觉得对您有帮助或者对该产品感兴趣,请您给点一个 Star,谢谢!*

# SDUOJ/[Online Judge](https://sduoj.online)
# SDUOJ/[Online Judge](https://docs.sduoj.com)

[![Java](https://img.shields.io/badge/Java-8-informational)](http://openjdk.java.net/)
[![WebSite](https://img.shields.io/website?up_message=sduoj.online&url=https%3A%2F%2Fsduoj.online%2F)](https://sduoj.online/)
[![WebSite](https://img.shields.io/website?up_message=docs.sduoj.com&url=https%3A%2F%2Fdocs.sduoj.com%2F)](https://docs.sduoj.com/)
[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-2.1.12-success)](https://spring.io/projects/spring-boot)
[![Spring Cloud](https://img.shields.io/badge/Spring%20Cloud-Greenwich.SR5-success)](https://spring.io/projects/spring-cloud)
[![Spring Cloud Alibaba](https://img.shields.io/badge/Spring%20Cloud%20Alibaba-2.1.2-success)](https://spring.io/projects/spring-cloud-alibaba)
[![MySQL](https://img.shields.io/badge/MySQL-8-blue)](https://www.mysql.com/)
[![Vue](https://img.shields.io/badge/Vue-2.6.11-success)](https://vuejs.org/)
[![License](https://img.shields.io/github/license/SDUOJ/OnlineJudge)](https://github.com/SDUOJ/OnlineJudge/blob/main/LICENSE)
[![Github Star](https://img.shields.io/github/stars/SDUOJ?style=social)](https://github.com/SDUOJ/OnlineJudge)
[![Github Star](https://img.shields.io/github/stars/SDUOJ/OnlineJudge?style=social)](https://github.com/SDUOJ/OnlineJudge)

> SDUOJ 是一款开源在线评测系统(Online Judge, OJ)
>
> [→ 查看文档](https://sduoj.online)
> [→ 查看文档](https://docs.sduoj.com)
>
<br />
Expand All @@ -46,7 +48,7 @@
</table>


### 概览
## 概览

* 基于 Docker,公有云或物理机,均可一键部署!
* 前后端分离,分布式微服务架构,可单独对某个服务动态扩缩容以应对不同场景的流量压力!
Expand All @@ -59,7 +61,7 @@
* 多评测点,单独赋分,动态调整测试点的顺序,直接选取测试点作为题面样例点!
* ~~虚拟评测,支持世界上多个知名 OJ 系统的远程提交,让训练数据沉淀到一方系统,为未来传承宝贵的数据资产!~~

### 项目仓库
## 项目仓库

| 仓库 | 描述 |
| ------------------------------------------------------------ | ------------------------------------ |
Expand All @@ -71,9 +73,9 @@
| [SDUOJ/sduoj-sandbox](https://github.com/SDUOJ/sduoj-sandbox) | 安全沙箱代码仓库 |
| [SDUOJ/sduoj-deploy](https://github.com/SDUOJ/sduoj-deploy) | 部署代码仓库,含 Docker Compose 脚本 |

### 网站截图
## 网站截图

[用户使用手册](https://sduoj.online/docs/manual/user/home)
[用户使用手册](https://docs.sduoj.com/docs/manual/user/home)

<img src="website/static/img/home/image-20201122210911513.png" style="zoom:80%;" />

Expand Down Expand Up @@ -106,21 +108,26 @@

</details>

### 搭建指南
## 搭建指南

架构图:<img src="website/static/img/home/image-20201122204545807.png" width=650 align="center"/>

[如何基于 Docker Compose 快速部署?](https://sduoj.online/docs/deployment/docker-compose)
[如何基于 Docker Compose 快速部署?](https://docs.sduoj.com/docs/deployment/docker-compose)

### 浏览器支持
## 浏览器支持

For Vue frontend:
- Modern browsers (chrome, firefox) 和 Internet Explorer 10+.

For React frontend:
- Microsoft Edge (85+), Google Chrome (85+), Mozilla Firefox (79+), Apple Safari (13.4+), Internet Explorer is not supported

### 技术团队
## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=SDUOJ/OnlineJudge&type=Date)](https://star-history.com/#SDUOJ/OnlineJudge&Date)

## 技术团队

<table>
<tr>
<td align="center">
Expand Down Expand Up @@ -151,21 +158,21 @@ For React frontend:
<br />
<a href="https://github.com/koi2000" target="_blank">koi2000</a>
<br />
<strong> Backend </strong>
<strong> Honorary MBR. </strong>
</td>
<td align="center">
<img src="https://github.com/HYLazy.png?s=64" width="65px;"/>
<br />
<a href="https://github.com/HYLazy" target="_blank">HYLazy</a>
<br />
<strong> Backend </strong>
<strong> Honorary MBR. </strong>
</td>
<td align="center">
<img src="https://github.com/zhaoyifan0528.png?s=64" width="65px;"/>
<br />
<a href="https://github.com/zhaoyifan0528" target="_blank">zhaoyifan0528</a>
<br />
<strong> Backend </strong>
<strong> Honorary MBR. </strong>
</td>
</tr>
<tr>
Expand All @@ -174,21 +181,21 @@ For React frontend:
<br />
<a href="https://github.com/OldAtaraxia" target="_blank">OldAtaraxia</a>
<br />
<strong> Backend </strong>
<strong> Honorary MBR. </strong>
</td>
<td align="center">
<img src="https://github.com/zhr2001.png?s=64" width="65px;"/>
<br />
<a href="https://github.com/zhr2001" target="_blank">zhr2001</a>
<br />
<strong> Frontend </strong>
<strong> Honorary MBR. </strong>
</td>
<td align="center">
<img src="https://github.com/sys16384.png?s=64" width="65px;"/>
<br />
<a href="https://github.com/sys16384" target="_blank">sys16384</a>
<br />
<strong> Plagiarism Detection </strong>
<strong> Honorary MBR. </strong>
</td>
</tr>
<tr>
Expand All @@ -197,28 +204,28 @@ For React frontend:
<br />
<a href="https://github.com/GeneLiuXe" target="_blank">GeneLiuXe</a>
<br />
<strong> Honorary Mem. </strong>
<strong> Honorary MBR. </strong>
</td>
<td align="center">
<img src="https://github.com/suxb201.png?s=64" width="65px;"/>
<br />
<a href="https://github.com/suxb201" target="_blank">suxb201</a>
<br />
<strong> Honorary Mem. </strong>
<strong> Honorary MBR. </strong>
</td>
<td align="center">
<img src="https://github.com/Xrvitd.png?s=64" width="65px;"/>
<br />
<a href="https://github.com/Xrvitd" target="_blank">Xrvitd</a>
<br />
<strong> Honorary Mem. </strong>
<strong> Honorary MBR. </strong>
</td>
</tr>
</table>



### 许可
## 开源许可

基于 [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.en.html) 开源协议。

39 changes: 22 additions & 17 deletions README_EN.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
<p align="center">
<a href="./README.md">[中文]</a>
[English]
<a href="./README.md">简体中文</a>
|
English
</p>
<br>

<img align="right" src="website/static/img/sduoj-logo.svg" width=200 />

*If you find this helpful or interesting, please give it a star. Thank you!*

# SDUOJ/[Online Judge](https://sduoj.online)
# SDUOJ/[Online Judge](https://docs.sduoj.com)

[![Java](https://img.shields.io/badge/Java-8-informational)](http://openjdk.java.net/)
[![WebSite](https://img.shields.io/website?up_message=sduoj.online&url=https%3A%2F%2Fsduoj.online%2F)](https://sduoj.online/)
[![WebSite](https://img.shields.io/website?up_message=docs.sduoj.com&url=https%3A%2F%2Fdocs.sduoj.com%2F)](https://docs.sduoj.com/)
[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-2.1.12-success)](https://spring.io/projects/spring-boot)
[![Spring Cloud](https://img.shields.io/badge/Spring%20Cloud-Greenwich.SR5-success)](https://spring.io/projects/spring-cloud)
[![Spring Cloud Alibaba](https://img.shields.io/badge/Spring%20Cloud%20Alibaba-2.1.2-success)](https://spring.io/projects/spring-cloud-alibaba)
[![MySQL](https://img.shields.io/badge/MySQL-8-blue)](https://www.mysql.com/)
[![Vue](https://img.shields.io/badge/Vue-2.6.11-success)](https://vuejs.org/)
[![License](https://img.shields.io/github/license/SDUOJ/OnlineJudge)](https://github.com/SDUOJ/OnlineJudge/blob/main/LICENSE)
[![Github Star](https://img.shields.io/github/stars/SDUOJ?style=social)](https://github.com/SDUOJ/OnlineJudge)
[![Github Star](https://img.shields.io/github/stars/SDUOJ/OnlineJudge?style=social)](https://github.com/SDUOJ/OnlineJudge)

> SDUOJ is an open-source online judge (OJ)
>
> [→ View Documentation](https://sduoj.online)
> [→ View Documentation](https://docs.sduoj.com)
>
<br />
Expand Down Expand Up @@ -73,7 +74,7 @@

### Website Screenshots

[See User Manual](https://sduoj.online/docs/manual/user/home)
[See User Manual](https://docs.sduoj.com/docs/manual/user/home)

<img src="website/static/img/home/image-20201122210911513.png" style="zoom:80%;" />

Expand Down Expand Up @@ -110,7 +111,7 @@

Architecture diagram:<img src="website/static/img/home/image-20201122204545807.png" width=650 align="center"/>

[How to deploy quickly based on Docker Compose?](https://sduoj.online/docs/deployment/docker-compose)
[How to deploy quickly based on Docker Compose?](https://docs.sduoj.com/docs/deployment/docker-compose)

## Browser Support

Expand All @@ -120,6 +121,10 @@ For Vue frontend:
For React frontend:
- Microsoft Edge (85+), Google Chrome (85+), Mozilla Firefox (79+), Apple Safari (13.4+), Internet Explorer is not supported

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=SDUOJ/OnlineJudge&type=Date)](https://star-history.com/#SDUOJ/OnlineJudge&Date)

## Our Team
<table>
<tr>
Expand Down Expand Up @@ -151,21 +156,21 @@ For React frontend:
<br />
<a href="https://github.com/koi2000" target="_blank">koi2000</a>
<br />
<strong> Backend </strong>
<strong> Honorary MBR. </strong>
</td>
<td align="center">
<img src="https://github.com/HYLazy.png?s=64" width="65px;"/>
<br />
<a href="https://github.com/HYLazy" target="_blank">HYLazy</a>
<br />
<strong> Backend </strong>
<strong> Honorary MBR. </strong>
</td>
<td align="center">
<img src="https://github.com/zhaoyifan0528.png?s=64" width="65px;"/>
<br />
<a href="https://github.com/zhaoyifan0528" target="_blank">zhaoyifan0528</a>
<br />
<strong> Backend </strong>
<strong> Honorary MBR. </strong>
</td>
</tr>
<tr>
Expand All @@ -174,21 +179,21 @@ For React frontend:
<br />
<a href="https://github.com/OldAtaraxia" target="_blank">OldAtaraxia</a>
<br />
<strong> Backend </strong>
<strong> Honorary MBR. </strong>
</td>
<td align="center">
<img src="https://github.com/zhr2001.png?s=64" width="65px;"/>
<br />
<a href="https://github.com/zhr2001" target="_blank">zhr2001</a>
<br />
<strong> Frontend </strong>
<strong> Honorary MBR. </strong>
</td>
<td align="center">
<img src="https://github.com/sys16384.png?s=64" width="65px;"/>
<br />
<a href="https://github.com/sys16384" target="_blank">sys16384</a>
<br />
<strong> Plagiarism Detection </strong>
<strong> Honorary MBR. </strong>
</td>
</tr>
<tr>
Expand All @@ -197,21 +202,21 @@ For React frontend:
<br />
<a href="https://github.com/GeneLiuXe" target="_blank">GeneLiuXe</a>
<br />
<strong> Honorary Mem. </strong>
<strong> Honorary MBR. </strong>
</td>
<td align="center">
<img src="https://github.com/suxb201.png?s=64" width="65px;"/>
<br />
<a href="https://github.com/suxb201" target="_blank">suxb201</a>
<br />
<strong> Honorary Mem. </strong>
<strong> Honorary MBR. </strong>
</td>
<td align="center">
<img src="https://github.com/Xrvitd.png?s=64" width="65px;"/>
<br />
<a href="https://github.com/Xrvitd" target="_blank">Xrvitd</a>
<br />
<strong> Honorary Mem. </strong>
<strong> Honorary MBR. </strong>
</td>
</tr>
</table>
Expand Down
2 changes: 1 addition & 1 deletion website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const config = {
favicon: "img/sduoj-logo.svg",

// Set the production url of your site here
url: "https://sduoj.online",
url: "https://docs.sduoj.com",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: "/",
Expand Down
2 changes: 1 addition & 1 deletion website/i18n/en/docusaurus-theme-classic/footer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"copyright": {
"message": "GNU Affero General Public License v3.0 | Copyright © 2020-2023 SDUOJ Team. All Rights Reserved.",
"message": "GNU Affero General Public License v3.0 | Copyright © 2020-2024 SDUOJ Team. All Rights Reserved.",
"description": "The footer copyright"
}
}

0 comments on commit b9d5609

Please sign in to comment.