diff --git a/docs/CONTRIBUTING-cmn_CN.md b/docs/CONTRIBUTING-cmn_CN.md index d244f2f7..f10f27c0 100644 --- a/docs/CONTRIBUTING-cmn_CN.md +++ b/docs/CONTRIBUTING-cmn_CN.md @@ -11,6 +11,28 @@ ### 开发 (Chrome or Edge) +#### Chrome 或 Edge 的第一种方法 (推荐) + +1. 运行 pnpm 命令 + +```bash +# 安装依赖 +pnpm install + +# 创建一个用于存储登录状态的扩展程序文件夹 +mkdir web-ext-profile + +# 运行项目 +pnpm dev + +# 打完这条指令之后,会自动打开一个新的 Chrome 窗口并打开 BiliBili 网站 +pnpm start:chromium +``` + +2. 每次修改扩展程序,它都会重新加载,您可以通过刷新网页来查看更改 + +#### Chrome 或 Edge 的另外一种方法 + 1. 运行 pnpm 命令 ```bash @@ -45,6 +67,28 @@ pnpm build ### 开发 (Firefox) +#### Firefox 的第一种方法 (推荐) + +1. 运行 pnpm 命令 + +```bash +# 安装依赖 +pnpm install + +# 创建一个用于存储登录状态的扩展程序文件夹 +mkdir web-ext-profile + +# 运行项目 +pnpm dev + +# 打完这条指令之后,会自动打开一个新的 Firefox 窗口并打开 BiliBili 网站 +pnpm start:firefox +``` + +2. 每次修改扩展程序,它都会重新加载,您可以通过刷新网页来查看更改 + +#### Firefox 的另外一种方法 + 1. 运行 pnpm 命令 ```bash diff --git a/docs/CONTRIBUTING-cmn_TW.md b/docs/CONTRIBUTING-cmn_TW.md index b9b1db1f..18aee821 100644 --- a/docs/CONTRIBUTING-cmn_TW.md +++ b/docs/CONTRIBUTING-cmn_TW.md @@ -10,6 +10,28 @@ ### 開發(Chrome 或 Edge) +#### Chrome 或 Edge 的第一種方法 (推薦) + +1. 執行 pnpm 指令 + +```bash +# 安裝依賴 +pnpm install + +# 建立一個用戶的帳戶資料夾,用於擴充功能存儲登入狀態 +mkdir web-ext-profile + +# 運行專案 +pnpm dev + +# 打完這條指令之後,會自動開啓一個新的 Chrome 視窗並打開 BiliBili 網站 +pnpm start:chromium +``` + +2. 之後每次修改擴充功能,他都會重新載入內容,你可以透過重新整理頁面來查看變更內容 + +#### Chrome 或 Edge 的另外一種方法 + 1. 執行 pnpm 指令 ```bash @@ -44,6 +66,28 @@ pnpm build ### 開發(Firefox) +#### Firefox 的第一種方法 (推薦) + +1. 執行 pnpm 命令 + +```bash +# 安裝依賴 +pnpm install + +# 建立一個用戶的帳戶資料夾,用於擴充功能存儲登入狀態 +mkdir web-ext-profile + +# 運行專案 +pnpm dev + +# 打完這條指令之後,會自動開啓一個新的 Firefox 視窗並打開 BiliBili 網站 +pnpm start:firefox +``` + +2. 之後每次修改擴充功能,它都會重新加載,你可以透過重新整理頁面來查看變更內容 + +#### Firefox 的另一種方法 + 1. 執行 pnpm 命令 ```bash diff --git a/docs/CONTRIBUTING-jyut.md b/docs/CONTRIBUTING-jyut.md index d9f31a4d..0a8b8348 100644 --- a/docs/CONTRIBUTING-jyut.md +++ b/docs/CONTRIBUTING-jyut.md @@ -10,6 +10,28 @@ ### 開發(Chrome 或 Edge) +#### Chrome 或 Edge 嘅第一種方法 (推介) + +1. 執行 pnpm 指令 + +```bash +# 安裝依賴 +pnpm install + +# 建立一個用家帳戶資料夾,用於延伸功能存儲登入狀態 +mkdir web-ext-profile + +# 運行專案 +pnpm dev + +# 打完呢條指令之後,會自動開啓一個新嘅 Chrome 視窗並且打開 BiliBili 網站 +pnpm start:chromium +``` + +2. 之後每次修改延伸功能,佢會重新載入,你可以 refresh 個網頁睇吓改變之後嘅效果 + +#### Chrome 或 Edge 嘅另外一種方法 + 1. 執行 pnpm 指令 ```bash @@ -32,9 +54,9 @@ pnpm dev 每一次執過 code 之後,你都要撳 [Extensions Reloader](https://chromewebstore.google.com/detail/extensions-reloader/fimgfedafeadlieiabdeeaodndnlbhid) 粒掣,然之後 refresh 個 page,確保係有效果。 -#### 建立(Chrome 或 Edge) +#### 建置(Chrome 或 Edge) -建置延新功能,要執行下底嘅指令 +建置延伸功能,要執行下底嘅指令 ```bash pnpm build @@ -44,6 +66,28 @@ pnpm build ### 開發(Firefox) +#### Firefox 嘅第一種方法 (推介) + +1. 執行 pnpm 指令 + +```bash +# 安裝依賴 +pnpm install + +# 建立一個用家帳戶資料夾,用於延伸功能存儲登入狀態 +mkdir web-ext-profile + +# 運行專案 +pnpm dev + +# 打完呢條指令之後,會自動開啓一個新嘅 Firefox 視窗並且打開 BiliBili 網站 +pnpm start:firefox +``` + +2. 之後每次修改延伸功能,佢會重新載入,你可以 refresh 個網頁睇吓改變之後嘅效果 + +#### Firefox 嘅另外一種方法 + 1. 執行 pnpm 指令 ```bash @@ -62,7 +106,7 @@ pnpm dev #### 建立(Firefox) -建置延新功能,要執行下底嘅指令 +建置延伸功能,要執行下底嘅指令 ```bash pnpm build-firefox diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 216a086f..3407c235 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -10,6 +10,28 @@ This project is built using [Vite](https://vitejs.dev/), please make sure you ha ### Development (Chrome or Edge) +#### The First Method for Chrome or Edge (RECOMMENDED) + +1. Run the pnpm command + +```bash +# Install dependencies +pnpm install + +# Create a profile folder for the extension to store the login status +mkdir web-ext-profile + +# Run the project +pnpm dev + +# After typing this commend, it will automatically open a new Chrome window that opens BiliBili website +pnpm start:chromium +``` + +2. Every time you change the extension, it will reload, and you can see the changes by refreshing the webpage + +#### The Alternative Method for Chrome or Edge + 1. Run the pnpm command ```bash @@ -44,6 +66,28 @@ Then package it to the `extension` folder ### Development (Firefox) +#### The First Method for Firefox (RECOMMENDED) + +1. Run the pnpm command + +```bash +# Install dependencies +pnpm install + +# Create a profile folder for the extension to store the login status +mkdir web-ext-profile + +# Run the project +pnpm dev + +# After typing this commend, it will automatically open a new Firefox window that opens BiliBili website +pnpm start:firefox +``` + +2. Every time you change the extension, it will reload, and you can see the changes by refreshing the webpage + +#### The Alternative Method for Firefox + 1. Run the pnpm command ```bash