Merge pull request #25 from DGP-Studio/dev

Localization structure update

crowdin.yml

@@ -1,9 +1,9 @@
 files:
-  - source: /docs/*.md
+  - source: /docs/zh/*.md
     translation: /docs/%two_letters_code%/%original_file_name%
-  - source: /docs/features/*.md
+  - source: /docs/zh/features/*.md
     translation: /docs/%two_letters_code%/features/%original_file_name%
-  - source: /docs/statements/*.md
+  - source: /docs/zh/statements/*.md
     translation: /docs/%two_letters_code%/statements/%original_file_name%
-  - source: /docs/advanced/*.md
+  - source: /docs/zh/advanced/*.md
     translation: /docs/%two_letters_code%/advanced/%original_file_name%

docs/.vuepress/config.ts

@@ -4,6 +4,7 @@ import theme from "./theme.js";
 import { autoCatalogPlugin } from "vuepress-plugin-auto-catalog";
 import { docsearchPlugin } from '@vuepress/plugin-docsearch'
 import { googleAnalyticsPlugin } from '@vuepress/plugin-google-analytics'
+import { redirectPlugin } from "vuepress-plugin-redirect";
 
 export default defineUserConfig({
   base: "/",
@@ -17,7 +18,7 @@ export default defineUserConfig({
       ['script', {type: "module", src:"https://get.microsoft.com/badge/ms-store-badge.bundled.js"}],
   ],
   locales: {
-    "/": {
+    "/zh/": {
       lang: "zh-CN",
       title: "胡桃工具箱",
       description: "多功能的原神工具箱",
@@ -35,7 +36,7 @@ export default defineUserConfig({
       apiKey: "72d7a9a0f9f0466218ea19988886dce8",
       indexName: "hutao",
       locales: {
-        "/": {
+        "/zh/": {
           placeholder: "搜索文档",
           translations:{
             button:{
@@ -43,7 +44,7 @@ export default defineUserConfig({
             }
           }
         },
-        "en": {
+        "/en/": {
           placeholder: "Search documents",
           translations:{
             button:{
@@ -55,7 +56,16 @@ export default defineUserConfig({
     }),
     googleAnalyticsPlugin({
       id: "G-F3LFJCE3RM"
-    })
+    }),
+    redirectPlugin({
+      defaultLocale: "/en/",
+      defaultBehavior: "defaultLocale",
+      autoLocale: true,
+      localeConfig: {
+        "/en/": ["en-US", "en-UK", "en"],
+        "/zh/": ["zh-CN", "zh-TW", "zh"],
+      }
+    }),
   ],
 
   theme,

docs/.vuepress/navbar/zh.ts

@@ -1,8 +1,8 @@
 import { navbar } from "vuepress-theme-hope";
 
 export const zhNavbar = navbar([
-  "/",
-  { text: "文档", icon: "article", link: "/features/"},
+  "/zh/",
+  { text: "文档", icon: "article", link: "/zh/features/"},
   {
     text: "下载",
     icon: "install",
@@ -11,6 +11,6 @@ export const zhNavbar = navbar([
   {
     text: "加入社区讨论",
     icon: "community",
-    link: "/community.md"
+    link: "/zh/community.md"
   },
 ]);

docs/.vuepress/sidebar/en.ts

@@ -2,39 +2,39 @@ import { sidebar } from "vuepress-theme-hope";
 
 export const enSidebar = sidebar({
   "/en/": [
-    "",
-    {
-      icon: "workingDirectory",
-      text: "Project",
-      link: "project.md"
-    },
-    {
-      icon: "network",
-      text: "Localization",
-      link: "i18n.md"
-    },
-    {
-      icon: "play",
-      text: "Quick Start",
-      link: "quick-start.md"
-    },
-    {
-      icon: "read",
-      text: "Features",
-      prefix: "features/",
-      children: "structure"
-    },
-    {
-      icon: "advance",
-      text: "Advanced",
-      prefix: "advanced/",
-      children: "structure"
-    },
-    {
-      icon: "article",
-      text: "Statements",
-      prefix: "statements/",
-      children: "structure"
-    }
+      "",
+      {
+        icon: "workingDirectory",
+        text: "Project",
+        link: "project.md"
+      },
+      {
+        icon: "network",
+        text: "Localization",
+        link: "i18n.md"
+      },
+      {
+        icon: "play",
+        text: "Quick Start",
+        link: "quick-start.md"
+      },
+      {
+        icon: "read",
+        text: "Features",
+        prefix: "features/",
+        children: "structure"
+      },
+      {
+        icon: "advance",
+        text: "Advanced",
+        prefix: "advanced/",
+        children: "structure"
+      },
+      {
+        icon: "article",
+        text: "Statements",
+        prefix: "statements/",
+        children: "structure"
+      }
   ],
 });

docs/.vuepress/sidebar/zh.ts

@@ -1,7 +1,7 @@
 import { sidebar } from "vuepress-theme-hope";
 
 export const zhSidebar = sidebar({
-  "/": [
+  "/zh/": [
       "",
       {
           icon: "workingDirectory",

docs/.vuepress/theme.ts

@@ -42,7 +42,7 @@ export default hopeTheme({
     /**
      * Chinese locale config
      */
-    "/": {
+    "/zh/": {
       // navbar
       navbar: zhNavbar,
 

docs/en/README.md

@@ -2,7 +2,7 @@
 home: true
 icon: home
 title: Home
-heroImage: https://img.alicdn.com/imgextra/i1/1797064093/O1CN01TOz2Cm1g6du5e8Hml_!!1797064093.png
+heroImage: https://img.alicdn.com/imgextra/i4/1797064093/O1CN01vK3m2w1g6duwt8quS_!!1797064093.png
 heroText: Snap Hutao
 tagline: Multifunctional open-source Genshin Utility
 actions:
@@ -19,12 +19,12 @@ actions:
 features:
   - title: Better than Snap.Genshin
     icon: /images/202209/SGLogoUpgrade64.png
-    details: Snap.Hutao has more extensive data support and better client performance while inheriting all Snap.Genshin functionality
+    details: Snap.Hutao has more extensive data support and better client performance while inheriting all Snap Genshin functionality
     link: /project.md
 
   - title: DailyNote
     icon: /images/202301/live-stat-tracking-logo.png
-    details: 不必再被手机 App 所束缚；在你的电脑就能直接获取米游社实时便笺信息并收到 Windows 原生通知提示
+    details: Don't be trapped by Mobile Application. Receive your Genshin DailyNote notification on your desktop with native Windows notification
     link: /features/daily-notes.md
 
   - title: Spiral Abyss Record
@@ -39,7 +39,7 @@ features:
 
   - title: Wish History Record
     icon: /images/202209/IndexIconWish.png
-    details: 支持多UID切换，从游戏日志文件获取或从其它祈愿记录程序导出数据，永久保留玩家的祈愿记录
+    details: Capture your wish history from your game log, export them to your local device, with the support of unlimited account data archives
     link: /features/wish-export.md
 
   - title: Achievement
@@ -78,6 +78,25 @@ features:
     link: /features/develop-plan.md
 
 copyright: false
-footer: MIT Licensed | Copyright © 2019-present Mr.Hope
+footer: MIT Licensed | Copyright © 2019-present Mr.Hope | Powered By <a href="https://www.netlify.com/">Netlify</a>
 
 ---
+## Contribute
+
+Snap Hutao is a free software maintained by open-source community, and we hope more players with same 
+ambitions can join together to provide more features to the community.
+
+You can make contribution by the following ways:
+1. [Make Pull Requests to our code](https://github.com/DGP-Studio/Snap.Hutao/pulls)
+2. Improve localization by translating the project on Crowdin
+    1. [Snap Hutao](https://translate.hut.ao/)
+    2. [Snap Hutao Document](https://translate-docs.hut.ao/)
+3. [Update document](https://github.com/DGP-Studio/Snap.Hutao.Docs)
+
+@include(star-request.md)
+
+## Service Used
+Snap Hutao is currently using software from the following service providers.
+
+<a href="https://www.netlify.com"> <img src="https://www.netlify.com/v3/img/components/netlify-light.svg" alt="Deploys by Netlify" /> </a>
+<a href="https://crowdin.com/?utm_source=badge&utm_medium=referral&utm_campaign=badge-add-on" rel="nofollow"><img style="width:140;height:40px" src="https://badges.crowdin.net/badge/light/crowdin-on-dark.png" srcset="https://badges.crowdin.net/badge/light/crowdin-on-dark.png 1x,https://badges.crowdin.net/badge/light/crowdin-on-dark@2x.png 2x" alt="Crowdin | Agile localization for tech companies" /></a>

docs/en/features/mhy-account-switch.md

@@ -29,7 +29,7 @@ order: 10
   - 在弹出的内置浏览器中登录"米哈游通行证"账号
     - 您也可以通过点击`手动输入`按钮，直接输入米游社通行证 cookie 来添加您的帐号
     - 若您选择`手动输入`米游社 cookie，则该 cookie **必须包含 `Stoken` 字段**
-      - 手动获取含 `Stoken` 字段的 cookie 的方式可参考[使用第三方工具获取有 Stoken 的 cookie](/advanced/get-stoken-cookie-from-the-third-party.md) 文档
+      - 手动获取含 `Stoken` 字段的 cookie 的方式可参考[使用第三方工具获取有 Stoken 的 cookie](../advanced/get-stoken-cookie-from-the-third-party.md) 文档
   - 在弹出的内置浏览器登陆成功后，点击右上角的"我已登陆"按钮
   - 完成后，您就可以在帐号管理面板切换已登录的米游社帐号了
     - 新添加米游社账号后，需在主界面左下角切换账号的功能中，手动点击一次新登录的账号，以将其设置为使用状态

docs/en/features/wish-export.md

@@ -12,7 +12,7 @@ order: 2
 
 因此，我们需要利用这半年的抽卡记录调取窗口，将抽卡记录转移到我们自己手中，这就是胡桃工具箱中祈愿记录导出功能的目的所在。
 
-有关原神祈愿记录导出的技术原理，你可以参阅我们的[**祈愿系统与导出原理**](/advanced/Gacha-system-and-export-principal.md)一文。
+有关原神祈愿记录导出的技术原理，你可以参阅我们的[**祈愿系统与导出原理**](../advanced/Gacha-system-and-export-principal.md)一文。
 
 ![祈愿导出](https://img.alicdn.com/imgextra/i3/1797064093/O1CN01B2DDii1g6du87XIIG_!!1797064093.png)
 

docs/en/markmap.md

@@ -1,23 +0,0 @@
-# 胡桃工具箱
-
-## 米游社功能
-
-- 活动公告
-- 帐号登录
-- 实时便笺
-- 深境螺旋
-    - 我的深渊记录
-    - 胡桃数据库 - 深渊数据
-
-## 游戏性增强
-
-- 高级启动器
-- 祈愿记录
-- 成就管理
-
-## 养成计划
-
-- 养成计算器
-    - 属性统计
-    - 角色 Wiki
-    - 武器 Wiki

docs/en/quick-start.md

@@ -9,7 +9,7 @@ category:
 # Quick Start
 
 ::: tip
-If you download and use **Snap Hutao**，you are agree to our[ terms of service](/statements/tos.md)
+If you download and use **Snap Hutao**，you are agree to our[ terms of service](statements/tos.md)
 :::    
 @include(star-request.md)
 

docs/zh/README.md

@@ -78,5 +78,24 @@ features:
     link: /features/develop-plan.md
 
 copyright: false
-footer: MIT Licensed | Copyright © 2019-present Mr.Hope
+footer: MIT Licensed | Copyright © 2019-present Mr.Hope | Powered By <a href="https://www.netlify.com/">Netlify</a>
 ---
+
+## 贡献
+
+Snap Hutao 是一个由开源社区维护的免费项目，我们希望有更多志同道合的开发者能参与到项目中，为 Snap Hutao 带来更多的功能。
+
+你可以通过以下方法为项目作出贡献：
+1. [向我们提交 PR](https://github.com/DGP-Studio/Snap.Hutao/pulls)
+2. 在 Crowdin 上进行本地化翻译
+   1. [主项目](https://translate.hut.ao/)
+   2. [文档](https://translate-docs.hut.ao/)
+3. [为我们更新文档](https://github.com/DGP-Studio/Snap.Hutao.Docs)
+
+@include(star-request.md)
+
+## 平台
+Snap Hutao 目前使用了以下软件厂商提供的服务
+
+<a href="https://www.netlify.com"> <img src="https://www.netlify.com/v3/img/components/netlify-light.svg" alt="Deploys by Netlify" /> </a>
+<a href="https://crowdin.com/?utm_source=badge&utm_medium=referral&utm_campaign=badge-add-on" rel="nofollow"><img style="width:140;height:40px" src="https://badges.crowdin.net/badge/light/crowdin-on-dark.png" srcset="https://badges.crowdin.net/badge/light/crowdin-on-dark.png 1x,https://badges.crowdin.net/badge/light/crowdin-on-dark@2x.png 2x" alt="Crowdin | Agile localization for tech companies" /></a>

docs/zh/advanced/FAQ.md

@@ -3,6 +3,7 @@ headerDepth: 2
 icon: ask
 category: [FAQ]
 order: 1
+redirectFrom: /advanced/FAQ.html
 ---
 
 # 常见问题

docs/zh/advanced/Gacha-system-and-export-principal.md

@@ -3,6 +3,7 @@ headerDepth: 0
 category: [FAQ]
 icon: read
 order: 7
+redirectFrom: /advanced/Gacha-system-and-export-principal.html
 ---
 
 # 祈愿系统与导出原理

docs/zh/advanced/README.md

@@ -1,6 +1,7 @@
 ---
 comment: false
 index: false
+redirectFrom: /advanced/
 ---
 # 高级
 

docs/zh/advanced/artifact-rating-rules.md

@@ -2,6 +2,7 @@
 category: [FAQ]
 icon: read
 order: 5
+redirectFrom: /advanced/artifact-rating-rules.html
 ---
 
 # 圣遗物评分机制

docs/zh/advanced/exceptions.md

@@ -3,6 +3,7 @@ headerDepth: 2
 icon: debug
 category: [FAQ]
 order: 2
+redirectFrom: /advanced/exceptions.html
 ---
 # 常见的程序异常
 该文档包含由**用户端错误**造成的问题

docs/zh/advanced/get-stoken-cookie-from-the-third-party.md

@@ -2,6 +2,7 @@
 category: [FAQ, 第三方工具]
 icon: read
 order: 6
+redirectFrom: /advanced/get-stoken-cookie-from-the-third-party.html
 ---
 
 # 使用第三方工具获取有 Stoken 的 cookie

docs/zh/advanced/known-issue.md

@@ -3,6 +3,7 @@ headerDepth: 2
 icon: tool
 category: [FAQ]
 order: 3
+redirectFrom: /advanced/known-issue.html
 ---
 # 已知问题
 该文档包含由**程序错误**造成的问题

docs/zh/advanced/mihoyo-risk-tip.md

@@ -3,6 +3,7 @@ headerDepth: 0
 icon: warn
 category: [FAQ]
 order: 4
+redirectFrom: /advanced/mihoyo-risk-tip.html
 ---
 
 # 账号风险及异常提示

docs/zh/advanced/uninstall.md

@@ -2,6 +2,7 @@
 category: [FAQ]
 icon: delete
 order: 8
+redirectFrom: /advanced/uninstall.html
 ---
 # 卸载胡桃工具箱
 

docs/zh/community.md

@@ -1,6 +1,7 @@
 ---
 headerDepth: 0
 category: [公告]
+redirectFrom: /community.html
 ---
 
 # 加入用户社区

docs/zh/features/README.md

@@ -2,6 +2,7 @@
 headerDepth: 0
 comment: false
 index: false
+redirectFrom: /features/
 ---
 # 功能指南
 

docs/zh/features/achievements.md

@@ -2,6 +2,7 @@
 headerDepth: 0
 category: [功能,教程]
 order: 3
+redirectFrom: /features/achievements.html
 ---
 
 # 成就管理 

docs/zh/features/character-data.md

@@ -2,6 +2,7 @@
 headerDepth: 0
 category: [功能,教程]
 order: 5
+redirectFrom: /features/character-data.html
 ---
 
 # 属性统计  

docs/zh/features/character-wiki.md

@@ -2,6 +2,7 @@
 headerDepth: 0
 category: [功能,教程]
 order: 8
+redirectFrom: /features/character-wiki.html
 ---
 
 # 角色资料

docs/zh/features/daily-notes.md

@@ -2,6 +2,7 @@
 headerDepth: 0
 category: [功能,教程]
 order: 4
+redirectFrom: /features/daily-notes.html
 ---
 
 # 实时便笺

docs/zh/features/develop-plan.md

@@ -2,6 +2,7 @@
 headerDepth: 0
 category: [功能,教程]
 order: 7
+redirectFrom: /features/developer-plan.html
 ---
 
 # 养成计划   

docs/zh/features/game-launcher.md

@@ -2,6 +2,7 @@
 headerDepth: 0
 category: [功能,教程]
 order: 1
+redirectFrom: /features/game-launcher.html
 ---
 
 # 高级启动器

docs/zh/features/hutao-API.md

@@ -2,6 +2,7 @@
 headerDepth: 0
 category: [功能,教程]
 order: 6
+redirectFrom: /features/hutao-API.html
 ---
 
 # 胡桃数据库/深渊统计

docs/zh/features/hutao-settings.md

@@ -2,6 +2,7 @@
 headerDepth: 0
 category: [功能,教程]
 order: 11
+redirectFrom: /features/hutao-settings.html
 ---
 
 # 软件设置

docs/zh/features/mhy-account-switch.md

@@ -2,6 +2,7 @@
 headerDepth: 0
 category: [功能,教程]
 order: 10
+redirectFrom: /features/mhy-account-switch.html
 ---
 
 # 米游社多帐号切换
@@ -27,7 +28,7 @@ order: 10
   - 在弹出的内置浏览器中登录"米哈游通行证"账号
     - 您也可以通过点击`手动输入`按钮，直接输入米游社通行证 cookie 来添加您的帐号
     - 若您选择`手动输入`米游社 cookie，则该 cookie **必须包含 `Stoken` 字段**
-      - 手动获取含 `Stoken` 字段的 cookie 的方式可参考[使用第三方工具获取有 Stoken 的 cookie](/advanced/get-stoken-cookie-from-the-third-party.md) 文档
+      - 手动获取含 `Stoken` 字段的 cookie 的方式可参考[使用第三方工具获取有 Stoken 的 cookie](../advanced/get-stoken-cookie-from-the-third-party.md) 文档
   - 在弹出的内置浏览器登陆成功后，点击右上角的"我已登陆"按钮
   - 完成后，您就可以在帐号管理面板切换已登录的米游社帐号了
     - 新添加米游社账号后，需在主界面左下角切换账号的功能中，手动点击一次新登录的账号，以将其设置为使用状态

docs/zh/features/weapon-wiki.md

@@ -2,6 +2,7 @@
 headerDepth: 0
 category: [功能,教程]
 order: 9
+redirectFrom: /features/weapon-wiki.html
 ---
 
 # 武器资料

docs/zh/features/wish-export.md

@@ -2,6 +2,7 @@
 headerDepth: 0
 category: [功能,教程]
 order: 2
+redirectFrom: /features/wish-export.html
 ---
 
 # 祈愿记录
@@ -11,7 +12,7 @@ order: 2
 
 因此，我们需要利用这半年的抽卡记录调取窗口，将抽卡记录转移到我们自己手中，这就是胡桃工具箱中祈愿记录导出功能的目的所在。
 
-有关原神祈愿记录导出的技术原理，你可以参阅我们的[**祈愿系统与导出原理**](/advanced/Gacha-system-and-export-principal.md)一文。
+有关原神祈愿记录导出的技术原理，你可以参阅我们的[**祈愿系统与导出原理**](../advanced/Gacha-system-and-export-principal.md)一文。
 
 ![祈愿导出](https://img.alicdn.com/imgextra/i3/1797064093/O1CN01B2DDii1g6du87XIIG_!!1797064093.png)
 

docs/zh/i18n.md

@@ -1,3 +1,8 @@
+---
+headerDepth: 0
+category: [公告]
+redirectFrom: /i18n.html
+---
 # 国际化支持
 ## 国际化进度
 Snap Hutao 虽然基于原神国服提供功能，但项目也有意提升国际化支持，包括语言本土化和功能国际化。目前国际化进度如下：

docs/zh/project.md

@@ -1,6 +1,7 @@
 ---
 headerDepth: 0
 category: [公告]
+redirectFrom: /project.html
 ---
 
 # 项目说明

docs/zh/quick-start.md

@@ -2,11 +2,12 @@
 pageClass: link-box
 externalLinkIcon: false
 category: [功能,教程]
+redirectFrom: /quick-start.html
 ---
 # 快速开始
    
 ::: tip
-若您已下载或使用**胡桃工具箱**，即表示你已阅读并完全同意[用户使用协议与法律声明](/statements/tos.md)
+若您已下载或使用**胡桃工具箱**，即表示你已阅读并完全同意[用户使用协议与法律声明](statements/tos.md)
 :::
 @include(star-request.md)
 
@@ -53,7 +54,7 @@ theme="auto">
 
 :::
 ### 从侧载版升级至商店版
-- 按照文档提供的[卸载方法](/advanced/uninstall.html)卸载侧载版应用
+- 按照文档提供的[卸载方法](advanced/uninstall.html)卸载侧载版应用
   - 只要不手动删除数据目录，你的数据不会受到影响
 - 按照上述方法全新安装商店版应用
 

docs/zh/statements/README.md

@@ -2,6 +2,7 @@
 headerDepth: 0
 comment: false
 index: false
+redirectFrom: /statements/
 ---
 # 声明和公告
 

docs/zh/statements/bug-report.md

@@ -3,6 +3,7 @@ headerDepth: 0
 category: [公告]
 icon: debug
 order: 2
+redirectFrom: /statements/bug-report.html
 ---
 
 # 提交BUG报告

docs/zh/statements/privacy-notice.md

@@ -3,6 +3,7 @@ headerDepth: 0
 category: [公告]
 icon: license
 order: 3
+redirectFrom: /statements/privacy-notice.html
 ---
 
 # 用户数据和隐私权益

docs/zh/statements/tos.md

@@ -5,6 +5,7 @@ comment: false
 editLink: false
 icon: license
 order: 4
+redirectFrom: /statements/toshtml
 ---
 
 # 用户使用协议和法律声明   

docs/zh/statements/update-log.md

@@ -2,6 +2,7 @@
 category: [公告]
 icon: update
 order: 1
+redirectFrom: /statements/update-log.html
 ---
 # 更新日志
 ## 1.5.4 <Badge text="最新版" type="tip" />

package.json

@@ -15,6 +15,7 @@
     "@vuepress/plugin-google-analytics": "2.0.0-beta.61",
     "vue": "^3.2.47",
     "vuepress": "2.0.0-beta.61",
-    "vuepress-theme-hope": "2.0.0-beta.189"
+    "vuepress-plugin-redirect": "^2.0.0-beta.196",
+    "vuepress-theme-hope": "2.0.0-beta.196"
   }
 }