Merge pull request #2 from ExpTechTW/cdps

docs/cdps/develop/index.mdx

@@ -5,7 +5,7 @@ sidebar_position: 6
 # 開發
 - 這是關於開發 `CDPS` 的文件，如果是要開發擴充 [點擊這裡](../plugin/index.mdx)
 :::note
-- 如果是一般用戶，可以略過這裡(快跑!!!)
+- 如果是一般用戶，可以略過這裡(快跑！！！)
 :::
 
 
@@ -18,4 +18,9 @@ sidebar_position: 6
 :::tip
 - 開發時應保持 `簡潔` 的原則。
 - 若非所有用戶所需之功能，可以參考利用 [Inject 注入](../more/inject.mdx) 的方式實現。
-:::
+:::
+
+## 貢獻者
+<a href="https://github.com/ExpTechTW/CDPS/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=ExpTechTW/CDPS" />
+</a>

docs/cdps/more/focus-load.mdx → docs/cdps/more/focus_load.mdx

@@ -9,6 +9,9 @@ sidebar_position: 5
 - 這個選項通常不需要使用。
 - 如果不清楚此選項用意，不要輕易使用。
 :::
+:::tip
+- 通常在使用了 `Inject 注入` 的擴充中，需要啟用此功能，確保 `Inject 注入` 完成。
+:::
 
 ## 用法
 - 在 `cdps.json` 中 聲明

docs/cdps/more/index.mdx

@@ -10,8 +10,8 @@ sidebar_position: 7
 - [目錄樹](./tree.mdx)
 - [多執行緒(threading)](./thread.mdx)
 - [Inject 注入](./inject.mdx)
-- [完全載入](./focus-load.mdx)
-- [優先載入](./pre-load.mdx)
+- [完全載入](./focus_load.mdx)
+- [優先載入](./pre_load.mdx)
 - [版本管理](./version.mdx)
 - [依賴關係](./dependencies.mdx)
 - [PyPI 依賴](./pip.mdx)

docs/cdps/more/thread.mdx

@@ -7,7 +7,7 @@ sidebar_position: 3
 
 ## task_run
 - 捕獲 Plugin Loader 傳入的 stop_event
-### <span style={{ color: 'red' }}>❗不推薦的做法</span>
+#### <span style={{ color: 'red' }}>❗不推薦的做法</span>
 :::tip
 - 在 CDPS `>= 1.0.18` 後，有更好的方法 使用threading 請看 [裝飾器](#new_thread)。
 :::

docs/cdps/plugin/event.mdx

@@ -7,7 +7,7 @@ sidebar_position: 2
 
 ## register_listener
 - 定義一個 Listener 後，向 事件管理器 註冊
-### <span style={{ color: 'red' }}>❗不推薦的做法</span>
+#### <span style={{ color: 'red' }}>❗不推薦的做法</span>
 :::tip
 - 在 CDPS `>= 1.0.15` 後，有更好的方法 註冊事件 請看 [裝飾器](#event_listener)
 :::

docs/cdps/plugin/index.mdx

@@ -4,7 +4,7 @@ sidebar_position: 5
 
 # 擴充開發
 
-- 並不是所有想要的功能，都有人開發，如果有能力，不妨試試動手做看看!!!
+- 並不是所有想要的功能，都有人開發，如果有能力，不妨試試動手做看看！！！
 
 ## 準備
 - - [x] Python ( 推薦 `>= 3.10.0` )

docs/cdps/plugin/more.mdx

@@ -3,5 +3,5 @@ sidebar_position: 5
 ---
 
 # 更多
-- 更多你可能還想知道的東西!!!
+- 更多你可能還想知道的東西！！！
 - [點擊前往](../more/index.mdx)

docs/cdps/plugins/color_log.mdx

@@ -0,0 +1,30 @@
+---
+sidebar_position: 6
+---
+
+# color_log `1.0.2`
+:::danger
+- 使用了 `Inject 注入` [點擊查看](../more/inject.mdx)
+:::
+:::caution
+- 使用了 `完全載入(focus-load)` [點擊查看](../more/focus_load.mdx)
+:::
+:::info
+- 使用了 `優先載入(pre-load)` [點擊查看](../more/pre_load.mdx)
+:::
+:::note
+- 此 擴充 使用 `Inject 注入` 修改 CDPS 的原生 Log 方法，可能導致 Log 問題，請謹慎使用。
+:::
+### 作者
+- [`YuYu1015`](https://github.com/whes1015)
+### 說明
+- CDPS 的 顏色 Log 輸出
+## 依賴
+### CDPS 依賴
+| 名稱 | 版本 |
+| --------- | ---------- |
+| `CDPS`|  `>= 1.0.18`  |
+### PyPI 依賴
+- 無
+## 原始碼
+- [GitHub](https://github.com/ExpTechTW/CDPS-color_log)

docs/cdps/plugins/discordwebhook.mdx

@@ -0,0 +1,18 @@
+---
+sidebar_position: 3
+---
+
+# discordwebhook `1.0.1`
+## 作者
+- [`PiscesXD`](https://github.com/PiscesXD)
+## 說明
+- Discord Webhook
+## 依賴
+### CDPS 依賴
+| 名稱 | 版本 |
+| --------- | ---------- |
+| `CDPS`|  `>= 1.0.13`  |
+### PyPI 依賴
+- 未知
+## 原始碼
+- [GitHub](https://github.com/PiscesXD/cdps-discordwebhook)

docs/cdps/plugins/example.mdx

@@ -0,0 +1,21 @@
+---
+sidebar_position: 2
+---
+
+# example `1.0.0`
+:::tip
+- 以此為基礎，設計自己的 擴充 吧！！！
+:::
+### 作者
+- [`YuYu1015`](https://github.com/whes1015)
+### 說明
+- CDPS 的 範例擴充
+## 依賴
+### CDPS 依賴
+| 名稱 | 版本 |
+| --------- | ---------- |
+| `CDPS`|  `>= 1.0.18`  |
+### PyPI 依賴
+- 未知
+## 原始碼
+- [GitHub](https://github.com/ExpTechTW/CDPS-ExamplePlugin)

docs/cdps/plugins/index.mdx

@@ -6,24 +6,10 @@ sidebar_position: 4
 - 這裡紀錄著 可供使用的擴充
 
 ## 索引
-### [工具](#工具)
-- CDPS-ExamplePlugin
-### [api](#api)
-- CDPS-DiscordWebhook
-### [資料](#資料)
-- CDPS-report
-
-## 工具
-### [CDPS-ExamplePlugin](https://github.com/ExpTechTW/CDPS-ExamplePlugin)
-#### 作者 [`YuYu1015`](https://github.com/whes1015)
-- CDPS 的 範例擴充
-
-## api
-### [CDPS-DiscordWebhook](https://github.com/PiscesXD/cdps-discordwebhook)
-#### 作者 [`PiscesXD`](https://github.com/PiscesXD)
-- Discord Webhook
-
-## 資料
-### [CDPS-report](https://github.com/ExpTechTW/CDPS-report)
-#### 作者 [`Yoyo0901`](https://github.com/Yoyochou0901)
-- CDPS 接收地震報告
+### 工具
+- [example](./example.mdx)
+- [discordwebhook](./discordwebhook.mdx)
+- [color_log](./color_log.mdx)
+- [websocketclient](./websocketclient.mdx)
+### 資料
+- [report](./report.mdx)

docs/cdps/plugins/report.mdx

@@ -0,0 +1,21 @@
+---
+sidebar_position: 4
+---
+
+# report `1.0.1`
+:::note
+- 此 擴充 使用了已經遺棄的方法，不能在 CDPS `>= 1.0.18` 的版本上執行。
+:::
+### 作者
+- [`Yoyo0901`](https://github.com/Yoyochou0901)
+### 說明
+- CDPS 接收地震報告
+## 依賴
+### CDPS 依賴
+| 名稱 | 版本 |
+| --------- | ---------- |
+| `CDPS`|  `>= 1.0.13`  |
+### PyPI 依賴
+- 未知
+## 原始碼
+- [GitHub](https://github.com/ExpTechTW/CDPS-report)

docs/cdps/plugins/websocketclient.mdx

@@ -0,0 +1,26 @@
+---
+sidebar_position: 5
+---
+
+# websocketclient `1.0.4`
+:::caution
+- 使用了 `完全載入(focus-load)` [點擊查看](../more/focus_load.mdx)
+:::
+:::info
+- 使用了 `優先載入(pre-load)` [點擊查看](../more/pre_load.mdx)
+:::
+### 作者
+- [`yayacat`](https://github.com/yayacat)
+### 說明
+- CDPS 的 websocket client擴充
+## 依賴
+### CDPS 依賴
+| 名稱 | 版本 |
+| --------- | ---------- |
+| `CDPS`|  `>= 1.0.18`  |
+### PyPI 依賴
+| 名稱 | 版本 |
+| --------- | ---------- |
+| `websocket-client`|  `>= 1.8.0`  |
+## 原始碼
+- [GitHub](https://github.com/ExpTechTW/CDPS-websocketclient)

docs/cdps/release/index.mdx

@@ -5,36 +5,36 @@ sidebar_position: 8
 # 更新日誌
 - 這裡紀錄著，各個版本的更新內容
 
-# 1.0.19 (Draft)
-### 🐞 修正
+## 1.0.19 (Draft)
+#### 🐞 修正
 - Log `__init__` 覆蓋天數的問題
 ---
-# 1.0.18
-### 🌟 新增
+## 1.0.18
+#### 🌟 新增
 - pip 依賴檢查
 - [`@new_thread`](../more/thread.mdx#new_thread) 裝飾器
-### 🐞 修正
+#### 🐞 修正
 - Config 類不是 單例類 的問題
 :::caution
 - plugin 內的 `task` 現在改為 `task_run` [參考這裡](../more/thread.mdx#task_run)
 :::
 ---
-# 1.0.17 (hotfix)
-### 🐞 修正
+## 1.0.17 (hotfix)
+#### 🐞 修正
 - 初始化崩潰
 ---
-# 1.0.16 (hotfix)
-### 🐞 修正
+## 1.0.16 (hotfix)
+#### 🐞 修正
 - 初始化崩潰
 ---
-# 1.0.15
-### 🌟 新增
+## 1.0.15
+#### 🌟 新增
 - 事件 裝飾器
 - `onCommandEvent`
 - `cdps version` ( In Program Command )
 - `cdps exit` ( In Program Command )
 - `cdps plugin reload {plugin}` ( In Program Command )
-### 🔌 優化
+#### 🔌 優化
 - Command 錯誤處理方式
-### 🐞 修正
+#### 🐞 修正
 - Log 錯字

i18n/ja/docusaurus-plugin-content-docs/current/cdps/command/index.mdx

@@ -0,0 +1,51 @@
+---
+sidebar_position: 3
+---
+
+# コマンド
+- CDPSは簡単なCLIツールを提供して、対応する操作を実行します。
+:::note
+- ソースコード以下のコマンドは、`cdps`を`python main.py`に置き換える必要があります。
+:::
+
+## CDPSのヘルプメッセージを表示
+- `-h` `--help`
+```bash
+cdps -h
+```
+:::note
+- 子コマンドのヘルプメッセージを見ることができます。
+- 例：`cdps pack -h`
+:::
+
+## CDPSのバージョンを表示
+- `-v` `--version`
+```bash
+cdps -v
+```
+
+## CDPSの初期化
+```bash
+cdps init
+```
+
+## CDPSの起動
+- `パラメータなし` `start`
+```bash
+cdps start
+```
+
+## デフォルト設定 (config.yml) を再生成
+```bash
+cdps gendefault
+```
+
+## パッケージング
+```bash
+cdps pack --name {フォルダ名}
+```
+
+## ホットリロード
+```bash
+cdps plugin reload {フォルダ名}
+```

i18n/ja/docusaurus-plugin-content-docs/current/cdps/config/index.mdx

@@ -0,0 +1,17 @@
+---
+sidebar_position: 2
+---
+
+# 設定
+- あなたのCDPSサーバーをカスタマイズします。
+
+## 設定ファイル
+- `./config.yml`
+```yml
+version: 1           # 設定ファイルのバージョン番号
+
+# "DEBUG" , "INFO" , "WARN" , "ERROR"
+log_level: "DEBUG"   # ログレベル
+
+log_save_days: 7     # ログの保存期間（日数）
+```

i18n/ja/docusaurus-plugin-content-docs/current/cdps/develop/index.mdx

@@ -0,0 +1,20 @@
+---
+sidebar_position: 6
+---
+
+# 開発
+- これは `CDPS` の開発に関するドキュメントです。拡張機能の開発については[こちらをクリックしてください](../plugin/index.mdx)。
+:::note
+- 一般ユーザーの場合、このセクションはスキップしてください（急いで！）。
+:::
+
+## ソースコードからの起動
+- ソースコードをクローンします。
+- ルートディレクトリで `python main.py` を実行して CDPS を起動します。
+
+## 貢献
+- GitHub で [PR](https://github.com/ExpTechTW/CDPS/pulls) を提出します。
+:::tip
+- 開発時は `シンプル` であるべきです。
+- すべてのユーザーに必要な機能でない場合、[Inject 注入](../more/inject.mdx)を利用して実装することができます。
+:::