From 388dde36c085572419636a3067ffa447d607dd28 Mon Sep 17 00:00:00 2001 From: whes1015 Date: Tue, 4 Jun 2024 20:25:42 +0800 Subject: [PATCH 1/4] =?UTF-8?q?feat(cdps/more/event):=20=E8=87=AA=E5=AE=9A?= =?UTF-8?q?=E7=BE=A9=E4=BA=8B=E4=BB=B6=E8=A8=BB=E5=86=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/cdps/more/event.mdx | 38 +++++++++++++++++++ .../cdps/more/{events.mdx => events_list.mdx} | 0 docs/cdps/more/index.mdx | 5 ++- .../cdps/more/{events.mdx => events_list.mdx} | 0 .../current/cdps/more/index.mdx | 2 +- 5 files changed, 42 insertions(+), 3 deletions(-) create mode 100644 docs/cdps/more/event.mdx rename docs/cdps/more/{events.mdx => events_list.mdx} (100%) rename i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/{events.mdx => events_list.mdx} (100%) diff --git a/docs/cdps/more/event.mdx b/docs/cdps/more/event.mdx new file mode 100644 index 0000000..34e3cfe --- /dev/null +++ b/docs/cdps/more/event.mdx @@ -0,0 +1,38 @@ +--- +sidebar_position: 12 +--- + +# 自定義事件註冊 +- 除了 CDPS 本身，擴充 還可以分發自己的 事件。 +:::tip +- 自定義事件 是 擴充 之間，傳遞訊息的一種方式。 +::: + +## 用法 +```py +# color_log ( plugin ) 分發 Log 事件 +from cdps.plugin.events import Event # 導入 Event 基類 +from cdps.plugin.manager import Manager # 導入 擴充管理器 + +class onLogEvent(Event): # 自定義事件 + """ 當 輸出日誌 """ + + def __init__(self, log): + self.pid = log + + +event_manager = Manager() # 獲取 擴充管理器 實例 +event_manager.call_event(onLogEvent("test")) # 觸發 自定義事件 +``` +```py +# discord (plugin) 獲取分發的 Log 事件 發送到 Discord +from cdps.plugin.manager import Listener, event_listener +from plugins.color_log.main import onLogEvent # 導入上述 color_log 擴充 中的 onLogEvent 事件 + + +@event_listener(onLogEvent) # 裝飾器 +class onLogListener(Listener): + + def on_event(self, event): + print("-> {}".format(event.log)) +``` \ No newline at end of file diff --git a/docs/cdps/more/events.mdx b/docs/cdps/more/events_list.mdx similarity index 100% rename from docs/cdps/more/events.mdx rename to docs/cdps/more/events_list.mdx diff --git a/docs/cdps/more/index.mdx b/docs/cdps/more/index.mdx index 6e639e1..185d838 100644 --- a/docs/cdps/more/index.mdx +++ b/docs/cdps/more/index.mdx @@ -6,7 +6,7 @@ sidebar_position: 7 - 這裡紀錄著，一些瑣碎的東西 ## 目錄 -- [事件列表](./events.mdx) +- [事件列表](./events_list.mdx) - [目錄樹](./tree.mdx) - [多執行緒(threading)](./thread.mdx) - [Inject 注入](./inject.mdx) @@ -16,4 +16,5 @@ sidebar_position: 7 - [依賴關係](./dependencies.mdx) - [PyPI 依賴](./pip.mdx) - [日誌紀錄](./log.mdx) -- [導入 擴充 的 函數](./plugin.mdx) \ No newline at end of file +- [導入 擴充 的 函數](./plugin.mdx) +- [自定義事件註冊](./event.mdx) \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/events.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/events_list.mdx similarity index 100% rename from i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/events.mdx rename to i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/events_list.mdx diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx index 6e639e1..4dc2d41 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx @@ -6,7 +6,7 @@ sidebar_position: 7 - 這裡紀錄著，一些瑣碎的東西 ## 目錄 -- [事件列表](./events.mdx) +- [事件列表](./events_list.mdx) - [目錄樹](./tree.mdx) - [多執行緒(threading)](./thread.mdx) - [Inject 注入](./inject.mdx) From def5b09afc04cb834656c16ff5921dd080f39406 Mon Sep 17 00:00:00 2001 From: whes1015 Date: Tue, 4 Jun 2024 20:57:36 +0800 Subject: [PATCH 2/4] style(cdps): prettier --- .prettierrc | 10 +++++++ docs/cdps/command/index.mdx | 19 +++++++++++++- docs/cdps/config/index.mdx | 11 +++++--- docs/cdps/develop/index.mdx | 13 +++++++-- docs/cdps/more/dependencies.mdx | 27 ++++++++++++++----- docs/cdps/more/event.mdx | 8 +++++- docs/cdps/more/events_list.mdx | 10 ++++++- docs/cdps/more/focus_load.mdx | 16 ++++++++--- docs/cdps/more/index.mdx | 4 ++- docs/cdps/more/inject.mdx | 22 +++++++++++++++- docs/cdps/more/log.mdx | 8 +++++- docs/cdps/more/pip.mdx | 26 ++++++++++++------ docs/cdps/more/plugin.mdx | 7 ++++- docs/cdps/more/pre_load.mdx | 13 ++++++--- docs/cdps/more/thread.mdx | 18 ++++++++++--- docs/cdps/more/tree.mdx | 3 ++- docs/cdps/more/version.mdx | 16 ++++++++++- docs/cdps/plugin/event.mdx | 13 +++++++-- docs/cdps/plugin/file.mdx | 6 ++++- docs/cdps/plugin/index.mdx | 19 +++++++++++++- docs/cdps/plugin/more.mdx | 3 ++- docs/cdps/plugin/pack.mdx | 12 ++++++++- docs/cdps/plugin/start.mdx | 38 ++++++++++++++++----------- docs/cdps/plugins/color_log.mdx | 31 +++++++++++++++++++--- docs/cdps/plugins/discordwebhook.mdx | 19 +++++++++++--- docs/cdps/plugins/example.mdx | 22 +++++++++++++--- docs/cdps/plugins/index.mdx | 7 ++++- docs/cdps/plugins/report.mdx | 22 +++++++++++++--- docs/cdps/plugins/websocketclient.mdx | 33 +++++++++++++++++------ docs/cdps/release/index.mdx | 30 ++++++++++++++++++++- docs/cdps/start/index.mdx | 8 +++++- docs/cdps/start/install.mdx | 31 +++++++++++++++++++--- 32 files changed, 432 insertions(+), 93 deletions(-) create mode 100644 .prettierrc diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..27327bc --- /dev/null +++ b/.prettierrc @@ -0,0 +1,10 @@ +{ + "overrides": [ + { + "files": "*.mdx", + "options": { + "parser": "mdx" + } + } + ] +} \ No newline at end of file diff --git a/docs/cdps/command/index.mdx b/docs/cdps/command/index.mdx index be84bae..393aef8 100644 --- a/docs/cdps/command/index.mdx +++ b/docs/cdps/command/index.mdx @@ -3,49 +3,66 @@ sidebar_position: 3 --- # 指令 + - CDPS 提供簡易的 CLI 工具 執行對應操作 + :::note + - 下方指令 在 Source Code 下，需將 `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 {資料夾名稱} ``` ## 熱載入(Hot reload) + ```bash cdps plugin reload {plugin名稱} -``` \ No newline at end of file +``` diff --git a/docs/cdps/config/index.mdx b/docs/cdps/config/index.mdx index 4d64355..d68c89b 100644 --- a/docs/cdps/config/index.mdx +++ b/docs/cdps/config/index.mdx @@ -3,15 +3,18 @@ sidebar_position: 2 --- # 配置 + - 自定義你的 CDPS 伺服器 ## 配置檔 + - `./config.yml` + ```yml -version: 1 # config 版本號 +version: 1 # config 版本號 # "DEBUG" , "INFO" , "WARN" or "ERROR" -log_level: "DEBUG" # 日誌紀錄等級 +log_level: "DEBUG" # 日誌紀錄等級 -log_save_days: 7 # 日誌保留天數 -``` \ No newline at end of file +log_save_days: 7 # 日誌保留天數 +``` diff --git a/docs/cdps/develop/index.mdx b/docs/cdps/develop/index.mdx index 317e410..8e350b9 100644 --- a/docs/cdps/develop/index.mdx +++ b/docs/cdps/develop/index.mdx @@ -3,24 +3,33 @@ sidebar_position: 6 --- # 開發 + - 這是關於開發 `CDPS` 的文件，如果是要開發擴充 [點擊這裡](../plugin/index.mdx) + :::note + - 如果是一般用戶，可以略過這裡(快跑！！！) -::: +::: ## 從原始碼啟動 + - clone 原始碼 - 在根目錄中使用 `python main.py` 啟動 CDPS ## 貢獻 + - 至 GitHub 提交 [PR](https://github.com/ExpTechTW/CDPS/pulls) + :::tip + - 開發時應保持 `簡潔` 的原則。 - 若非所有用戶所需之功能，可以參考利用 [Inject 注入](../more/inject.mdx) 的方式實現。 + ::: ## 貢獻者 + - \ No newline at end of file + diff --git a/docs/cdps/more/dependencies.mdx b/docs/cdps/more/dependencies.mdx index 4ca3160..13eb980 100644 --- a/docs/cdps/more/dependencies.mdx +++ b/docs/cdps/more/dependencies.mdx @@ -3,29 +3,42 @@ sidebar_position: 8 --- # 依賴關係 + - 擴充 之間的 依賴關係 + :::note -- 這是說明 CDPS 擴充之間的依賴關係，如果要找 PyPI依賴 [點擊這裡](./pip.mdx) + +- 這是說明 CDPS 擴充之間的依賴關係，如果要找 PyPI 依賴 [點擊這裡](./pip.mdx) + ::: ## 聲明依賴 + - 在 `cdps.json` 中 聲明 + :::tip + - 依賴中 `cdps` 為必須的。 + ::: + ```json { - // ... - "dependencies": { - "cdps": ">=1.0.18" // 擴充所需的 CDPS 最低版本 - }, - // ... + // ... + "dependencies": { + "cdps": ">=1.0.18" // 擴充所需的 CDPS 最低版本 + } + // ... } ``` ## 用途 + - 檢查是否有執行擴充所需的其他擴充 + :::tip + - 舉例 `cdps_discord` 需要 `cdps_report` 來提供 地震報告 資料。 - 上述例子 `cdps_report` 就是 `cdps_discord` 所需的依賴。 -::: \ No newline at end of file + +::: diff --git a/docs/cdps/more/event.mdx b/docs/cdps/more/event.mdx index 34e3cfe..81fa7cf 100644 --- a/docs/cdps/more/event.mdx +++ b/docs/cdps/more/event.mdx @@ -3,12 +3,17 @@ sidebar_position: 12 --- # 自定義事件註冊 + - 除了 CDPS 本身，擴充 還可以分發自己的 事件。 + :::tip + - 自定義事件 是 擴充 之間，傳遞訊息的一種方式。 + ::: ## 用法 + ```py # color_log ( plugin ) 分發 Log 事件 from cdps.plugin.events import Event # 導入 Event 基類 @@ -24,6 +29,7 @@ class onLogEvent(Event): # 自定義事件 event_manager = Manager() # 獲取 擴充管理器 實例 event_manager.call_event(onLogEvent("test")) # 觸發 自定義事件 ``` + ```py # discord (plugin) 獲取分發的 Log 事件 發送到 Discord from cdps.plugin.manager import Listener, event_listener @@ -35,4 +41,4 @@ class onLogListener(Listener): def on_event(self, event): print("-> {}".format(event.log)) -``` \ No newline at end of file +``` diff --git a/docs/cdps/more/events_list.mdx b/docs/cdps/more/events_list.mdx index 69a3d3e..1cc75fa 100644 --- a/docs/cdps/more/events_list.mdx +++ b/docs/cdps/more/events_list.mdx @@ -3,21 +3,29 @@ sidebar_position: 1 --- # 事件列表 + - 查看可用的事件 ## 目錄 + - onServerStartEvent - onServerCloseEvent - onCommandEvent ## onServerStartEvent + #### 回傳參數 `pid` + - 當伺服器被啟動 ## onServerCloseEvent + #### 回傳參數 `reason(關閉原因)` + - 當伺服器被關閉 ## onCommandEvent + #### 回傳參數 `command(用戶輸入內容)` -- 當用戶輸入指令到 terminal \ No newline at end of file + +- 當用戶輸入指令到 terminal diff --git a/docs/cdps/more/focus_load.mdx b/docs/cdps/more/focus_load.mdx index dd8d1e2..c88e8f4 100644 --- a/docs/cdps/more/focus_load.mdx +++ b/docs/cdps/more/focus_load.mdx @@ -3,22 +3,30 @@ sidebar_position: 5 --- # 完全載入 + - 等待擴充完全載入後，再繼續下一步動作(載入其他擴充) :::danger + - 這個選項通常不需要使用。 - 如果不清楚此選項用意，不要輕易使用。 + ::: + :::tip + - 通常在使用了 `Inject 注入` 的擴充中，需要啟用此功能，確保 `Inject 注入` 完成。 + ::: ## 用法 + - 在 `cdps.json` 中 聲明 + ```json { - "version": "1.0.0", - "focus-load": true, // 新增這行 - // ... + "version": "1.0.0", + "focus-load": true // 新增這行 + // ... } -``` \ No newline at end of file +``` diff --git a/docs/cdps/more/index.mdx b/docs/cdps/more/index.mdx index 185d838..8d05e22 100644 --- a/docs/cdps/more/index.mdx +++ b/docs/cdps/more/index.mdx @@ -3,9 +3,11 @@ sidebar_position: 7 --- # 雜項 + - 這裡紀錄著，一些瑣碎的東西 ## 目錄 + - [事件列表](./events_list.mdx) - [目錄樹](./tree.mdx) - [多執行緒(threading)](./thread.mdx) @@ -17,4 +19,4 @@ sidebar_position: 7 - [PyPI 依賴](./pip.mdx) - [日誌紀錄](./log.mdx) - [導入 擴充 的 函數](./plugin.mdx) -- [自定義事件註冊](./event.mdx) \ No newline at end of file +- [自定義事件註冊](./event.mdx) diff --git a/docs/cdps/more/inject.mdx b/docs/cdps/more/inject.mdx index a371c3b..383521f 100644 --- a/docs/cdps/more/inject.mdx +++ b/docs/cdps/more/inject.mdx @@ -3,20 +3,29 @@ sidebar_position: 4 --- # Inject 注入 + - Server 啟動時會 觸發 `onServerStartEvent` - 如果我的 擴充 想在 `onServerStartEvent` 前做些什麼 ( 通常是自製的 `日誌擴充` 等 需要在其他擴充前 初始化完成 ) - 這時 `Inject 注入` 就登場了 - 注入新的 `onServerStartEventForExample` 讓其在 `onServerStartEvent` 前 先被執行 + :::danger + - 應謹慎使用 `Inject 注入` ，因其會破壞原生方法。 - 使用 `Inject 注入` 的擴充，應在 README 中註明，提醒使用者。 + ::: + :::note + - 使用了 `Inject 注入` 的案例 [`color_log`](https://github.com/ExpTechTW/CDPS-color_log)。 + ::: ## 原始 類(class)、方法(function) + - `cdps/plugin/events.py` + ```py class onServerStartEvent(Event): """ 當 伺服器 啟動 """ @@ -24,12 +33,16 @@ class onServerStartEvent(Event): def __init__(self, pid): self.pid = pid ``` + - `cdps/cdps_server.py` + ```py def on_start(self): self.event_manager.call_event(onServerStartEvent("start")) ``` + ## 定義新的類 + ```py from cdps.plugin.events import Event @@ -38,22 +51,29 @@ class onServerStartEventForExample(Event): def __init__(self, pid): self.pid = pid ``` + ## 保留原始方法 + ```py original_on_start = cdps.cdps_server.CDPS.on_start ``` + ## 定義新方法 + ```py def _new_on_start(self): self.event_manager.call_event(onServerStartEventForExample("example")) # 多了這行 original_on_start(self) # 呼叫原始方法 ``` + ## 注入 + ```py cdps.cdps_server.CDPS.on_start = _new_on_start ``` ## 完成看起來像這樣 + ```py from cdps.plugin.manager import Manager , Listener from cdps.plugin.events import Event @@ -80,4 +100,4 @@ class onServerStartEventForExampleListener(Listener): event_manager = Manager() event_manager.register_listener(onServerStartEventForExampleListener()) # 別忘了監聽事件 -``` \ No newline at end of file +``` diff --git a/docs/cdps/more/log.mdx b/docs/cdps/more/log.mdx index f54cbf4..d909fb1 100644 --- a/docs/cdps/more/log.mdx +++ b/docs/cdps/more/log.mdx @@ -3,13 +3,19 @@ sidebar_position: 10 --- # 日誌紀錄 + - 輸出 日誌 到 控制台 並 紀錄到 文件 中。 ## 用法 + - 獲取 log 實例 + :::tip + - Log 類 為 `單例` ，因此可以重複獲取，無需擔心重複。 + ::: + ```py from cdps.utils.logger import Log # 導入 Log 類 log = Log() # 獲取 log 實例 @@ -17,4 +23,4 @@ log.logger.debug("除錯") log.logger.info("資訊") log.logger.warning("警告") log.logger.error("錯誤") -``` \ No newline at end of file +``` diff --git a/docs/cdps/more/pip.mdx b/docs/cdps/more/pip.mdx index e24af31..8f7ba39 100644 --- a/docs/cdps/more/pip.mdx +++ b/docs/cdps/more/pip.mdx @@ -3,25 +3,35 @@ sidebar_position: 9 --- # PyPI 依賴 + - 依賴的 PyPI 套件 + :::note -- 這是說明 PyPI依賴，如果要找 CDPS 擴充之間的依賴關係 [點擊這裡](./dependencies.mdx)。 + +- 這是說明 PyPI 依賴，如果要找 CDPS 擴充之間的依賴關係 [點擊這裡](./dependencies.mdx)。 + ::: ## 聲明依賴 + - 在 `cdps.json` 中 聲明 + ```json { - // ... - "pip_dependencies": { - "websocket-client": ">=1.8.0" // 擴充所需的 CDPS 最低版本 - }, - // ... + // ... + "pip_dependencies": { + "websocket-client": ">=1.8.0" // 擴充所需的 CDPS 最低版本 + } + // ... } ``` ## 用途 -- 在 `pip_dependencies` 中 聲明 所需的 PyPI依賴，擴充管理器會檢查是否已安裝對應依賴。 + +- 在 `pip_dependencies` 中 聲明 所需的 PyPI 依賴，擴充管理器會檢查是否已安裝對應依賴。 + :::tip + - 擴充開發者，應加上此參數，避免使用者初次使用，因缺少依賴而崩潰。 -::: \ No newline at end of file + +::: diff --git a/docs/cdps/more/plugin.mdx b/docs/cdps/more/plugin.mdx index f77fee0..0e84cf6 100644 --- a/docs/cdps/more/plugin.mdx +++ b/docs/cdps/more/plugin.mdx @@ -3,12 +3,17 @@ sidebar_position: 11 --- # 導入 擴充 的 函數 + - 導入 特定擴充 中的 函數 + :::tip + - 使用絕對路徑，從 `./plugins` 開始計算。 + ::: + ```py # main.py (report plugin) from plugins.report.src.events import onReport # 導入自己的 函數 from plugins.discord_webhook import send_webhook # 導入 其他擴充 的 函數 -``` \ No newline at end of file +``` diff --git a/docs/cdps/more/pre_load.mdx b/docs/cdps/more/pre_load.mdx index 47b851f..b3b8ba1 100644 --- a/docs/cdps/more/pre_load.mdx +++ b/docs/cdps/more/pre_load.mdx @@ -3,20 +3,25 @@ sidebar_position: 6 --- # 優先載入 + - 優先被 擴充管理器 載入 :::caution + - 擴充管理器 會根據 擴充之間的依賴關係，自動調整載入順序。 - 這個選項通常不需要使用。 - 如果不清楚此選項用意，不要輕易使用。 + ::: ## 用法 + - 在 `cdps.json` 中 聲明 + ```json { - "version": "1.0.0", - "pre-load": true, // 新增這行 - // ... + "version": "1.0.0", + "pre-load": true // 新增這行 + // ... } -``` \ No newline at end of file +``` diff --git a/docs/cdps/more/thread.mdx b/docs/cdps/more/thread.mdx index 474b7b9..0888c0b 100644 --- a/docs/cdps/more/thread.mdx +++ b/docs/cdps/more/thread.mdx @@ -3,14 +3,21 @@ sidebar_position: 3 --- # 多執行緒 + - 在 擴充 中使用 threading ## task_run + - 捕獲 Plugin Loader 傳入的 stop_event -#### ❗不推薦的做法 + +#### ❗ 不推薦的做法 + :::tip -- 在 CDPS `>= 1.0.18` 後，有更好的方法 使用threading 請看 [裝飾器](#new_thread)。 + +- 在 CDPS `>= 1.0.18` 後，有更好的方法 使用 threading 請看 [裝飾器](#new_thread)。 + ::: + ```py import threading import time @@ -35,10 +42,15 @@ def task_run(stop_event): ``` ## new_thread + - 使用 裝飾器 裝飾 函數，被裝飾的函數將會在 多執行緒 中 執行。 + :::note + - 需要呼叫一次函數。 + ::: + ```py from cdps.plugin.thread import new_thread import time @@ -59,4 +71,4 @@ def loop_2(): loop_1() loop_2() -``` \ No newline at end of file +``` diff --git a/docs/cdps/more/tree.mdx b/docs/cdps/more/tree.mdx index 49392d3..b15f64f 100644 --- a/docs/cdps/more/tree.mdx +++ b/docs/cdps/more/tree.mdx @@ -3,6 +3,7 @@ sidebar_position: 2 --- # 目錄樹 + ``` CDPS/ main.py @@ -40,4 +41,4 @@ CDPS/ docs/ plugins/ tests/ -``` \ No newline at end of file +``` diff --git a/docs/cdps/more/version.mdx b/docs/cdps/more/version.mdx index 81e9daf..c984553 100644 --- a/docs/cdps/more/version.mdx +++ b/docs/cdps/more/version.mdx @@ -3,20 +3,34 @@ sidebar_position: 7 --- # 版本管理 + - 擴充作者 應做好 版本管理 ## 擴充版本命名方式 + - `X.Y.Z` + ### X 主版號 + - 應跟隨 `CDPS` 的主版號。 + :::tip + - 例如 example 擴充 `2.0.1` ，就能很明顯看出是給 CDPS `2.X.X` 使用的。 + ::: + ### Y 次版號 + - 擴充新增功能後，應增加 `次版號`，然後 `修訂號` 歸零。 + :::tip + - 1.1.5 -> 1.2.0 - 1.5.8 -> 2.0.0 + ::: + ### Z 修訂號 -- 擴充修復錯誤或問題 增加 `修訂號`。 \ No newline at end of file + +- 擴充修復錯誤或問題 增加 `修訂號`。 diff --git a/docs/cdps/plugin/event.mdx b/docs/cdps/plugin/event.mdx index e58382d..1fb6930 100644 --- a/docs/cdps/plugin/event.mdx +++ b/docs/cdps/plugin/event.mdx @@ -3,14 +3,21 @@ sidebar_position: 2 --- # 事件 + 監聽發生的事件，並做出對應回應 ## register_listener + - 定義一個 Listener 後，向 事件管理器 註冊 -#### ❗不推薦的做法 + +#### ❗ 不推薦的做法 + :::tip + - 在 CDPS `>= 1.0.15` 後，有更好的方法 註冊事件 請看 [裝飾器](#event_listener) + ::: + ```py from cdps.plugin.manager import Listener, Manager # 導入 事件管理器 及 Listener(抽象) from cdps.plugin.events import onServerStartEvent # 導入 伺服器啟動 事件 @@ -28,8 +35,10 @@ event_manager.register_listener(onServerStartListener()) # 註冊 監聽器 到 ``` ## event_listener + - 使用 裝飾器 裝飾 函數，被裝飾的函數將會作為對應事件的 回調函數。 - 傳入要監聽的事件 + ```py from cdps.plugin.events import onServerStartEvent from cdps.plugin.manager import Listener, event_listener @@ -40,4 +49,4 @@ class onServerStartListener(Listener): def on_event(self, event): print(event.pid) -``` \ No newline at end of file +``` diff --git a/docs/cdps/plugin/file.mdx b/docs/cdps/plugin/file.mdx index 9929a5e..6fe33fc 100644 --- a/docs/cdps/plugin/file.mdx +++ b/docs/cdps/plugin/file.mdx @@ -5,7 +5,9 @@ sidebar_position: 3 # 檔案讀取 ## 擴充的 config 讀取 + - 擴充給使用者的自定義設定檔 + ```py with open("./config/{擴充名稱}.json", 'r', encoding='utf-8') as file: content = file.read() @@ -13,9 +15,11 @@ with open("./config/{擴充名稱}.json", 'r', encoding='utf-8') as file: ``` ## 擴充內的檔案讀取 + - 隨擴充一起封裝，用於不會變化的文件 + ```py with open("./plugins/{擴充名稱}/test.txt", 'r', encoding='utf-8') as file: content = file.read() print(content) -``` \ No newline at end of file +``` diff --git a/docs/cdps/plugin/index.mdx b/docs/cdps/plugin/index.mdx index 6db816b..63aef45 100644 --- a/docs/cdps/plugin/index.mdx +++ b/docs/cdps/plugin/index.mdx @@ -7,37 +7,54 @@ sidebar_position: 5 - 並不是所有想要的功能，都有人開發，如果有能力，不妨試試動手做看看！！！ ## 準備 + - - [x] Python ( 推薦 `>= 3.10.0` ) - - [x] VSCode ( 或其他 IDE ) - - [x] Git - - [ ] GitHub Desktop (可選) ## 虛擬環境 + - 建議使用 Python 自帶的 虛擬環境 功能，開發擴充。 + :::note + - 使用 Source Code 執行 CDPS 的前提下。 + ::: + #### 建立 虛擬環境 + ```bash python -m venv dev ``` + #### 進入 虛擬環境 位置 + ```bash cd ./dev/Scripts ``` + #### 啟動 虛擬環境 + ```bash activate.bat ``` + #### 退回 根目錄 + ```bash cd ../../ ``` + #### 安裝相關 依賴 + ```bash pip install -r requirements.txt ``` + #### 執行 + ``` python main.py -``` \ No newline at end of file +``` diff --git a/docs/cdps/plugin/more.mdx b/docs/cdps/plugin/more.mdx index 6d8eac0..6a9723e 100644 --- a/docs/cdps/plugin/more.mdx +++ b/docs/cdps/plugin/more.mdx @@ -3,5 +3,6 @@ sidebar_position: 5 --- # 更多 + - 更多你可能還想知道的東西！！！ -- [點擊前往](../more/index.mdx) \ No newline at end of file +- [點擊前往](../more/index.mdx) diff --git a/docs/cdps/plugin/pack.mdx b/docs/cdps/plugin/pack.mdx index 00b1498..8a6764c 100644 --- a/docs/cdps/plugin/pack.mdx +++ b/docs/cdps/plugin/pack.mdx @@ -3,10 +3,13 @@ sidebar_position: 4 --- # 封裝 + - 封裝 擴充 為 `.cdps` 檔案 ## 準備 + - 資料夾看起來應該像下方這樣 + ``` example/ cdps.json // 擴充基本資訊 @@ -14,10 +17,17 @@ example/ ``` ## 指令 + - 使用 `cdps pack --name example` 打包 **example** 資料夾為 **example.cdps** 檔案 + :::note + - `--name` 後 帶上資料夾名稱 + ::: + :::tip + - Source Code 下 指令為 `python main.py pack --name example` -::: \ No newline at end of file + +::: diff --git a/docs/cdps/plugin/start.mdx b/docs/cdps/plugin/start.mdx index f4debd1..f3a742b 100644 --- a/docs/cdps/plugin/start.mdx +++ b/docs/cdps/plugin/start.mdx @@ -3,12 +3,16 @@ sidebar_position: 1 --- # 基本知識 + ## 什麼是 CDPS 擴充? + - CDPS 擴充 是位於 `./plugins` 底下以 `.cdps` 為副檔名的文件 ## 文件結構 + - `example.cdps` 改為 `example.zip` 後 解壓縮 文件結構應該如下方所示 - [下載 example.cdps](https://github.com/ExpTechTW/CDPS-ExamplePlugin/releases) + ``` example/ main.py @@ -16,7 +20,9 @@ example/ ``` ## main.py + - 擴充 的 入口點 + ```py from cdps.plugin.events import onServerStartEvent # 導入 類(class) from cdps.plugin.manager import Listener, event_listener # 導入 類(class) @@ -30,22 +36,24 @@ class onServerStartListener(Listener): # 自定義 監 ``` ## cdps.json + - 定義 擴充資訊 的文件 + ```json { - "version": "1.0.0", // 擴充版本 - "description": { - "zh_tw": "CDPS 的 範例擴充" // 擴充說明 - }, - "author": [ - "YuYu1015" // 擴充作者 - ], - "dependencies": { - "cdps": ">=1.0.18" // 擴充所需的 CDPS 最低版本 - }, - "resources": [ - "AGPL-3.0" // 擴充的開源協議 - ], - "link": "https://github.com/ExpTechTW/CDPS-ExamplePlugin" // 擴充 的 GitHub Link + "version": "1.0.0", // 擴充版本 + "description": { + "zh_tw": "CDPS 的 範例擴充" // 擴充說明 + }, + "author": [ + "YuYu1015" // 擴充作者 + ], + "dependencies": { + "cdps": ">=1.0.18" // 擴充所需的 CDPS 最低版本 + }, + "resources": [ + "AGPL-3.0" // 擴充的開源協議 + ], + "link": "https://github.com/ExpTechTW/CDPS-ExamplePlugin" // 擴充 的 GitHub Link } -``` \ No newline at end of file +``` diff --git a/docs/cdps/plugins/color_log.mdx b/docs/cdps/plugins/color_log.mdx index eae7d9a..ab95aea 100644 --- a/docs/cdps/plugins/color_log.mdx +++ b/docs/cdps/plugins/color_log.mdx @@ -3,28 +3,51 @@ 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` | + +| 名稱 | 版本 | +| ------ | ----------- | +| `CDPS` | `>= 1.0.18` | + ### PyPI 依賴 + - 無 + ## 原始碼 -- [GitHub](https://github.com/ExpTechTW/CDPS-color_log) \ No newline at end of file + +- [GitHub](https://github.com/ExpTechTW/CDPS-color_log) diff --git a/docs/cdps/plugins/discordwebhook.mdx b/docs/cdps/plugins/discordwebhook.mdx index 5b25469..021bd98 100644 --- a/docs/cdps/plugins/discordwebhook.mdx +++ b/docs/cdps/plugins/discordwebhook.mdx @@ -3,16 +3,27 @@ sidebar_position: 3 --- # discordwebhook `1.0.1` + ## 作者 + - [`PiscesXD`](https://github.com/PiscesXD) + ## 說明 + - Discord Webhook + ## 依賴 + ### CDPS 依賴 -| 名稱 | 版本 | -| --------- | ---------- | -| `CDPS`| `>= 1.0.13` | + +| 名稱 | 版本 | +| ------ | ----------- | +| `CDPS` | `>= 1.0.13` | + ### PyPI 依賴 + - 未知 + ## 原始碼 -- [GitHub](https://github.com/PiscesXD/cdps-discordwebhook) \ No newline at end of file + +- [GitHub](https://github.com/PiscesXD/cdps-discordwebhook) diff --git a/docs/cdps/plugins/example.mdx b/docs/cdps/plugins/example.mdx index df5000a..c8fa7dd 100644 --- a/docs/cdps/plugins/example.mdx +++ b/docs/cdps/plugins/example.mdx @@ -3,19 +3,33 @@ sidebar_position: 2 --- # example `1.0.0` + :::tip + - 以此為基礎，設計自己的 擴充 吧！！！ + ::: + ### 作者 + - [`YuYu1015`](https://github.com/whes1015) + ### 說明 + - CDPS 的 範例擴充 + ## 依賴 + ### CDPS 依賴 -| 名稱 | 版本 | -| --------- | ---------- | -| `CDPS`| `>= 1.0.18` | + +| 名稱 | 版本 | +| ------ | ----------- | +| `CDPS` | `>= 1.0.18` | + ### PyPI 依賴 + - 未知 + ## 原始碼 -- [GitHub](https://github.com/ExpTechTW/CDPS-ExamplePlugin) \ No newline at end of file + +- [GitHub](https://github.com/ExpTechTW/CDPS-ExamplePlugin) diff --git a/docs/cdps/plugins/index.mdx b/docs/cdps/plugins/index.mdx index 7528f95..4bca153 100644 --- a/docs/cdps/plugins/index.mdx +++ b/docs/cdps/plugins/index.mdx @@ -3,13 +3,18 @@ sidebar_position: 4 --- # 擴充 + - 這裡紀錄著 可供使用的擴充 ## 索引 + ### 工具 + - [example](./example.mdx) - [discordwebhook](./discordwebhook.mdx) - [color_log](./color_log.mdx) - [websocketclient](./websocketclient.mdx) + ### 資料 -- [report](./report.mdx) \ No newline at end of file + +- [report](./report.mdx) diff --git a/docs/cdps/plugins/report.mdx b/docs/cdps/plugins/report.mdx index 5f37f6a..18e7210 100644 --- a/docs/cdps/plugins/report.mdx +++ b/docs/cdps/plugins/report.mdx @@ -3,19 +3,33 @@ sidebar_position: 4 --- # report `1.0.1` + :::note + - 此 擴充 使用了已經遺棄的方法，不能在 CDPS `>= 1.0.18` 的版本上執行。 + ::: + ### 作者 + - [`Yoyo0901`](https://github.com/Yoyochou0901) + ### 說明 + - CDPS 接收地震報告 + ## 依賴 + ### CDPS 依賴 -| 名稱 | 版本 | -| --------- | ---------- | -| `CDPS`| `>= 1.0.13` | + +| 名稱 | 版本 | +| ------ | ----------- | +| `CDPS` | `>= 1.0.13` | + ### PyPI 依賴 + - 未知 + ## 原始碼 -- [GitHub](https://github.com/ExpTechTW/CDPS-report) \ No newline at end of file + +- [GitHub](https://github.com/ExpTechTW/CDPS-report) diff --git a/docs/cdps/plugins/websocketclient.mdx b/docs/cdps/plugins/websocketclient.mdx index cbf17b5..24fd83d 100644 --- a/docs/cdps/plugins/websocketclient.mdx +++ b/docs/cdps/plugins/websocketclient.mdx @@ -3,24 +3,41 @@ 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 的 websocket client 擴充 + ## 依賴 + ### CDPS 依賴 -| 名稱 | 版本 | -| --------- | ---------- | -| `CDPS`| `>= 1.0.18` | + +| 名稱 | 版本 | +| ------ | ----------- | +| `CDPS` | `>= 1.0.18` | + ### PyPI 依賴 -| 名稱 | 版本 | -| --------- | ---------- | -| `websocket-client`| `>= 1.8.0` | + +| 名稱 | 版本 | +| ------------------ | ---------- | +| `websocket-client` | `>= 1.8.0` | + ## 原始碼 -- [GitHub](https://github.com/ExpTechTW/CDPS-websocketclient) \ No newline at end of file + +- [GitHub](https://github.com/ExpTechTW/CDPS-websocketclient) diff --git a/docs/cdps/release/index.mdx b/docs/cdps/release/index.mdx index b708465..9ccd83d 100644 --- a/docs/cdps/release/index.mdx +++ b/docs/cdps/release/index.mdx @@ -3,38 +3,66 @@ sidebar_position: 8 --- # 更新日誌 + - 這裡紀錄著，各個版本的更新內容 ## 1.0.19 (Draft) + #### 🐞 修正 + - Log `__init__` 覆蓋天數的問題 + --- + ## 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.16 (hotfix) + #### 🐞 修正 + - 初始化崩潰 + --- + ## 1.0.15 + #### 🌟 新增 + - 事件 裝飾器 - `onCommandEvent` - `cdps version` ( In Program Command ) - `cdps exit` ( In Program Command ) - `cdps plugin reload {plugin}` ( In Program Command ) + #### 🔌 優化 + - Command 錯誤處理方式 + #### 🐞 修正 -- Log 錯字 \ No newline at end of file + +- Log 錯字 diff --git a/docs/cdps/start/index.mdx b/docs/cdps/start/index.mdx index 83d65ff..40775ef 100644 --- a/docs/cdps/start/index.mdx +++ b/docs/cdps/start/index.mdx @@ -15,12 +15,18 @@ sidebar_position: 1 - 需要把 地震報告 同時往 `Discord` 、`Slack` 傳遞，這時可以安裝 [report](https://github.com/ExpTechTW/CDPS/blob/master/docs/zh/user/plugins.md) Plugin 接收 地震報告，然後安裝 Discord 及 Slack 的 Plugin 把資訊發往 Discord 及 Slack。 :::note + - Discord Plugin 是一個給 CDPS 用，發訊息到 Discord 的 Plugin 。 - Slack Plugin 是一個給 CDPS 用，發訊息到 Slack 的 Plugin 。 + ::: ## 總結 + - 接收一次 地震報告 資訊，可以有多種用途，提高防災資訊的傳遞效率。 + :::note + - 可以根據需求，安裝不同的 Plugin ,或是自己製作 Plugin。 -::: \ No newline at end of file + +::: diff --git a/docs/cdps/start/install.mdx b/docs/cdps/start/install.mdx index 793ed19..7d0bdba 100644 --- a/docs/cdps/start/install.mdx +++ b/docs/cdps/start/install.mdx @@ -5,57 +5,80 @@ sidebar_position: 2 # 開始 ## 安裝 + - 使用 PyPI 安裝 CDPS。 -| CDPS 版本 | Python 依賴 | -| --------- | ---------- | -| `>= 1.0.0`| `>= 3.8` | +| CDPS 版本 | Python 依賴 | +| ---------- | ----------- | +| `>= 1.0.0` | `>= 3.8` | ```bash pip install cdps ``` + :::caution + - Python 開發環境為 `3.10.0` ，不推薦使用低於 開發環境 的版本執行。 + ::: ## 初始化 + - 建立名為 `my_cdps` 的資料夾。 + ```bash mkdir my_cdps ``` + - 進入 `my_cdps` 資料夾內 + ```bash cd ./my_cdps ``` + - 初始化 生成必要檔案 + ```bash cdps init ``` + :::caution + - 可能會出現: + ```bash 'cdps' is not recognized as an internal or external command, operable program or batch file. ``` + - 這是因為沒有正確設定 `環境變數` - 設定(Windows) -> 系統 -> 關於 -> 進階系統設定 -> 環境變數 -> 系統變數 -> 變數(Path) - 值 裡面應該要有 下列三行 ( `{User}`替換成電腦用戶名稱、`Python310` 則根據安裝的 Python 版本而有所不同 ) + ```bash C:\Program Files\Python310\Scripts\ C:\Program Files\Python310\ C:\Users\{User}\AppData\Roaming\Python\Python310\Scripts\ ``` + ::: + :::note + - 別忘了重開 terminal 套用新的 `環境變數` + ::: + - 執行 + ```bash cdps ``` ## 更新 + - 使用 PyPI 更新 CDPS。 + ```bash pip install --upgrade cdps -``` \ No newline at end of file +``` From 04148045def70fa49101c484c4bcf2e244375c6c Mon Sep 17 00:00:00 2001 From: whes1015 Date: Tue, 4 Jun 2024 21:13:47 +0800 Subject: [PATCH 3/4] style(cdps): prettier --- docs/cdps/command/index.mdx | 6 ++--- docs/cdps/config/index.mdx | 2 +- docs/cdps/develop/index.mdx | 4 +-- docs/cdps/more/dependencies.mdx | 4 +-- docs/cdps/more/event.mdx | 4 +-- docs/cdps/more/events_list.mdx | 2 +- docs/cdps/more/index.mdx | 26 +++++++++---------- docs/cdps/more/log.mdx | 4 +-- docs/cdps/more/pip.mdx | 6 ++--- docs/cdps/more/plugin.mdx | 2 +- docs/cdps/more/pre_load.mdx | 2 +- docs/cdps/more/thread.mdx | 6 ++--- docs/cdps/more/version.mdx | 4 +-- docs/cdps/plugin/event.mdx | 6 ++--- docs/cdps/plugin/index.mdx | 12 ++++----- docs/cdps/plugin/more.mdx | 2 +- docs/cdps/plugin/pack.mdx | 2 +- docs/cdps/plugins/color_log.mdx | 8 +++--- docs/cdps/plugins/example.mdx | 2 +- docs/cdps/plugins/index.mdx | 10 +++---- docs/cdps/plugins/report.mdx | 2 +- docs/cdps/plugins/websocketclient.mdx | 4 +-- docs/cdps/release/index.mdx | 4 +-- docs/cdps/start/index.mdx | 6 ++--- docs/cdps/start/install.mdx | 4 +-- .../current/cdps/develop/index.mdx | 4 +-- .../current/cdps/more/dependencies.mdx | 2 +- .../current/cdps/more/index.mdx | 22 ++++++++-------- .../current/cdps/more/pip.mdx | 2 +- .../current/cdps/plugin/more.mdx | 2 +- .../current/cdps/plugins/color_log.mdx | 4 +-- .../current/cdps/plugins/index.mdx | 10 +++---- .../current/cdps/plugins/websocketclient.mdx | 4 +-- .../current/cdps/release/index.mdx | 4 +-- 34 files changed, 94 insertions(+), 94 deletions(-) diff --git a/docs/cdps/command/index.mdx b/docs/cdps/command/index.mdx index 393aef8..317a538 100644 --- a/docs/cdps/command/index.mdx +++ b/docs/cdps/command/index.mdx @@ -4,11 +4,11 @@ sidebar_position: 3 # 指令 -- CDPS 提供簡易的 CLI 工具 執行對應操作 +- CDPS 提供簡易的 CLI 工具 執行對應操作。 :::note -- 下方指令 在 Source Code 下，需將 `cdps` 替換成 `python main.py`。 +- 下方指令在 Source Code 下，需將 `cdps` 替換成 `python main.py`。 ::: @@ -22,7 +22,7 @@ cdps -h :::note -- 可以查看 子指令 幫助訊息 +- 可以查看**子指令**幫助訊息 - 範例 `cdps pack -h` ::: diff --git a/docs/cdps/config/index.mdx b/docs/cdps/config/index.mdx index d68c89b..e4e429d 100644 --- a/docs/cdps/config/index.mdx +++ b/docs/cdps/config/index.mdx @@ -4,7 +4,7 @@ sidebar_position: 2 # 配置 -- 自定義你的 CDPS 伺服器 +- 自定義你的 CDPS 伺服器。 ## 配置檔 diff --git a/docs/cdps/develop/index.mdx b/docs/cdps/develop/index.mdx index 8e350b9..c2b5342 100644 --- a/docs/cdps/develop/index.mdx +++ b/docs/cdps/develop/index.mdx @@ -4,7 +4,7 @@ sidebar_position: 6 # 開發 -- 這是關於開發 `CDPS` 的文件，如果是要開發擴充 [點擊這裡](../plugin/index.mdx) +- 這是關於開發 `CDPS` 的文件，如果是要開發擴充 [點擊這裡](../plugin/index)。 :::note @@ -24,7 +24,7 @@ sidebar_position: 6 :::tip - 開發時應保持 `簡潔` 的原則。 -- 若非所有用戶所需之功能，可以參考利用 [Inject 注入](../more/inject.mdx) 的方式實現。 +- 若非所有用戶所需之功能，可以參考利用 [Inject 注入](../more/inject) 的方式實現。 ::: diff --git a/docs/cdps/more/dependencies.mdx b/docs/cdps/more/dependencies.mdx index 13eb980..30a71ee 100644 --- a/docs/cdps/more/dependencies.mdx +++ b/docs/cdps/more/dependencies.mdx @@ -4,11 +4,11 @@ sidebar_position: 8 # 依賴關係 -- 擴充 之間的 依賴關係 +- **擴充**之間的依賴關係 :::note -- 這是說明 CDPS 擴充之間的依賴關係，如果要找 PyPI 依賴 [點擊這裡](./pip.mdx) +- 這是說明 CDPS 擴充之間的依賴關係，如果要找 PyPI 依賴 [點擊這裡](./pip) ::: diff --git a/docs/cdps/more/event.mdx b/docs/cdps/more/event.mdx index 81fa7cf..1c466ac 100644 --- a/docs/cdps/more/event.mdx +++ b/docs/cdps/more/event.mdx @@ -4,11 +4,11 @@ sidebar_position: 12 # 自定義事件註冊 -- 除了 CDPS 本身，擴充 還可以分發自己的 事件。 +- 除了 CDPS 本身，**擴充**還可以分發自己的 事件。 :::tip -- 自定義事件 是 擴充 之間，傳遞訊息的一種方式。 +- **自定義事件**是擴充之間，傳遞訊息的一種方式。 ::: diff --git a/docs/cdps/more/events_list.mdx b/docs/cdps/more/events_list.mdx index 1cc75fa..23197d5 100644 --- a/docs/cdps/more/events_list.mdx +++ b/docs/cdps/more/events_list.mdx @@ -4,7 +4,7 @@ sidebar_position: 1 # 事件列表 -- 查看可用的事件 +- 查看可用的事件。 ## 目錄 diff --git a/docs/cdps/more/index.mdx b/docs/cdps/more/index.mdx index 8d05e22..80361ac 100644 --- a/docs/cdps/more/index.mdx +++ b/docs/cdps/more/index.mdx @@ -4,19 +4,19 @@ sidebar_position: 7 # 雜項 -- 這裡紀錄著，一些瑣碎的東西 +- 這裡紀錄著，一些瑣碎的東西。 ## 目錄 -- [事件列表](./events_list.mdx) -- [目錄樹](./tree.mdx) -- [多執行緒(threading)](./thread.mdx) -- [Inject 注入](./inject.mdx) -- [完全載入](./focus_load.mdx) -- [優先載入](./pre_load.mdx) -- [版本管理](./version.mdx) -- [依賴關係](./dependencies.mdx) -- [PyPI 依賴](./pip.mdx) -- [日誌紀錄](./log.mdx) -- [導入 擴充 的 函數](./plugin.mdx) -- [自定義事件註冊](./event.mdx) +- [事件列表](./events_list) +- [目錄樹](./tree) +- [多執行緒(threading)](./thread) +- [Inject 注入](./inject) +- [完全載入](./focus_load) +- [優先載入](./pre_load) +- [版本管理](./version) +- [依賴關係](./dependencies) +- [PyPI 依賴](./pip) +- [日誌紀錄](./log) +- [導入 擴充 的 函數](./plugin) +- [自定義事件註冊](./event) diff --git a/docs/cdps/more/log.mdx b/docs/cdps/more/log.mdx index d909fb1..3dd1f84 100644 --- a/docs/cdps/more/log.mdx +++ b/docs/cdps/more/log.mdx @@ -4,7 +4,7 @@ sidebar_position: 10 # 日誌紀錄 -- 輸出 日誌 到 控制台 並 紀錄到 文件 中。 +- 輸出**日誌**到**控制台**並紀錄到文件中。 ## 用法 @@ -12,7 +12,7 @@ sidebar_position: 10 :::tip -- Log 類 為 `單例` ，因此可以重複獲取，無需擔心重複。 +- Log 類為 `單例` ，因此可以重複獲取，無需擔心重複。 ::: diff --git a/docs/cdps/more/pip.mdx b/docs/cdps/more/pip.mdx index 8f7ba39..8e7400d 100644 --- a/docs/cdps/more/pip.mdx +++ b/docs/cdps/more/pip.mdx @@ -4,11 +4,11 @@ sidebar_position: 9 # PyPI 依賴 -- 依賴的 PyPI 套件 +- 依賴的 PyPI 套件。 :::note -- 這是說明 PyPI 依賴，如果要找 CDPS 擴充之間的依賴關係 [點擊這裡](./dependencies.mdx)。 +- 這是說明 PyPI 依賴，如果要找 CDPS 擴充之間的依賴關係 [點擊這裡](./dependencies)。 ::: @@ -28,7 +28,7 @@ sidebar_position: 9 ## 用途 -- 在 `pip_dependencies` 中 聲明 所需的 PyPI 依賴，擴充管理器會檢查是否已安裝對應依賴。 +- 在 `pip_dependencies` 中**聲明**所需的 PyPI 依賴，擴充管理器會檢查是否已安裝對應依賴。 :::tip diff --git a/docs/cdps/more/plugin.mdx b/docs/cdps/more/plugin.mdx index 0e84cf6..f094915 100644 --- a/docs/cdps/more/plugin.mdx +++ b/docs/cdps/more/plugin.mdx @@ -4,7 +4,7 @@ sidebar_position: 11 # 導入 擴充 的 函數 -- 導入 特定擴充 中的 函數 +- 導入**特定擴充**中的函數。 :::tip diff --git a/docs/cdps/more/pre_load.mdx b/docs/cdps/more/pre_load.mdx index b3b8ba1..d7757e3 100644 --- a/docs/cdps/more/pre_load.mdx +++ b/docs/cdps/more/pre_load.mdx @@ -4,7 +4,7 @@ sidebar_position: 6 # 優先載入 -- 優先被 擴充管理器 載入 +- 優先被**擴充管理器**載入。 :::caution diff --git a/docs/cdps/more/thread.mdx b/docs/cdps/more/thread.mdx index 0888c0b..dba4a02 100644 --- a/docs/cdps/more/thread.mdx +++ b/docs/cdps/more/thread.mdx @@ -4,7 +4,7 @@ sidebar_position: 3 # 多執行緒 -- 在 擴充 中使用 threading +- 在**擴充**中使用 threading ## task_run @@ -14,7 +14,7 @@ sidebar_position: 3 :::tip -- 在 CDPS `>= 1.0.18` 後，有更好的方法 使用 threading 請看 [裝飾器](#new_thread)。 +- 在 CDPS `>= 1.0.18` 後，有更好的方法使用 threading 請看 [裝飾器](#new_thread)。 ::: @@ -43,7 +43,7 @@ def task_run(stop_event): ## new_thread -- 使用 裝飾器 裝飾 函數，被裝飾的函數將會在 多執行緒 中 執行。 +- 使用**裝飾器**裝飾函數，被裝飾的函數將會在**多執行緒**中執行。 :::note diff --git a/docs/cdps/more/version.mdx b/docs/cdps/more/version.mdx index c984553..d91da08 100644 --- a/docs/cdps/more/version.mdx +++ b/docs/cdps/more/version.mdx @@ -4,7 +4,7 @@ sidebar_position: 7 # 版本管理 -- 擴充作者 應做好 版本管理 +- 擴充作者應做好版本管理 ## 擴充版本命名方式 @@ -33,4 +33,4 @@ sidebar_position: 7 ### Z 修訂號 -- 擴充修復錯誤或問題 增加 `修訂號`。 +- 擴充修復錯誤或問題增加 `修訂號`。 diff --git a/docs/cdps/plugin/event.mdx b/docs/cdps/plugin/event.mdx index 1fb6930..723b8ee 100644 --- a/docs/cdps/plugin/event.mdx +++ b/docs/cdps/plugin/event.mdx @@ -8,13 +8,13 @@ sidebar_position: 2 ## register_listener -- 定義一個 Listener 後，向 事件管理器 註冊 +- 定義一個 Listener 後，向**事件管理器**註冊。 #### ❗ 不推薦的做法 :::tip -- 在 CDPS `>= 1.0.15` 後，有更好的方法 註冊事件 請看 [裝飾器](#event_listener) +- 在 CDPS `>= 1.0.15` 後，有更好的方法**註冊事件**請看 [裝飾器](#event_listener) ::: @@ -36,7 +36,7 @@ event_manager.register_listener(onServerStartListener()) # 註冊 監聽器 到 ## event_listener -- 使用 裝飾器 裝飾 函數，被裝飾的函數將會作為對應事件的 回調函數。 +- 使用**裝飾器**裝飾函數，被裝飾的函數將會作為對應事件的回調函數。 - 傳入要監聽的事件 ```py diff --git a/docs/cdps/plugin/index.mdx b/docs/cdps/plugin/index.mdx index 63aef45..7e439ac 100644 --- a/docs/cdps/plugin/index.mdx +++ b/docs/cdps/plugin/index.mdx @@ -15,7 +15,7 @@ sidebar_position: 5 ## 虛擬環境 -- 建議使用 Python 自帶的 虛擬環境 功能，開發擴充。 +- 建議使用 Python 自帶的**虛擬環境**功能，開發擴充。 :::note @@ -23,31 +23,31 @@ sidebar_position: 5 ::: -#### 建立 虛擬環境 +#### 建立虛擬環境 ```bash python -m venv dev ``` -#### 進入 虛擬環境 位置 +#### 進入虛擬環境 ```bash cd ./dev/Scripts ``` -#### 啟動 虛擬環境 +#### 啟動虛擬環境 ```bash activate.bat ``` -#### 退回 根目錄 +#### 退回根目錄 ```bash cd ../../ ``` -#### 安裝相關 依賴 +#### 安裝 PyPI 相關依賴 ```bash pip install -r requirements.txt diff --git a/docs/cdps/plugin/more.mdx b/docs/cdps/plugin/more.mdx index 6a9723e..cc0172d 100644 --- a/docs/cdps/plugin/more.mdx +++ b/docs/cdps/plugin/more.mdx @@ -5,4 +5,4 @@ sidebar_position: 5 # 更多 - 更多你可能還想知道的東西！！！ -- [點擊前往](../more/index.mdx) +- [點擊前往](../more/index) diff --git a/docs/cdps/plugin/pack.mdx b/docs/cdps/plugin/pack.mdx index 8a6764c..e25a05f 100644 --- a/docs/cdps/plugin/pack.mdx +++ b/docs/cdps/plugin/pack.mdx @@ -22,7 +22,7 @@ example/ :::note -- `--name` 後 帶上資料夾名稱 +- `--name` 後，帶上資料夾名稱 ::: diff --git a/docs/cdps/plugins/color_log.mdx b/docs/cdps/plugins/color_log.mdx index ab95aea..37d12e8 100644 --- a/docs/cdps/plugins/color_log.mdx +++ b/docs/cdps/plugins/color_log.mdx @@ -6,25 +6,25 @@ sidebar_position: 6 :::danger -- 使用了 `Inject 注入` [點擊查看](../more/inject.mdx) +- 使用了**Inject 注入** [點擊查看](../more/inject) ::: :::caution -- 使用了 `完全載入(focus-load)` [點擊查看](../more/focus_load.mdx) +- 使用了**完全載入(focus-load)** [點擊查看](../more/focus_load) ::: :::info -- 使用了 `優先載入(pre-load)` [點擊查看](../more/pre_load.mdx) +- 使用了**優先載入(pre-load)** [點擊查看](../more/pre_load) ::: :::note -- 此 擴充 使用 `Inject 注入` 修改 CDPS 的原生 Log 方法，可能導致 Log 問題，請謹慎使用。 +- 此**擴充**使用**Inject 注入**修改 CDPS 的原生 Log 方法，可能導致 Log 問題，請謹慎使用。 ::: diff --git a/docs/cdps/plugins/example.mdx b/docs/cdps/plugins/example.mdx index c8fa7dd..aa5fb01 100644 --- a/docs/cdps/plugins/example.mdx +++ b/docs/cdps/plugins/example.mdx @@ -16,7 +16,7 @@ sidebar_position: 2 ### 說明 -- CDPS 的 範例擴充 +- CDPS 的**範例擴充** ## 依賴 diff --git a/docs/cdps/plugins/index.mdx b/docs/cdps/plugins/index.mdx index 4bca153..2bac53f 100644 --- a/docs/cdps/plugins/index.mdx +++ b/docs/cdps/plugins/index.mdx @@ -10,11 +10,11 @@ sidebar_position: 4 ### 工具 -- [example](./example.mdx) -- [discordwebhook](./discordwebhook.mdx) -- [color_log](./color_log.mdx) -- [websocketclient](./websocketclient.mdx) +- [example](./example) +- [discordwebhook](./discordwebhook) +- [color_log](./color_log) +- [websocketclient](./websocketclient) ### 資料 -- [report](./report.mdx) +- [report](./report) diff --git a/docs/cdps/plugins/report.mdx b/docs/cdps/plugins/report.mdx index 18e7210..6152d2c 100644 --- a/docs/cdps/plugins/report.mdx +++ b/docs/cdps/plugins/report.mdx @@ -6,7 +6,7 @@ sidebar_position: 4 :::note -- 此 擴充 使用了已經遺棄的方法，不能在 CDPS `>= 1.0.18` 的版本上執行。 +- 此**擴充**使用了已經遺棄的方法，不能在 CDPS `>= 1.0.18` 的版本上執行。 ::: diff --git a/docs/cdps/plugins/websocketclient.mdx b/docs/cdps/plugins/websocketclient.mdx index 24fd83d..59f215f 100644 --- a/docs/cdps/plugins/websocketclient.mdx +++ b/docs/cdps/plugins/websocketclient.mdx @@ -6,13 +6,13 @@ sidebar_position: 5 :::caution -- 使用了 `完全載入(focus-load)` [點擊查看](../more/focus_load.mdx) +- 使用了**完全載入(focus-load)** [點擊查看](../more/focus_load) ::: :::info -- 使用了 `優先載入(pre-load)` [點擊查看](../more/pre_load.mdx) +- 使用了**優先載入(pre-load)** [點擊查看](../more/pre_load) ::: diff --git a/docs/cdps/release/index.mdx b/docs/cdps/release/index.mdx index 9ccd83d..8aee49b 100644 --- a/docs/cdps/release/index.mdx +++ b/docs/cdps/release/index.mdx @@ -19,7 +19,7 @@ sidebar_position: 8 #### 🌟 新增 - pip 依賴檢查 -- [`@new_thread`](../more/thread.mdx#new_thread) 裝飾器 +- [`@new_thread`](../more/thread#new_thread) 裝飾器 #### 🐞 修正 @@ -27,7 +27,7 @@ sidebar_position: 8 :::caution -- plugin 內的 `task` 現在改為 `task_run` [參考這裡](../more/thread.mdx#task_run) +- plugin 內的 `task` 現在改為 `task_run` [參考這裡](../more/thread#task_run) ::: diff --git a/docs/cdps/start/index.mdx b/docs/cdps/start/index.mdx index 40775ef..df7b69f 100644 --- a/docs/cdps/start/index.mdx +++ b/docs/cdps/start/index.mdx @@ -8,11 +8,11 @@ sidebar_position: 1 ## 用途 -- 透過 `模組化` 的設計，讓防災資訊有更多利用的可能。 +- 透過**模組化**的設計，讓防災資訊有更多利用的可能。 ## 情境 -- 需要把 地震報告 同時往 `Discord` 、`Slack` 傳遞，這時可以安裝 [report](https://github.com/ExpTechTW/CDPS/blob/master/docs/zh/user/plugins.md) Plugin 接收 地震報告，然後安裝 Discord 及 Slack 的 Plugin 把資訊發往 Discord 及 Slack。 +- 需要把**地震報告**同時往 `Discord` 、`Slack` 傳遞，這時可以安裝 [report](https://github.com/ExpTechTW/CDPS/blob/master/docs/zh/user/plugins.md) Plugin 接收**地震報告**，然後安裝 Discord 及 Slack 的 Plugin 把資訊發往 Discord 及 Slack。 :::note @@ -23,7 +23,7 @@ sidebar_position: 1 ## 總結 -- 接收一次 地震報告 資訊，可以有多種用途，提高防災資訊的傳遞效率。 +- 接收一次**地震報告**資訊，可以有多種用途，提高防災資訊的傳遞效率。 :::note diff --git a/docs/cdps/start/install.mdx b/docs/cdps/start/install.mdx index 7d0bdba..9ff612b 100644 --- a/docs/cdps/start/install.mdx +++ b/docs/cdps/start/install.mdx @@ -18,7 +18,7 @@ pip install cdps :::caution -- Python 開發環境為 `3.10.0` ，不推薦使用低於 開發環境 的版本執行。 +- Python 開發環境為 `3.10.0` ，不推薦使用低於**開發環境**的版本執行。 ::: @@ -53,7 +53,7 @@ operable program or batch file. - 這是因為沒有正確設定 `環境變數` - 設定(Windows) -> 系統 -> 關於 -> 進階系統設定 -> 環境變數 -> 系統變數 -> 變數(Path) -- 值 裡面應該要有 下列三行 ( `{User}`替換成電腦用戶名稱、`Python310` 則根據安裝的 Python 版本而有所不同 ) +- **值**裡面應該要有**下列三行**( `{User}`替換成電腦用戶名稱、`Python310` 則根據安裝的 Python 版本而有所不同 ) ```bash C:\Program Files\Python310\Scripts\ diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/develop/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/develop/index.mdx index d7ea967..d9c77de 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/develop/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/develop/index.mdx @@ -3,7 +3,7 @@ sidebar_position: 6 --- # 開発 -- これは `CDPS` の開発に関するドキュメントです。拡張機能の開発については[こちらをクリックしてください](../plugin/index.mdx)。 +- これは `CDPS` の開発に関するドキュメントです。拡張機能の開発については[こちらをクリックしてください](../plugin/index)。 :::note - 一般ユーザーの場合、このセクションはスキップしてください（急いで！）。 ::: @@ -16,5 +16,5 @@ sidebar_position: 6 - GitHub で [PR](https://github.com/ExpTechTW/CDPS/pulls) を提出します。 :::tip - 開発時は `シンプル` であるべきです。 -- すべてのユーザーに必要な機能でない場合、[Inject 注入](../more/inject.mdx)を利用して実装することができます。 +- すべてのユーザーに必要な機能でない場合、[Inject 注入](../more/inject)を利用して実装することができます。 ::: \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/dependencies.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/dependencies.mdx index 4ca3160..75a514b 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/dependencies.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/dependencies.mdx @@ -5,7 +5,7 @@ sidebar_position: 8 # 依賴關係 - 擴充 之間的 依賴關係 :::note -- 這是說明 CDPS 擴充之間的依賴關係，如果要找 PyPI依賴 [點擊這裡](./pip.mdx) +- 這是說明 CDPS 擴充之間的依賴關係，如果要找 PyPI依賴 [點擊這裡](./pip) ::: ## 聲明依賴 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx index 4dc2d41..ae14482 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/index.mdx @@ -6,14 +6,14 @@ sidebar_position: 7 - 這裡紀錄著，一些瑣碎的東西 ## 目錄 -- [事件列表](./events_list.mdx) -- [目錄樹](./tree.mdx) -- [多執行緒(threading)](./thread.mdx) -- [Inject 注入](./inject.mdx) -- [完全載入](./focus_load.mdx) -- [優先載入](./pre_load.mdx) -- [版本管理](./version.mdx) -- [依賴關係](./dependencies.mdx) -- [PyPI 依賴](./pip.mdx) -- [日誌紀錄](./log.mdx) -- [導入 擴充 的 函數](./plugin.mdx) \ No newline at end of file +- [事件列表](./events_list) +- [目錄樹](./tree) +- [多執行緒(threading)](./thread) +- [Inject 注入](./inject) +- [完全載入](./focus_load) +- [優先載入](./pre_load) +- [版本管理](./version) +- [依賴關係](./dependencies) +- [PyPI 依賴](./pip) +- [日誌紀錄](./log) +- [導入 擴充 的 函數](./plugin) \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pip.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pip.mdx index e24af31..220edb6 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pip.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/more/pip.mdx @@ -5,7 +5,7 @@ sidebar_position: 9 # PyPI 依賴 - 依賴的 PyPI 套件 :::note -- 這是說明 PyPI依賴，如果要找 CDPS 擴充之間的依賴關係 [點擊這裡](./dependencies.mdx)。 +- 這是說明 PyPI依賴，如果要找 CDPS 擴充之間的依賴關係 [點擊這裡](./dependencies)。 ::: ## 聲明依賴 diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/more.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/more.mdx index 6d8eac0..fa16b02 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/more.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/more.mdx @@ -4,4 +4,4 @@ sidebar_position: 5 # 更多 - 更多你可能還想知道的東西！！！ -- [點擊前往](../more/index.mdx) \ No newline at end of file +- [點擊前往](../more/index) \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/color_log.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/color_log.mdx index 6ac4d63..30ae606 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/color_log.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/color_log.mdx @@ -4,10 +4,10 @@ sidebar_position: 6 # color_log `1.0.2` :::danger -- 使用了 [`完全載入(focus-load)`](../more/focus_load.mdx) +- 使用了 [`完全載入(focus-load)`](../more/focus_load) ::: :::caution -- 使用了 [`優先載入(pre-load)`](../more/pre_load.mdx) +- 使用了 [`優先載入(pre-load)`](../more/pre_load) ::: ### 作者 - [`YuYu1015`](https://github.com/whes1015) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/index.mdx index 7528f95..ea53d06 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/index.mdx @@ -7,9 +7,9 @@ sidebar_position: 4 ## 索引 ### 工具 -- [example](./example.mdx) -- [discordwebhook](./discordwebhook.mdx) -- [color_log](./color_log.mdx) -- [websocketclient](./websocketclient.mdx) +- [example](./example) +- [discordwebhook](./discordwebhook) +- [color_log](./color_log) +- [websocketclient](./websocketclient) ### 資料 -- [report](./report.mdx) \ No newline at end of file +- [report](./report) \ No newline at end of file diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/websocketclient.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/websocketclient.mdx index 922379c..79afb2f 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/websocketclient.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugins/websocketclient.mdx @@ -4,10 +4,10 @@ sidebar_position: 5 # websocketclient `1.0.4` :::danger -- 使用了 [`完全載入(focus-load)`](../more/focus_load.mdx) +- 使用了 [`完全載入(focus-load)`](../more/focus_load) ::: :::caution -- 使用了 [`優先載入(pre-load)`](../more/pre_load.mdx) +- 使用了 [`優先載入(pre-load)`](../more/pre_load) ::: ### 作者 - [`yayacat`](https://github.com/yayacat) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/release/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/release/index.mdx index 82372a0..50ad742 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/release/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/release/index.mdx @@ -12,11 +12,11 @@ sidebar_position: 8 # 1.0.18 ### 🌟 新機能 - pip 依存性チェック -- [`@new_thread`](../more/thread.mdx#new_thread) デコレータ +- [`@new_thread`](../more/thread#new_thread) デコレータ ### 🐞 修正 - Config クラスがシングルトンではない問題 :::caution -- プラグイン内の `task` は現在 `task_run` に変更されています [こちらを参照](../more/thread.mdx#task_run) +- プラグイン内の `task` は現在 `task_run` に変更されています [こちらを参照](../more/thread#task_run) ::: # 1.0.17 (ホットフィックス) From 4bb4e3e6458f10a7d4761262eeb09c9e9982f5a1 Mon Sep 17 00:00:00 2001 From: whes1015 Date: Tue, 4 Jun 2024 21:17:44 +0800 Subject: [PATCH 4/4] fix(cdps): remove index --- docs/cdps/develop/index.mdx | 2 +- docs/cdps/plugin/more.mdx | 2 +- i18n/en/docusaurus-theme-classic/footer.json | 2 +- .../current/cdps/develop/index.mdx | 2 +- .../docusaurus-plugin-content-docs/current/cdps/plugin/more.mdx | 2 +- i18n/ja/docusaurus-theme-classic/footer.json | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/cdps/develop/index.mdx b/docs/cdps/develop/index.mdx index c2b5342..00cdbf4 100644 --- a/docs/cdps/develop/index.mdx +++ b/docs/cdps/develop/index.mdx @@ -4,7 +4,7 @@ sidebar_position: 6 # 開發 -- 這是關於開發 `CDPS` 的文件，如果是要開發擴充 [點擊這裡](../plugin/index)。 +- 這是關於開發 `CDPS` 的文件，如果是要開發擴充 [點擊這裡](../plugin)。 :::note diff --git a/docs/cdps/plugin/more.mdx b/docs/cdps/plugin/more.mdx index cc0172d..2eb2a5e 100644 --- a/docs/cdps/plugin/more.mdx +++ b/docs/cdps/plugin/more.mdx @@ -5,4 +5,4 @@ sidebar_position: 5 # 更多 - 更多你可能還想知道的東西！！！ -- [點擊前往](../more/index) +- [點擊前往](../more) diff --git a/i18n/en/docusaurus-theme-classic/footer.json b/i18n/en/docusaurus-theme-classic/footer.json index 6a04c78..a00a8a6 100644 --- a/i18n/en/docusaurus-theme-classic/footer.json +++ b/i18n/en/docusaurus-theme-classic/footer.json @@ -25,7 +25,7 @@ }, "link.item.label.CDPS": { "message": "CDPS", - "description": "The label of footer link with label=CDPS linking to /docs/cdps/start/index" + "description": "The label of footer link with label=CDPS linking to /docs/cdps/start" }, "link.item.label.服務條款": { "message": "Terms of Services", diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/develop/index.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/develop/index.mdx index d9c77de..db1b652 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/develop/index.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/develop/index.mdx @@ -3,7 +3,7 @@ sidebar_position: 6 --- # 開発 -- これは `CDPS` の開発に関するドキュメントです。拡張機能の開発については[こちらをクリックしてください](../plugin/index)。 +- これは `CDPS` の開発に関するドキュメントです。拡張機能の開発については[こちらをクリックしてください](../plugin)。 :::note - 一般ユーザーの場合、このセクションはスキップしてください（急いで！）。 ::: diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/more.mdx b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/more.mdx index fa16b02..2aaae94 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/more.mdx +++ b/i18n/ja/docusaurus-plugin-content-docs/current/cdps/plugin/more.mdx @@ -4,4 +4,4 @@ sidebar_position: 5 # 更多 - 更多你可能還想知道的東西！！！ -- [點擊前往](../more/index) \ No newline at end of file +- [點擊前往](../more) \ No newline at end of file diff --git a/i18n/ja/docusaurus-theme-classic/footer.json b/i18n/ja/docusaurus-theme-classic/footer.json index ac392b8..7170933 100644 --- a/i18n/ja/docusaurus-theme-classic/footer.json +++ b/i18n/ja/docusaurus-theme-classic/footer.json @@ -25,7 +25,7 @@ }, "link.item.label.CDPS": { "message": "CDPS", - "description": "/docs/cdps/start/indexにリンクしているlabel=CDPSのフッターリンクのラベル" + "description": "/docs/cdps/start にリンクしているlabel=CDPSのフッターリンクのラベル" }, "link.item.label.服務條款": { "message": "利用規約",