fix: pack (#2)

* feat: versioning

* fix(plugin): init with class

* fix: broken link

* fix: broken link (plugin_dev -> plugin)

* fix: version 3.1.0

* fix: word

* fix: versioning

* fix: version

* fix: sidebar version

* fix: pack

* feat: event list

---------

Co-authored-by: Kamiya <[email protected]>
Co-authored-by: YuYu1015 <[email protected]>

Author: 3 people

docs/trem/start/index.mdx docs/index.mdx

@@ -0,0 +1,77 @@
+---
+sidebar_position: 1
+---
+
+# 事件列表
+
+查看可用的事件。
+
+## 目錄
+
+- onServerStartEvent
+- EewRelease
+- EewAlert
+- RtsPga2
+- RtsPga1
+- RtsShindo2
+- RtsShindo1
+- RtsShindo0
+- ReportRelease
+- IntensityRelease
+- LpgmRelease
+- TsunamiRelease
+- EewNewAreaAlert
+
+## onServerStartEvent
+
+#### 回傳參數 `pid`
+
+當伺服器被啟動
+
+## EewRelease
+
+當收到地震警報
+
+## EewAlert
+
+當收到緊急地震警報
+
+## RtsPga2
+
+當 PGA > 200gal
+
+## RtsPga1
+
+當 PGA > 8gal
+
+## RtsShindo2
+
+當收到地震檢知 震度4級
+
+## RtsShindo1
+
+當收到地震檢知 震度2級
+
+## RtsShindo0
+
+當收到地震檢知 震度0級
+
+## ReportRelease
+
+當收到地震報告
+
+## IntensityRelease
+
+當收到震度速報
+
+## LpgmRelease
+
+當收到長週期地震動資訊
+
+## TsunamiRelease
+
+當收到海嘯警報
+
+## EewNewAreaAlert
+
+當收到地震速報新區域

docs/trem/start/install.mdx docs/install.mdx

@@ -11,7 +11,7 @@ sidebar_position: 4
 :::
 
 :::tip
-若是擴充要使用的 logger 推薦使用[自定義日誌](../plugin_dev/log)。
+若是擴充要使用的 logger 推薦使用[自定義日誌](../plugin/log)。
 :::
 
 ```js

docs/trem/miscellaneous/dependencies.mdx docs/miscellaneous/dependencies.mdx

@@ -0,0 +1,155 @@
+---
+sidebar_position: 7
+---
+
+# 擴充倉庫
+
+將自己製作的擴充套件放置在倉庫內，並使用 workflow 自動 pr 到 trem-plugin 倉庫。
+
+## 文件結構
+
+```
+plugin/
+    index.js
+    info.json
+
+.github/
+    workflows/
+        auto-pr-info.yml
+```
+
+## index.js
+
+擴充套件的入口點
+
+### Class 形式
+
+
+```js
+class Plugin {
+  #ctx;
+
+  constructor(ctx) {
+    this.#ctx = ctx;
+  }
+
+  onLoad() {
+    const { TREM, logger, MixinManager } = this.#ctx;
+  }
+}
+
+module.exports = Plugin;
+```
+
+### Function 形式
+
+```js
+module.exports = function (ctx) {
+  ctx.on("load", () => {
+    const { TREM, logger, MixinManager } = ctx;
+  });
+};
+```
+
+## info.json
+
+定義擴充資訊的文件
+
+```json
+{
+  "version": "1.0.0", // 擴充版本
+  "description": {
+    "zh_tw": "TREM 範例擴充" // 擴充說明
+  },
+  "author": [
+    "YuYu1015" // 擴充作者
+  ],
+  "dependencies": {
+    "trem": ">=3.0.0" // 擴充所需的 TREM 最低版本
+  },
+  "resources": [
+    "AGPL-3.0" // 擴充的開源協議
+  ],
+  "link": "https://github.com/ExpTechTW/TREM-Lite" // 擴充 的 GitHub Link
+}
+```
+
+## auto-pr-info.yml
+
+自動 pr 到 trem-plugin 倉庫的 workflow
+
+```yml
+name: Auto PR to infos folder
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "info.json"
+
+jobs:
+  create-pr:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source repository
+        uses: actions/checkout@v4
+        with:
+          path: source-repo
+
+      - name: Get filename from info.json
+        id: get-filename
+        run: |
+          cd source-repo
+          BASE_NAME=$(jq -r '.name' info.json)
+          FILENAME="${BASE_NAME}.json"
+          echo "filename=$FILENAME" >> $GITHUB_OUTPUT
+          echo "branch_name=update-file-$(date +%s)" >> $GITHUB_OUTPUT
+          cp info.json ../target.json
+
+      - name: Checkout target repository
+        uses: actions/checkout@v4
+        with:
+          repository: ExpTechTW/TREM-Plugins
+          token: ${{ secrets.PAT_TOKEN }}
+          path: target-repo
+
+      - name: Copy and commit file
+        run: |
+          mkdir -p target-repo/infos
+          mv target.json "target-repo/infos/${{ steps.get-filename.outputs.filename }}"
+          cd target-repo
+          git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --global user.name "github-actions[bot]"
+          BRANCH_NAME="${{ steps.get-filename.outputs.branch_name }}"
+          git checkout -b $BRANCH_NAME
+          git add infos
+          if ! git diff --cached --quiet; then
+            git commit -m "Update ${{ steps.get-filename.outputs.filename }}"
+            git push origin $BRANCH_NAME
+          else
+            echo "No changes to commit."
+            exit 0
+          fi
+
+      - name: Create Pull Request
+        if: success()
+        env:
+          GITHUB_TOKEN: ${{ secrets.PAT_TOKEN }}
+        run: |
+          pr_url=$(gh pr create \
+            --repo ExpTechTW/TREM-Plugins \
+            --base main \
+            --head ${{ steps.get-filename.outputs.branch_name }} \
+            --title "Update ${{ steps.get-filename.outputs.filename }}" \
+            --body "Automated update from plugin repository" \
+            --label "auto-merge")
+          echo "Created PR: $pr_url"
+```
+# 備註
+
+只有在 info.json 有變更時，才會觸發 workflow。
+
+:::warning
+需要先建立 Releases 在 push 更新到倉庫，不然 pr 時會失敗。
+:::

docs/trem/miscellaneous/event.mdx docs/miscellaneous/event.mdx

@@ -0,0 +1,30 @@
+---
+sidebar_position: 5
+---
+
+# 封裝
+
+封裝擴充為 `.trem` 檔案。
+
+## 準備
+
+資料夾看起來應該像下方這樣
+
+```
+example/
+    info.json     // 擴充基本資訊
+    index.js      // 入口點
+```
+
+## 方法
+
+建立 數位簽章 `signature.json` 檔案並打包成 `擴充名稱.trem` 檔案
+
+```
+npx github:ExpTechTW/TREM-Plugin-Signer sign . && npx github:ExpTechTW/TREM-Plugin-Packer
+```
+
+:::warning
+需要有數位簽章 `signature.json` 檔案，才能夠在 TREM-Lite 啟用擴充。
+:::
+

docs/miscellaneous/events_list.mdx

@@ -62,7 +62,7 @@ module.exports = function (ctx) {
     "YuYu1015" // 擴充作者
   ],
   "dependencies": {
-    "trem": ">=3.0.0" // 擴充所需的 CDPS 最低版本
+    "trem": ">=3.0.0" // 擴充所需的 TREM 最低版本
   },
   "resources": [
     "AGPL-3.0" // 擴充的開源協議

docs/trem/miscellaneous/index.mdx docs/miscellaneous/index.mdx

@@ -18,7 +18,7 @@ const config: Config = {
 
   i18n: {
     defaultLocale: "zh-Hant",
-    locales: ["zh-Hant", "en"],
+    locales: ["en", "zh-Hant"],
   },
 
   presets: [
@@ -56,11 +56,16 @@ const config: Config = {
           position: "left",
           label: "技術文件",
         },
-        // {
-        //   type: "localeDropdown",
-        //   position: "right",
-        // },
         {
+          type: 'docsVersionDropdown',
+          position: 'right',
+        },
+        {
+          type: "localeDropdown",
+          position: "right",
+        },
+        {
+          
           href: "https://github.com/ExpTechTW/TREM-Docs",
           label: "GitHub",
           position: "right",
@@ -75,7 +80,7 @@ const config: Config = {
           items: [
             {
               label: "TREM",
-              to: "/docs/trem/start/",
+              to: "/docs",
             },
           ],
         },
@@ -102,7 +107,7 @@ const config: Config = {
           ],
         },
       ],
-      copyright: `Copyright © ${new Date().getFullYear()} ExpTech Studio.`,
+      copyright: `Copyright © ${new Date().getFullYear()} ExpTech Studio. Built with Docusaurus.`,
     },
     prism: {
       theme: prismThemes.oneLight,

docs/trem/miscellaneous/logger.mdx docs/miscellaneous/logger.mdx

@@ -0,0 +1,6 @@
+{
+  "version.label": {
+    "message": "Next 🚧",
+    "description": "The label for version current"
+  }
+}

docs/miscellaneous/plugin_repo.mdx

@@ -0,0 +1,10 @@
+---
+sidebar_position: 1
+---
+
+# TREM
+Taiwan Real-time Earthquake Monitoring (臺灣即時地震監測)
+
+## TREM 是什麼？
+是一款開源地震速報軟體，提供給用戶即時的地震資訊，利用自製的測站，
+顯示各地的即時震度，在地震發生的第一時間取得各管道發布的強震即時警報訊息。

docs/trem/miscellaneous/require.mdx docs/miscellaneous/require.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_position: 2
+---
+
+# 開始
+
+## 安裝
+
+- [下載](https://github.com/ExpTechTW/TREM-Lite/releases)
+
+:::tip
+請根據自身作業系統，下載對應副檔名的安裝檔。
+:::