Add Chinese Simplified translation (#47)

Azuriom · Sep 1, 2022 · 334f249 · 334f249
1 parent 3427962
commit 334f249
Show file tree

Hide file tree

Showing 18 changed files with 638 additions and 5 deletions.
diff --git a/config.yml b/config.yml
@@ -38,3 +38,8 @@ languages:
     contentDir: content/cs
     params:
       code: cs_CZ
+  zh-CN:
+    languageName: 简体中文
+    contentDir: content/zh-cn
+    params:
+      code: zh_CN
diff --git a/content/zh-cn/_index.md b/content/zh-cn/_index.md
@@ -0,0 +1,3 @@
+---
+title: 首页
+---
diff --git a/content/zh-cn/azlink.md b/content/zh-cn/azlink.md
@@ -0,0 +1,5 @@
+---
+title: AzLink
+description: AzLink 是 Azuriom 的附属插件，它可以方便、快捷、安全地把您的服务器与您的 Azuriom 站点连接在一起。
+layout: azlink
+---
diff --git a/content/zh-cn/docs/_index.md b/content/zh-cn/docs/_index.md
@@ -0,0 +1,40 @@
+---
+title: 首页
+description: Azuriom 文档包含了很多关于 Azuriom 的有用信息，用于安装、使用或拓展开发。
+weight: 0
+layout: single
+---
+
+{{< warn >}}
+Azuriom 文档的中文版本仍在翻译中, 目前仅提供已翻译的内容, 其他内容请参阅 [英语版本](/en/docs)  
+如果您有兴趣为我们贡献翻译, 请在 [GitHub](https://github.com/Azuriom/azuriom.com) 上提交 Pull Request.
+{{< /warn >}}
+
+# 首页
+
+## 介绍
+
+[Azuriom](https://azuriom.com/) 是**新一代**游戏 CMS,
+ 它是**免费**和**开源**的, 并且是现有 CMS 的**现代**、**可靠**、**快速与安全**的替代品，因此你可以获得 **超棒的互联网体验**.
+
+Azuriom 拥有**高级**拓展系统，所以您可以通过我们商店中的拓展**完全自定义**您的网站,
+像 **Moderns** 和 **响应式主题** 或者像 **商店**、**论坛**这样的**插件**，以及更多!
+
+你可以在此文档中找到所有关于 Azuriom 的信息！
+
+如果你需要帮助请前往 [Discord 服务器](https://azuriom.com/discord) 询问.
+
+## 贡献
+
+Azuriom 由 [MrMicky](https://mrmicky.fr/) & [SkyWarZzeur](https://twitter.com/SkyWarZzeur) 使用 PHP
+框架 [Laravel](https://laravel.com/) 共同开发.
+
+另外, 衷心感谢 [Jav](https://www.linkedin.com/in/jean-alexandre-valentin-531236153/) 的巨大贡献，感谢我们的合作伙伴 [NiHost](https://www.ni-host.com/?utm_source=home&utm_medium=links&utm_campaign=AzuriomCom) 对我们的信任，感谢所有
+[Azuriom 贡献者](https://github.com/Azuriom/Azuriom/graphs/contributors) 的帮助.
+
+### 赞助者
+
+赞助者们让本项目从无到有，非常感谢他们，尤其要感谢:
+* [Akuyuma](https://toxyca.fr/)
+* micro_maniaque
+* [Skillz](https://www.evolved-network.com/)
diff --git a/content/zh-cn/docs/api-auth.md b/content/zh-cn/docs/api-auth.md
@@ -0,0 +1,217 @@
+---
+title: 验证 API
+---
+
+# AzAuth
+
+AzAuth 是一个 API, 允许你在任何平台上对 Azuriom 下的网站用户进行认证。
+
+{{< warn >}}
+无论你如何使用客户端的认证 API, 必须在服务器上使用 `verify` 方法以验证客户端返回的访问令牌是否有效.
+{{< /warn >}}
+
+## 下载
+
+AzAuth 的源码可以在 [GitHub](https://github.com/Azuriom/AzAuth)
+上找到, 你可以在 [这里](https://oss.sonatype.org/content/repositories/snapshots/com/azuriom/azauth/0.1.0-SNAPSHOT/azauth-0.1.0-20220420.160910-3.jar) 下载 AzAuth 的 Jar 文件.
+
+如果你正在使用依赖管理器, 你可以通过以下方式将 AzAuth 添加为依赖项:
+
+### Gradle
+
+在 `build.gradle` 文件内:
+
+```groovy
+repositories {
+    mavenCentral()
+} 
+
+dependencies {
+    implementation 'com.azuriom:azauth:1.0.0'
+}
+```
+
+### Maven
+
+在 `pom.xml` 文件内:
+```xml
+<dependencies>
+    <dependency>
+        <groupId>com.azuriom</groupId>
+        <artifactId>azauth</artifactId>
+        <version>1.0.0</version>
+        <scope>compile</scope>
+    </dependency>
+</dependencies>
+```
+
+## AzAuth 使用方法 (Java)
+
+在使用 AzAuth 之前，请确保在你的管理面板上激活 API 功能.
+
+### 不使用 OpenLauncherLib
+
+AzAuth 在设计时将 [Gson](https://github.com/google/gson) 作为唯一的依赖关系, 所以如果你不使用 OpenLauncherLib, 你可以直接用 `AuthClient#authenticate(String username, String password, Supplier<String> codeSupplier)` 这将直接给你一个 `User` 包含 用户名, uuid, 等级, 访问令牌 和其他数据. 当用户启用了 2FA 时 `codeSupplier`
+被调用, 用户的验证码应返回给 Supplier.
+
+### 使用 [OpenLauncherLib](https://github.com/Litarvan/OpenLauncherLib/) _(用于 Minecraft 启动器)_
+
+首先, 将 AzAuth 作为一个依赖项添加到你的项目中.
+另外, 如果你正在使用 [OpenAuth](https://github.com/Litarvan/OpenAuth/), 建议你把它删除,
+然它不会造成任何实际问题, 但如果你使用 AzAuth, 它就没什么用了.
+
+你的启动器代码中应该有一个类似于以下代码的 `auth` 方法:
+```java
+public static void auth(String username, String password) throws AuthenticationException {
+    Authenticator authenticator = new Authenticator(Authenticator.MOJANG_AUTH_URL, AuthPoints.NORMAL_AUTH_POINTS);
+    AuthResponse response = authenticator.authenticate(AuthAgent.MINECRAFT, username, password, "");
+    authInfos = new AuthInfos(response.getSelectedProfile().getName(), response.getAccessToken(), response.getSelectedProfile().getId());
+}
+```
+你只需用下面的代码替换它, 用你的 Azuriom 网站根目录的 URL 替换 `<url>` .
+```java
+public static void auth(String username, String password) throws AuthException {
+    AuthClient authenticator = new AuthClient("<url>");
+
+    authInfos = authenticator.login(username, password, () -> {
+        String code = null;
+
+        while (code == null || code.isEmpty()) {
+            // 对话框的父组件. 你应该用你的
+            // 启动器 框架/面板 等实例来替换下面的代码
+            Container parentComponent = LauncherFrame.getInstance().getLauncherPanel();
+            parentComponent.setVisible(true);
+
+            code = JOptionPane.showInputDialog(parentComponent, "输入你的 2FA 代码", "2FA", JOptionPane.PLAIN_MESSAGE);
+        }
+
+        return code;
+    }, AuthInfos.class);
+}
+```
+
+## 使用 JavaScript 开发
+
+### 安装
+
+源码在 [GitHub](https://github.com/Azuriom/AzAuthJS)
+上可以找到, 并且依赖包可以使用 [npm](https://www.npmjs.com/) 安装:
+```
+npm install azuriom-auth
+```
+
+### 示例
+
+```js
+import { AuthClient } from 'azuriom-auth'
+
+async function login(email, password) {
+    const client = new AuthClient('<你网站的 Url>')
+
+    let result = await client.login(email, password)
+
+    if (result.status === 'pending' && result.requires2fa) {
+        const twoFactorCode = '' // 重要信息: 此处使用用户的 2FA 代码替换
+
+        result = await client.login(email, password, twoFactorCode)
+    }
+
+    if (result.status !== 'success') {
+        throw 'Unexpected result: ' + JSON.stringify(result)
+    }
+
+    return result
+}
+```
+
+
+### 接口说明
+
+#### 认证
+
+**POST** `/authenticate`
+
+使用 用户的网站凭证 来认证用户
+
+##### 请求参数
+| 字段      | 描述                                                            |
+|----------|-----------------------------------------------------------------|
+| email    | 用户名或邮箱地址                                                  |
+| password | 密码                                                             |
+| code     | 2FA 代码, 只有在 `status` 为 `pending` 且 `reason` 为 `2fa` 时可用|
+
+##### 返回参数
+
+返回用户和他的各种信息，以及可用于验证连接或断开连接的唯一 token.
+
+```json
+{
+    "id": 1,
+    "username": "Username",
+    "uuid": "00000000-0000-0000-0000-000000000000",
+    "email_verified": true,
+    "money": 100.0,
+    "role": {
+        "name": "Member",
+        "color": "#e10d11"
+    },
+    "banned": false,
+    "created_at": "2020-06-29T17:39:12+00:00",
+    "access_token": "xxxxxxxx"
+}
+```
+
+#### 验证
+
+**POST** `/verify`
+
+##### 请求参数
+| 字段          | 描述          |
+|--------------|---------------|
+| access_token | 唯一的访问令牌 |
+
+##### 请求参数
+
+返回用户和他的各种信息，以及可用于验证连接或断开连接的唯一 token.
+
+正常返回的示例 (HTTP `2xx`):
+```json
+{
+    "id": 1,
+    "username": "Username",
+    "uuid": "00000000-0000-0000-0000-000000000000",
+    "email_verified": true,
+    "money": 100.0,
+    "role": {
+        "name": "Member",
+        "color": "#e10d11"
+    },
+    "banned": false,
+    "created_at": "2020-06-29T17:39:12+00:00",
+    "access_token": "xxxxxxxx"
+}
+```
+
+异常返回的示例 (HTTP `4xx`):
+```json
+{
+    "status": "error",
+    "reason": "invalid_credentials",
+    "message": "Invalid credentials"
+}
+```
+
+#### 登出
+
+**POST** `/logout`
+
+登出用户并使访问令牌失效.
+
+##### 请求示例
+| 字段         | 描述           |
+|--------------|---------------|
+| access_token | 唯一的访问令牌 |
+
+##### 返回示例
+
+返回为空, HTTP 状态码 `2xx` .