Migrate references in docs

starShinning · Dec 6, 2021 · aa98a10 · aa98a10
1 parent 14bb375
commit aa98a10
Show file tree

Hide file tree

Showing 12 changed files with 156 additions and 88 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -31,7 +31,7 @@ git submodule update
 
 ### 能做什么?
 
-- 维护社区: 可以为 [mirai-console](https://github.com/mamoe/mirai-console) 编写插件, 并发布到论坛
+- 维护社区: 可以为 [mirai-console](/mirai-console) 编写插件, 并发布到论坛
 
 - 代码优化: 优化任何功能设计或实现, 或是引入一个新的设计
 - 解决问题: 在 [issues](https://github.com/mamoe/mirai/issues) 查看 mirai 正遇到的所有问题, 或在 [里程碑](https://github.com/mamoe/mirai/milestones) 查看版本计划. 所有没有 assignee 的 issue 都处于

diff --git a/README-eng.md b/README-eng.md
@@ -14,8 +14,12 @@ Mirai is designed to handle all sorts of messaging works that can be automatical
 Mirai is able to run as a plugin-supported framework.  
 The community, (with `mirai-console`) that allows developers to share their plugins, and for users to install plugins quickly, is building in progress.
 
-- JVM languages like `Java` or `Kotlin`： Make Jar plugin for [mirai-console](https://github.com/mamoe/mirai-console) directly and share with other developers through the plugin center.
-- `Kotlin Script`： [mirai-kts](https://github.com/iTXTech/mirai-kts) supports plugins using Kotlin Scripts (`kts`)（**OpenJDK 8+ only，except Android**）
+- JVM languages like `Java` or `Kotlin`： Make Jar plugin
+  for [mirai-console](/mirai-console) directly and share with other
+  developers through the plugin center.
+- `Kotlin Script`： [mirai-kts](https://github.com/iTXTech/mirai-kts)
+  supports plugins using Kotlin Scripts (`kts`)（**OpenJDK 8+ only，except
+  Android**）
 - Native languages like `C`, `C++`： [mirai-native](https://github.com/iTXTech/mirai-native) supports plugins from CoolQ **(`Windows JREx86` only / with `Wine`)**
 - `JavaScript`： [mirai-js](https://github.com/iTXTech/mirai-js) supports plugins using `JavaScript` and inter-operate with **mirai** on JVM directly.
 - Any language：Use HTTP API from [mirai-api-http](https://github.com/mamoe/mirai-api-http)

diff --git a/docs/Preparations.md b/docs/Preparations.md
@@ -8,7 +8,8 @@
 - Android：Android SDK 26+ （Android 8.0，Oreo)
 
 
-**但注意不要使用 Oracle JDK**（[原因](https://github.com/mamoe/mirai/discussions/779)），可以使用其他任何 JDK。
+**但注意不要使用 Oracle JDK**
+（[原因](https://github.com/mamoe/mirai/discussions/779)），可以使用其他任何 JDK。
 
 > 要下载 JDK：
 > - 手动下载安装如 [AdoptOpenJDK](https://adoptopenjdk.net/)
@@ -18,15 +19,19 @@
 
 ### 安装 IDE 插件
 
-[Mirai Console IntelliJ]: https://github.com/mamoe/mirai-console/tree/master/tools/intellij-plugin
-[Mirai Console IntelliJ-JB]: https://github.com/mamoe/mirai-console/tree/master/tools/intellij-plugin
+[Mirai Console IntelliJ]: /mirai-console/tools/intellij-plugin
+
+[Mirai Console IntelliJ-JB]: /mirai-console/tools/intellij-plugin
+
 [Mirai Console IntelliJ-OK]: https://plugins.jetbrains.com/embeddable/install/15094
 
 <!--[Kotlin Jvm Blocking Bridge]: https://github.com/mamoe/kotlin-jvm-blocking-bridge-->
 <!--[Kotlin Jvm Blocking Bridge-JB]: https://plugins.jetbrains.com/plugin/14816-kotlin-jvm-blocking-bridge-->
 <!--[Kotlin Jvm Blocking Bridge-OK]: https://plugins.jetbrains.com/embeddable/install/14816-->
 
-推荐使用 [IntelliJ IDEA](https://www.jetbrains.com/idea/) 或 [Android Studio](https://developer.android.com/studio)。Mirai 提供 IDE 插件来提升开发体验。
+推荐使用 [IntelliJ IDEA](https://www.jetbrains.com/idea/)
+或 [Android Studio](https://developer.android.com/studio)。Mirai 提供 IDE
+插件来提升开发体验。
 
 |          插件名           |                         描述                         |               一键安装                |         JetBrains 插件仓库          |
 |:------------------------:|:---------------------------------------------------:|:-----------------------------------:|:----------------------------------:|

diff --git a/docs/README.md b/docs/README.md
@@ -10,59 +10,93 @@
 
 ## 社区 SDK
 
-**mirai 官方提供 [Kotlin/Java 等 JVM 平台语言开发支持](#jvm-平台-mirai-开发)。如果不熟悉这些语言，请使用以下社区 SDK：**
+**mirai 官方提供 [Kotlin/Java 等 JVM 平台语言开发支持](#jvm-平台-mirai-开发)
+。如果不熟悉这些语言，请使用以下社区 SDK：**
 
-要使用这些社区 SDK 需要先配置 Mirai Console，可以使用 [一键安装](https://mirai.mamoe.net/assets/uploads/files/1618372079496-install-20210412.cmd)（32位，带 HTTP 插件），也可以阅读 [用户手册](UserManual.md) 进行个性化安装。
+要使用这些社区 SDK 需要先配置 Mirai
+Console，可以使用 [一键安装](https://mirai.mamoe.net/assets/uploads/files/1618372079496-install-20210412.cmd)（32位，带
+HTTP 插件），也可以阅读 [用户手册](UserManual.md) 进行个性化安装。
 
 你可以使用一个或多个语言来开发插件，而且在自己开发的同时也可以[使用下载的插件](UserManual.md#下载和安装插件)。
 
-[`mirai-console`]: https://github.com/mamoe/mirai-console
+[`mirai-console`]: ../mirai-console
 
 [mamoe/mirai-api-http]: https://github.com/mamoe/mirai-api-http
+
 [iTXTech/mirai-native]: https://github.com/iTXTech/mirai-native
+
 [iTXTech/mirai-js]: https://github.com/iTXTech/mirai-js
+
 [iTXTech/mirai-kts]: https://github.com/iTXTech/mirai-kts
+
 [GraiaProject/Ariadne]: https://github.com/GraiaProject/Ariadne
+
 [GraiaProject/Avilla]: https://github.com/GraiaProject/Avilla
+
 [Elaina]: https://github.com/wyapx/Elaina
+
 [Cesloi]: https://github.com/RF-Tar-Railt/Cesloi
+
 [NoneBot]: https://github.com/nonebot/nonebot2
+
 [RedBeanN/node-mirai]: https://github.com/RedBeanN/node-mirai
+
 [Logiase/gomirai]: https://github.com/Logiase/gomirai
+
 [cyanray/mirai-cpp]: https://github.com/cyanray/mirai-cpp
+
 [Chlorie/miraipp]: https://github.com/Chlorie/miraipp-template
+
 [Executor-Cheng/mirai-CSharp]: https://github.com/Executor-Cheng/mirai-CSharp
+
 [HoshinoTented/mirai-rs]: https://github.com/HoshinoTented/mirai-rs
+
 [YunYouJun/mirai-ts]: https://github.com/YunYouJun/mirai-ts
+
 [nepsyn/miraipie]: https://github.com/nepsyn/miraipie
+
 [only52607/e-mirai]: https://github.com/only52607/e-mirai
+
 [theGravityLab/ProjHyperai]: https://github.com/theGravityLab/ProjHyperai
+
 [yyuueexxiinngg/onebot-kotlin]: https://github.com/yyuueexxiinngg/onebot-kotlin
+
 [Nambers/MiraiCP]:https://github.com/Nambers/MiraiCP
+
 [drinkal/Mirai-js]:https://github.com/drinkal/Mirai-js
+
 [Coloryr/ColorMirai]: https://github.com/Coloryr/ColorMirai
+
 [AHpxChina/Mirai.Net]: https://github.com/AHpxChina/Mirai.Net
+
 [Miyakowww/CocoaFramework2]: https://github.com/Miyakowww/CocoaFramework2
+
 [Shimogawa/rubirai]: https://github.com/Shimogawa/rubirai
+
 [Excaive/miraicle]: https://github.com/Excaive/miraicle
+
 [nkxingxh/miraiez]: https://github.com/nkxingxh/miraiez
+
 [Xwdit/RainyBot-Core]: https://github.com/Xwdit/RainyBot-Core
 
 [OneBot]: https://github.com/howmanybots/onebot
+
 [Mirai HTTP]: https://github.com/project-mirai/mirai-api-http
+
 [jerrita/saaya]: https://github.com/jerrita/saaya
+
 [YiriMirai]: https://github.com/YiriMiraiProject/YiriMirai
 
 ### 原生接口
 
 这些接口直接在 JVM 上实现，不需要中间件，拥有更佳的性能。
 
-| 技术                | 维护者及项目地址          |
+| 技术                 | 维护者及项目地址               |
 |:-------------------|:-----------------------|
 | `Kotlin Scripting` | [iTXTech/mirai-kts]    |
 | `C++`              | [Nambers/MiraiCP]      |
 | `JavaScript`       | [iTXTech/mirai-js]     |
-| *酷 Q DLL 插件*     | [iTXTech/mirai-native] |
+| *酷 Q DLL 插件*       | [iTXTech/mirai-native] |
 
 ### HTTP 接口
 
@@ -71,42 +105,41 @@
 - [***Mirai HTTP***][Mirai HTTP] 由 Mirai 开发团队提供第一级支持，目前多数 SDK 都基于它；
 - [OneBot] 标准则兼容酷Q协议，可以让基于酷Q HTTP 插件的项目在 Mirai 平台运行。
 
-| 名称              | 实现          | 维护者及项目地址                  |
-|:-----------------|:-------------|:-------------------------------|
+| 名称               | 实现          | 维护者及项目地址                       |
+|:-----------------|:------------|:-------------------------------|
 | ***Mirai Http*** | Mirai 标准    | [mamoe/mirai-api-http]         |
 | *OneBot Http*    | [OneBot] 标准 | [yyuueexxiinngg/onebot-kotlin] |
 
-下表列举基于 Mirai HTTP 插件实现对一些编程语言支持的项目列表。要使用它们，你需要[在 Mirai Console 安装 `mirai-api-http`](https://github.com/project-mirai/mirai-api-http#%E5%AE%89%E8%A3%85mirai-api-http)（如果使用上面的一键安装则不需要额外操作）。
-
-
-| 语言和技术                  | 维护者及项目地址                               |
-|:--------------------------|:--------------------------------------------|
-| `C#`                      | [Executor-Cheng/mirai-CSharp]               |
-| `C#`                      | [Hyperai][theGravityLab/ProjHyperai]        |
-| `C#`                      | [Coloryr/ColorMirai]                        |
-| `C#`                      | [AhpxChina/Mirai.Net]                       |
-| `C#`                      | [Miyakowww/CocoaFramework2]                 |
-| `C++`                     | [cyanray/mirai-cpp]                         |
-| `C++`                     | [Chlorie/miraipp]                           |
-| `GDScript`                | [Xwdit/RainyBot-Core]                       |
-| `Go`                      | [Logiase/gomirai]                           |
-| `JavaScript` / Node.js    | [RedBeanN/node-mirai]                       |
-| `JavaScript` / Node.js    | [drinkal/Mirai-js]                          |
-| `JavaScript` / TypeScript | [YunYouJun/mirai-ts]                        |
-| `JavaScript` / TypeScript | [nepsyn/miraipie]
-| `PHP`                     | [nkxingxh/miraiez]                          |
-| `Python`                  | [Ariadne][GraiaProject/Ariadne]             |
-| `Python`                  | [Avilla][GraiaProject/Avilla]               |
-| `Python`                  | [Elaina]                                    |
-| `Python`                  | [Cesloi]                                    |
-| `Python`                  | [NoneBot]                                   |
-| `Python`                  | [jerrita/saaya]                             |
-| `Python`                  | [YiriMirai]                                 |
-| `Python`                  | [Excaive/miraicle]                          |
-| `Ruby`                    | [Shimogawa/rubirai]                         |
-| `Rust`                    | [HoshinoTented/mirai-rs]                    |
-| `易语言`                   | [only52607/e-mirai]                         |
-
+下表列举基于 Mirai HTTP
+插件实现对一些编程语言支持的项目列表。要使用它们，你需要[在 Mirai Console 安装 `mirai-api-http`](https://github.com/project-mirai/mirai-api-http#%E5%AE%89%E8%A3%85mirai-api-http)（如果使用上面的一键安装则不需要额外操作）。
+
+| 语言和技术                     | 维护者及项目地址                             |
+|:--------------------------|:-------------------------------------|
+| `C#`                      | [Executor-Cheng/mirai-CSharp]        |
+| `C#`                      | [Hyperai][theGravityLab/ProjHyperai] |
+| `C#`                      | [Coloryr/ColorMirai]                 |
+| `C#`                      | [AhpxChina/Mirai.Net]                |
+| `C#`                      | [Miyakowww/CocoaFramework2]          |
+| `C++`                     | [cyanray/mirai-cpp]                  |
+| `C++`                     | [Chlorie/miraipp]                    |
+| `GDScript`                | [Xwdit/RainyBot-Core]                |
+| `Go`                      | [Logiase/gomirai]                    |
+| `JavaScript` / Node.js    | [RedBeanN/node-mirai]                |
+| `JavaScript` / Node.js    | [drinkal/Mirai-js]                   |
+| `JavaScript` / TypeScript | [YunYouJun/mirai-ts]                 |
+| `JavaScript` / TypeScript | [nepsyn/miraipie]                    |
+| `PHP`                     | [nkxingxh/miraiez]                   |
+| `Python`                  | [Ariadne][GraiaProject/Ariadne]      |
+| `Python`                  | [Avilla][GraiaProject/Avilla]        |
+| `Python`                  | [Elaina]                             |
+| `Python`                  | [Cesloi]                             |
+| `Python`                  | [NoneBot]                            |
+| `Python`                  | [jerrita/saaya]                      |
+| `Python`                  | [YiriMirai]                          |
+| `Python`                  | [Excaive/miraicle]                   |
+| `Ruby`                    | [Shimogawa/rubirai]                  |
+| `Rust`                    | [HoshinoTented/mirai-rs]             |
+| `易语言`                     | [only52607/e-mirai]                  |
 
 > 按字母顺序排序，排序不代表排名  
 > *想在这里添加你的项目？欢迎[提交 PR](https://github.com/mamoe/mirai/edit/dev/docs/README.md)。*
@@ -123,16 +156,17 @@
 
 1. [JVM 环境和开发准备工作](Preparations.md#mirai---preparations)
 
-2. 选择框架
-   建议先阅读 [Mirai 生态概览](mirai-ecology.md)。
+2. 选择框架 建议先阅读 [Mirai 生态概览](mirai-ecology.md)。
 
-   - 若要将 mirai 当做依赖库嵌入你的应用使用（你调用 mirai），则需要使用 mirai-core，请阅读 [配置项目依赖](ConfiguringProjects.md)。
+    - 若要将 mirai 当做依赖库嵌入你的应用使用（你调用 mirai），则需要使用
+      mirai-core，请阅读 [配置项目依赖](ConfiguringProjects.md)。
 
-   - 若要以插件模式开发（mirai 调用你），可以使用 mirai-console，请阅读 [mirai-console 的配置插件项目](https://github.com/mamoe/mirai-console/blob/master/docs/ConfiguringProjects.md)。
+    - 若要以插件模式开发（mirai 调用你），可以使用
+      mirai-console，请阅读 [mirai-console 的配置插件项目](../mirai-console/docs/ConfiguringProjects.md)
+      。
 
 4. 阅读 API 文档（见下文）
 
-
 > 如果你希望先确认 mirai 能够正常运行才能安心阅读文档，可克隆 [mirai-hello-world](https://github.com/project-mirai/mirai-hello-world) 并运行其中 Kotlin 或 Java 入口点 `main`。