Skip to content

Commit

Permalink
style: inline quoting code, language linting
Browse files Browse the repository at this point in the history
  • Loading branch information
YuevUwU committed Sep 21, 2024
1 parent bc7906d commit 64f0b99
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/SCAICT-uwu/command/class.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ description: 本頁面包括新增、發送、領取特殊身分組
- 限制使用權限:true
- admin only

> ```add_class {class_code} {name} {theme}{teacher}{time}```
> `add_class {class_code} {name} {theme}{teacher}{time}`
- class_code:兌換代碼
- name:代碼對應分送的身分組名稱
Expand Down
6 changes: 3 additions & 3 deletions docs/SCAICT-uwu/command/ctf.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ description: 找出 flag ,獲得豐厚獎勵
- 限制使用權限:true
- 允許使用的身分組:ctf 出題者

> ```/create create {title:str} {flag:str} {score:int} [limit:int] [case:bool] [start:YY-MM-DD HH:MM:SS] [end:YY-MM-DD HH:MM:SS]```
> `/create create {title:str} {flag:str} {score:int} [limit:int] [case:bool] [start:YY-MM-DD HH:MM:SS] [end:YY-MM-DD HH:MM:SS]`
- title:題目標題
- flag :該題解答,格式建議為 ```SCAICT{falg_string}```
- flag :該題解答,格式建議為 `SCAICT{falg_string}`
- score:解題後能獲得的電電點數量,現在只能選擇贈送電電點,暫時沒有以抽獎劵作為獎勵的功能
- limit:回答次數限制,未填寫為「無限次」
- case :輸入的答案是否忽略大小寫相異,大小必須吻合為 false;忽略大小寫差異為 true。預設值為 fasle,大小寫必須完全一致
Expand All @@ -25,7 +25,7 @@ description: 找出 flag ,獲得豐厚獎勵
- 限制使用權限:true
- 允許使用的身分組:ctf 出題者

>```/ctf delete {qid} {channel_id} {key}```
>`/ctf delete {qid} {channel_id} {key}`
- qid:每道 CTF 的唯一 ID ,會顯示在該題目的下方
- channel_id:該題目的題目說明和按鈕存在的頻道,如果題目在討論串發布,需要在討論串列表右鍵點選「複製討論串 ID」
Expand Down
6 changes: 3 additions & 3 deletions docs/SCAICT-uwu/command/point.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ description: 獲得、查詢自己的電電點

## 你有有多少電電點

> ```/check_point```
> `/check_point`
- 限制使用權限:false

無須攜帶任何參數,會檢索指令發起人當前的連續登入、電電點數量狀態

## 每日充電

> ```/charge```
> `/charge`
- 限制使用權限:false

```/charge```是獲得電電點最簡單的管道,每天可以到 ```#每日充電``` 頻道使用這個命令,會直接拿到 5 電電點,連續登入的話或許會有特別的獎勵?
`/charge`是獲得電電點最簡單的管道,每天可以到 `#每日充電` 頻道使用這個命令,會直接拿到 5 電電點,連續登入的話或許會有特別的獎勵?
4 changes: 2 additions & 2 deletions docs/SCAICT-uwu/command/send-gift.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ description: 贈送禮物

# /dm_gift

> ```dm_gift {target_str...} {電電點 | 抽獎券} {贈送物品數量}```
> `dm_gift {target_str...} {電電點 | 抽獎券} {贈送物品數量}`
- 限制使用權限:true
- admin only

## 描述

這個指令可以選擇多個使用者統一發送相同數量的電電點或抽獎券,第一個參數 ```target_str``` 要填入 Discord 使用者名稱,**不是**顯示名稱。下圖框選起來的部分才是使用者名稱
這個指令可以選擇多個使用者統一發送相同數量的電電點或抽獎券,第一個參數 `target_str` 要填入 Discord 使用者名稱,**不是**顯示名稱。下圖框選起來的部分才是使用者名稱

![DCid](../../../static/img/DCid.png)
2 changes: 1 addition & 1 deletion docs/SCAICT-uwu/dev/about-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ description: 介紹一下

以下是中電喵專案的檔案樹,為了篇幅省略了一些小檔案或不重要的資料夾(如 `.git` ),這裡著重定義資料夾之間的相對關係。

```
```plaintext
| app.py
| main.py
| requirements.txt
Expand Down
6 changes: 3 additions & 3 deletions docs/SCAICT-uwu/dev/code/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ description: 管理者指令
# admin_role

admin_role 裡面的指令使用都和伺服器管理有關,大部分都是擁有伺服器最高管理權限的帳號才可以使用的指令。使用前應該先檢查發起命令的使用者:
```ctx.author.guild_permissions.administrator```
`ctx.author.guild_permissions.administrator`
若得到 false 應該直接拒絕執行。

## 發送禮物指令

使用 ```discord.utils.find``` 搜尋使用者名並發起私訊傳送獎勵按鈕,因為遍歷需要花一點時間,所以呼叫 ```await ctx.defer()``` 先在 Discord 顯示中電喵正在思考,避免回應超時被 Discord kill 掉。
使用 `discord.utils.find` 搜尋使用者名並發起私訊傳送獎勵按鈕,因為遍歷需要花一點時間,所以呼叫 `await ctx.defer()` 先在 Discord 顯示中電喵正在思考,避免回應超時被 Discord kill 掉。

Discord 會在按鈕傳送時給每個按鈕一個唯一 ID,btnID (即是訊息 ID),中電喵會把 btnID、獎品類型、贈送數量、收件者存入 gift 表格。

Expand All @@ -37,7 +37,7 @@ DB> describe gift;
- 禮物送錯人怎麼辦?
- 刪除私訊的禮物按鈕(未實裝)
- 刪除 SQL 資料庫裡面對應的資料,建議使用唯一的 btnID 比對直接刪除,如果不確定 btnID 必須使用至少兩個 column 的狀態比對精準刪除(例如收件人名稱和 btnID),否則可能會誤刪資料
- 刪除範例:```DELETE FROM `gift` WHERE `btnID`={btnID} AND recipient={somebody}```
- 刪除範例:`DELETE FROM`gift` WHERE `btnID`={btnID} AND recipient={somebody}`

### ~~事故~~(故事)

Expand Down
6 changes: 3 additions & 3 deletions docs/SCAICT-uwu/dev/maintain.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,16 @@ nohup flask run &>/var/log/uwuStore/Log_$(date +%Y-%m-%dT%H-%M-%S).log&

執行後 CLI 會顯示 Process ID,下面的例子是開啟了一個 Process ID 為 48763 的工作。這個 ID 是唯一的,用來辨別這個運行的工作。每次開啟服務後建議寫在記事本,下次關服務會比較好找到這個服務。

```
```bash
[2] 48763
```

## 關閉長時間運作的服務

關閉用 htop 運行中的服務,可以使用:

- ```kill <Process ID>```
- ```htop```找到要關閉的 Process 按下 F9
- `kill <Process ID>`
- `htop`找到要關閉的 Process 按下 F9

![htop-demo](../../../static/img/htop.png)

Expand Down
18 changes: 9 additions & 9 deletions docs/SCAICT-uwu/dev/new-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ git clone https://github.com/SCAICT/SCAICT-uwu.git

## 更新 apt install

```
```bash
sudo apt update
sudo apt upgrade -y
```
Expand All @@ -36,13 +36,13 @@ sudo apt upgrade -y

<Tabs groupId="operating-systems">
<TabItem value="win" label="Windows">
```
```cmd
winget install Python.Python.3.11
```
或是到 [Python 官網](https://www.python.org/downloads/windows/)
</TabItem>
<TabItem value="linux" label="linux">
```
```bash
sudo apt install python3.11
```
</TabItem>
Expand All @@ -54,20 +54,20 @@ sudo apt upgrade -y

<Tabs groupId="operating-systems">
<TabItem value="win" label="Windows">
```
```cmd
pip3 install virtualenv
```
</TabItem>
<TabItem value="linux" label="linux">
```
```bash
apt install python3-virtualenv
```
</TabItem>
</Tabs>

<Tabs groupId="operating-systems">
<TabItem value="win" label="Windows">
```
```cmd
python -m virtualenv env-uwu
.\env-uwu\Scripts\activate &:: Path in project root
pip install -r requirements.txt
Expand Down Expand Up @@ -110,7 +110,7 @@ GRANT SELECT, INSERT, UPDATE, DELETE ON `Discord`.* TO `user`@`%`;
flask run
```

這預設會在 ```http://127.0.0.1:5000``` 開啟網頁服務。若需要讓外網可以連接,我們推薦使用 Nginx 作為網站伺服器
這預設會在 `http://127.0.0.1:5000` 開啟網頁服務。若需要讓外網可以連接,我們推薦使用 Nginx 作為網站伺服器

### DNS 定向

Expand All @@ -125,9 +125,9 @@ sudo apt install nginx

### 撰寫組態檔

`/etc/nginx/sites-available/` 目錄下新增一個新的 config 檔,以網域名稱當作檔名,這裡以網域 ```store.scaict.org``` 舉例:
`/etc/nginx/sites-available/` 目錄下新增一個新的 config 檔,以網域名稱當作檔名,這裡以網域 `store.scaict.org` 舉例:

```
```nginx
server {
listen 80;
server_name store.scaict.org;
Expand Down

0 comments on commit 64f0b99

Please sign in to comment.