Merge | branch: master (#13)

* U & F | fix some wrong things and update wl docs * U | Update yarn modules
Blessing-Studio · Nov 16, 2024 · dfbf0d4 · dfbf0d4
1 parent b21eb8f
commit dfbf0d4
Show file tree

Hide file tree

Showing 30 changed files with 5,932 additions and 1,050 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -1,24 +1,15 @@
-# Sample workflow for building and deploying a VitePress site to GitHub Pages
-#
 name: Deploy VitePress site to Pages
 
 on:
-  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
-  # using the `master` branch as the default branch.
   workflow_dispatch:
   push:
-    branches: [main]
+    branches: [master]
 
-  # Allows you to run this workflow manually from the Actions tab
-
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
   contents: read
   pages: write
   id-token: write
 
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
 concurrency:
   group: pages
   cancel-in-progress: false
@@ -32,18 +23,22 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 0 # Not needed if lastUpdated is not enabled
-      # - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
+
       - name: Setup Node
         uses: actions/setup-node@v3
         with:
           node-version: 18
           cache: yarn # or pnpm / yarn
+
       - name: Setup Pages
         uses: actions/configure-pages@v3
+
       - name: Install dependencies
         run: yarn install # or pnpm install / yarn install
+
       - name: Build with VitePress
         run: yarn docs:build # or pnpm docs:build / yarn docs:build
+
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v2
         with:

diff --git a/README.md b/README.md
@@ -1 +1,5 @@
-blessing-studio.github.io
+# The documents website of Blessing Studio
+
+This is the repo of `Blessing Studio` ' documents website, including the info of our studio, the using metheds of `MinecraftLaunch` project and some info about `WonderLab`
+
+PRs and Issues are welcome
diff --git a/docs/.vitepress/navBar/en_US.ts b/docs/.vitepress/navBar/en_US.ts
@@ -2,7 +2,7 @@ import { DefaultTheme } from "vitepress";
 
 export const nav: DefaultTheme.NavItem[] = [
     { text: 'Home', link: '/' },
-    { text: 'MinecraftLaunch', link: '/' },
+    { text: 'MinecraftLaunch', link: '/en_US/minecraftlaunch' },
     { text: "Our Team", link: '/en_US/introduce' }
 ];
 

diff --git a/docs/.vitepress/sidebar/zh_CN.ts b/docs/.vitepress/sidebar/zh_CN.ts
@@ -69,10 +69,10 @@ export const sidebar: DefaultTheme.SidebarItem[] = [
         text: "WonderLab",
         collapsed: false,
         items: [
-            {text: "介绍", link: "/zh_CN/wonderlab/index"},
-            {text: "分支版本", link: "/zh_CN/wonderlab/branch_info"},
-            {text: "安装", link: "/zh_CN/wonderlab/install"},
-            {text: "常见问题", link: "/zh_CN/wonderlab/questions"}
+            {text: "简介", link: "/zh_CN/wonderlab/index"},
+            {text: "分支版本信息", link: "/zh_CN/wonderlab/branch_info"},
+            {text: "安装步骤", link: "/zh_CN/wonderlab/install"},
+            {text: "常见问题", link: "/zh_CN/wonderlab/faq"}
         ]
     }
 ];

diff --git a/docs/en_US/minecraftlaunch/install.md b/docs/en_US/minecraftlaunch/install.md
@@ -1,6 +1,6 @@
 # 安装
 
-在正式使用 ML 之前，你必须先安装 ML 的 NuGet 包（这不废话吗）
+在正式使用 ML 之前，必须先安装 ML 的 NuGet 包（这不废话吗）
 - 直接在 Vs 或 Rider 的包管理器里搜索 MinecraftLaunch 并安装即可
 
 ## 运行时要求

diff --git a/docs/en_US/minecraftlaunch/installers/modpacks.md b/docs/en_US/minecraftlaunch/installers/modpacks.md
@@ -4,7 +4,7 @@
 # CurseForge 整合包安装器
 
 ::: tip
-在 ML 中我们，提供了针对 CurseForge 格式整合包的安装器，与其它安装器不一样的是，此安装器不提供游戏核心的自动安装，也就是需要你提前手动安装好游戏核心
+在 ML 中我们，提供了针对 CurseForge 格式整合包的安装器，与其它安装器不一样的是，此安装器不提供游戏核心的自动安装，也就是需要您提前手动安装好游戏核心
 :::
 
 :::info
@@ -29,7 +29,7 @@ ModsPacksInstaller(string modPacksPath, string gamePath, string apiKey, string g
 |:------:|:----:|
 |modPacksPath | 整合包压缩文件  |
 |gamePath |要保存的游戏目录 |
-|apiKey | 你的apikey |
+|apiKey | 您的apikey |
 |gameid | 游戏名，不填默认整合包的名字 |
 
 ## 开始安装

diff --git a/docs/en_US/minecraftlaunch/launcher.md b/docs/en_US/minecraftlaunch/launcher.md
@@ -4,7 +4,7 @@
 
 
 ## 初始化
-这是在正式启动游戏前的核心步骤，如你在这个步骤出现问题，那么将无法正常启动MC
+这是在正式启动游戏前的核心步骤，如您在这个步骤出现问题，那么将无法正常启动MC
 
 而初始化启动器的方法也非常简单，我们为其提供了两个构造方法：
 
@@ -34,7 +34,7 @@ JavaMinecraftLauncher(LaunchConfig launchSetting, GameCoreUtil gameCoreUtil);
             Height = <窗口高度>,
             IsFullscreen = false
         },
-        JvmConfig = new JvmConfig("你的java路径"){
+        JvmConfig = new JvmConfig("您的java路径"){
             MaxMemory = <最大内存>,
             MinMemory = <最小内存> 
         },
@@ -48,17 +48,17 @@ JavaMinecraftLauncher(LaunchConfig launchSetting, GameCoreUtil gameCoreUtil);
 
     ```
 
-    如果你不需要太多的配置，或者嫌上面的方法太长，也可以使用下面的方法：
+    如果您不需要太多的配置，或者嫌上面的方法太长，也可以使用下面的方法：
     ```C#
-    LaunchConig lc = new(Account.Default, new("你的Java路径"), new(), new());
+    LaunchConig lc = new(Account.Default, new("您的Java路径"), new(), new());
     ```
 
 + GameCoreUtil
 
     <div>这是预启动时信息检查用的游戏定位器，这个参数如果填错将无法开始预启动检查，其完整的实例化演示如下：</div>
 
     ```C#
-    GameCoreUtil gcu = new("你的游戏目录"); //默认为.minecraft
+    GameCoreUtil gcu = new("您的游戏目录"); //默认为.minecraft
     ```
 
 
@@ -72,24 +72,24 @@ JavaMinecraftLauncher(LaunchConfig launchSetting, GameCoreUtil gameCoreUtil);
 初始化完成后即可开始启动步骤，使用'LaunchTaskAsync'方法
 + 代码示例
     ```C#
-    using var res = await jml.LaunchTaskAsync("你要启动的游戏Id");
+    using var res = await jml.LaunchTaskAsync("您要启动的游戏Id");
     ```
 
-如果你需要查看当前启动的进度，请使用 LaunchTaskAsync 方法的另一个重载
+如果您需要查看当前启动的进度，请使用 LaunchTaskAsync 方法的另一个重载
 + 代码示例
 
     ```C#
-    using var res = await jml.LaunchTaskAsync("你要启动的游戏Id", x =>
+    using var res = await jml.LaunchTaskAsync("您要启动的游戏Id", x =>
     {
         //在这里获取当前启动进度,利用x.Item1获取数字进度,x.Item2获取文字进度
     });
     ```
-如果你用的是WinForm、WPF、Avalonia等图形化UI，在启动时程序整个卡死，请尝试使用 Task 合理解决
+如果您用的是WinForm、WPF、Avalonia等图形化UI，在启动时程序整个卡死，请尝试使用 Task 合理解决
 + 代码示例
     ```C#
     await Task.Run(() =>
     {
-    using var res = await jml.LaunchTaskAsync("你要启动的游戏Id");
+    using var res = await jml.LaunchTaskAsync("您要启动的游戏Id");
     });
     ```
 

diff --git a/docs/en_US/minecraftlaunch/utils/curseforge.md b/docs/en_US/minecraftlaunch/utils/curseforge.md
@@ -13,12 +13,12 @@
 
 ```C#
 
-CurseForgeUtil util = new("你的 API Key");
+CurseForgeUtil util = new("您的 API Key");
 
 ```
 
 ## 基本信息
-在完成了实例化后，您就可以正式使用了，首先，我将为你叙述 ML 的操作逻辑，搜索方法共有5种，分别用来搜索模组、
+在完成了实例化后，您就可以正式使用了，首先，我将为您叙述 ML 的操作逻辑，搜索方法共有5种，分别用来搜索模组、
 资源包、整合包以及地图，它们都使用 `SearchResourceAsync` 这个基础搜索方法来进行简化搜索操作.
 
 下表列出的是 `CurseForgeUtil` 的所有方法

diff --git a/docs/en_US/minecraftlaunch/utils/gamecore.md b/docs/en_US/minecraftlaunch/utils/gamecore.md
@@ -23,7 +23,7 @@ GameCoreUtil(DirectoryInfo root);
 
 ## 基本信息
 
-在完成了实例化后，您就可以正式使用了，首先，我将为你叙述 ML 的操作逻辑，共有6种操作游戏核心的方法
+在完成了实例化后，您就可以正式使用了，首先，我将为您叙述 ML 的操作逻辑，共有6种操作游戏核心的方法
 
 下表列出的是 `GameCoreUtil` 的所有方法：
 |方法名|说明|
@@ -46,7 +46,7 @@ GameCoreUtil(DirectoryInfo root);
 
 + 代码示例
     ```C#
-    var core = gcu.ReName("游戏核心原名", "你要修改的名字");
+    var core = gcu.ReName("游戏核心原名", "您要修改的名字");
     ```
 
 ### GetGameCore

diff --git a/docs/en_US/minecraftlaunch/utils/java.md b/docs/en_US/minecraftlaunch/utils/java.md
@@ -23,7 +23,7 @@
 
 执行这个方法后，它会返回类型为 “IEnumerable\<JavaInfo>” 的一个列表，这个列表包含了大部分磁盘上的 Java 信息。（如果一些Java所在的位置没有被词典所收录，那么这个Java将不会搜索到。）
 
-你可以通过 “JavaInfo” 类来获取 Java 的版本，位数等信息。
+您可以通过 “JavaInfo” 类来获取 Java 的版本，位数等信息。
 
 :::tip
 JavaInfo类包含的属性有：
@@ -50,12 +50,12 @@ using MinecraftLaunch.Modules.Utilities;
 IEnumerable<JavaInfo> JavaList = JavaUtil.GetJavas();
 
 //输出
-Debug.WriteLine("你的Java数量为：" + JavaList.Count());
+Debug.WriteLine("您的Java数量为：" + JavaList.Count());
 ```
 
 #### 输出
 
-假设你的电脑里有两个Java，它们分别为
+假设您的电脑里有两个Java，它们分别为
 
 - JRE 1.8.0_391 - 32bit
 
@@ -64,15 +64,15 @@ Debug.WriteLine("你的Java数量为：" + JavaList.Count());
 那么，这些代码应该返回：
 
 ``` 
-你的Java数量为：2
+您的Java数量为：2
 ```
 
 ### GetJavaInfo(string)
 
 #### 用法
 
-这个方法需要一个字符串：string，也就是说你需要提供javaw.exe可执行文件的路径。
-执行这个方法后，它会返回一个类型为JavaInfo的对象，这个对象包含了 Java 的版本，位数等信息，你可以在GetJavas的用法中找到JavaInfo的使用方法。
+这个方法需要一个字符串：string，也就是说您需要提供javaw.exe可执行文件的路径。
+执行这个方法后，它会返回一个类型为JavaInfo的对象，这个对象包含了 Java 的版本，位数等信息，您可以在GetJavas的用法中找到JavaInfo的使用方法。
 
 #### 示例代码
 
@@ -91,7 +91,7 @@ Console.WriteLine(javaInfo.JavaPath + ", " + javaInfo.JavaVersion + ", " + javaI
 
 #### 输出
 
-假设你的电脑里有个Java，它的路径为C:\Program Files\Java\jdk-17.0.9\bin\javaw.exe，那么，这些代码应该返回：
+假设您的电脑里有个Java，它的路径为C:\Program Files\Java\jdk-17.0.9\bin\javaw.exe，那么，这些代码应该返回：
 
 ```
 C:\Program Files\Java\jdk-17.0.9\bin\javaw.exe, 17.0.9, True
@@ -101,8 +101,8 @@ C:\Program Files\Java\jdk-17.0.9\bin\javaw.exe, 17.0.9, True
 
 #### 讲解
 
-这个方法需要一个类型为IEnumerable\<JavaInfo>的对象，以及一个类型为GameCore的对象，你可以在“游戏核心操作工具”找到更多关于GameCore的信息。
-这个方法会返回一个类型为JavaInfo的对象，这个对象包含了 Java 的版本，位数等信息，返回的Java适合运行提供的核心的游戏，你可以在GetJavas的用法中找到JavaInfo的使用方法。
+这个方法需要一个类型为IEnumerable\<JavaInfo>的对象，以及一个类型为GameCore的对象，您可以在“游戏核心操作工具”找到更多关于GameCore的信息。
+这个方法会返回一个类型为JavaInfo的对象，这个对象包含了 Java 的版本，位数等信息，返回的Java适合运行提供的核心的游戏，您可以在GetJavas的用法中找到JavaInfo的使用方法。
 
 #### 示例代码
 
@@ -128,7 +128,7 @@ Console.WriteLine(javaInfo.JavaPath + ", " + javaInfo.JavaVersion + ", " + javaI
 
 #### 输出
 
-假如你的.minecraft文件夹的路径为C:\Users\Starcloudsea\AppData\Roaming\\.minecraft，里面有一个版本：1.20.2，并且你的电脑有两个Java，它们分别是：
+假如您的.minecraft文件夹的路径为C:\Users\Starcloudsea\AppData\Roaming\\.minecraft，里面有一个版本：1.20.2，并且您的电脑有两个Java，它们分别是：
 JDK 17.0.8
 JRE 1.8.0_391
 那么，这些代码应该返回：

diff --git a/docs/en_US/wonderlab/intro.md b/docs/en_US/wonderlab/intro.md
@@ -26,15 +26,15 @@ WonderLab 是一个跨平台 Minecraft 启动器，支持自动更新、Modrinth
 
 ## 如何安装
 
-可以在 [Releases](https://github.com/Blessing-Studio/WonderLab.Override/releases) 下载你想要的版本
+可以在 [Releases](https://github.com/Blessing-Studio/WonderLab.Override/releases) 下载您想要的版本
 
 `master` 分支 Releases 打包文件命名规则： WonderLab.Override.`版本号`.`系统`-`架构`
 
 `feature` 分支 Releases 打包文件命名规则： WonderLab.Remake.`版本号`.`系统`-`架构`
 
 ## 反馈问题
 
-可以在本仓库的 [`Issues`](https://github.com/Blessing-Studio/WonderLab.Override/issues) 或 [`Discussion`](https://github.com/Blessing-Studio/WonderLab.Override/discussions) 中提出你的建议和疑惑
+可以在本仓库的 [`Issues`](https://github.com/Blessing-Studio/WonderLab.Override/issues) 或 [`Discussion`](https://github.com/Blessing-Studio/WonderLab.Override/discussions) 中提出您的建议和疑惑
 
 当然，您的 [`PR`](https://github.com/Blessing-Studio/WonderLab.Override/pulls) 也是受欢迎的
 

diff --git a/docs/index.md b/docs/index.md
@@ -9,21 +9,22 @@ hero:
   text: 终端档案库
   tagline: (WIP)
   actions:
+
     - theme: brand
       text: 快速上手
       link: zh_CN/introduce
+
     - theme: alt
-      text: 工作室官网
-      link: https://blessing-studio.cn
-    - theme: alt
-      text: Github仓库
+      text: Github 仓库
       link: https://github.com/Blessing-Studio
 
 features:
+
   - icon: ⁉️
     title: 疑难解答
-    details: 在这里查看并解决使用我们项目时可能遇到的错误。
+    details: 在这里查看并解决使用我们项目时可能遇到的问题
+
   - icon: 🛠️
     title: 开发文档
-    details: 这里储存着所有 Blessing Studio 开发的项目的开发文档。
+    details: 正在使用来自 Blessing Studio 的开源项目？在这里可以查看我们的技术支持文档
 ---
diff --git a/docs/zh_CN/index.md b/docs/zh_CN/index.md
@@ -2,28 +2,33 @@
 layout: home
 
 title: 终端档案库
-titleTemplate: 用代码表达言语的魅力，用代码书写山河的壮丽。
+titleTemplate: 启星世界，书写代码山河
 
 hero:
   name: TA
   text: 终端档案库
   tagline: (WIP)
   actions:
+
     - theme: brand
       text: 快速上手
       link: zh_CN/introduce
+
     - theme: alt
-      text: Github
+      text: Github 仓库
       link: https://github.com/Blessing-Studio
 
 features:
+
   - icon: ⁉️
     title: 疑难解答
-    details: 在这里查看并解决使用我们项目时可能遇到的错误。
+    details: 在这里查看并解决使用我们项目时可能遇到的问题
+
   - icon: 🛠️
     title: 开发文档
-    details: 正在使用来自 Blessing Studio 的开源项目？在这里你可以查看我们的技术文档。
+    details: 正在使用来自 Blessing Studio 的开源项目？在这里可以查看我们的技术支持文档
+
   # - icon: 🖖
   #   title: 敏捷开发
-  #   details: 项目提供多种语言指导，未来还将提供 SDK 。
+  #   details: 项目提供多种语言指导，未来还将提供 SDK 
 ---
diff --git a/docs/zh_CN/introduce.md b/docs/zh_CN/introduce.md
@@ -10,7 +10,7 @@ import {
 
 const members = [
   {
-    avatar: 'https://avatars.githubusercontent.com/u/99802662?v=4',
+    avatar: 'https://github.com/YangSpring114.png',
     name: 'YangSpring114',
     title: '创建者',
     links: [