From 925cd0e57224ec9eafa311c335533ee148c0601b Mon Sep 17 00:00:00 2001 From: Maiko Sinkyaet Tan Date: Sun, 25 Aug 2024 15:44:06 +0800 Subject: [PATCH] Migrate markdown link to english name, fix typo (#186) --- zh-CN/about/upgrade.md | 10 +++++----- zh-CN/api/core/session.md | 2 +- zh-CN/guide/develop/script.md | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/zh-CN/about/upgrade.md b/zh-CN/about/upgrade.md index 8c0af3752959..6f3c38c5b192 100644 --- a/zh-CN/about/upgrade.md +++ b/zh-CN/about/upgrade.md @@ -34,15 +34,15 @@ 在 4.11.0 版本中我们移除了 @koishijs/cli 包，将其合并到了 koishi 中。这意味着你每次升级时不再需要同时升级两边了。但对于已经安装了 @koishijs/cli 的用户，你需要执行下列操作完成升级： 1. 先完成 4.10.4 版本的更新，确保自己的版本号不小于 4.10.4 -2. 在依赖管理中，修改 koishi 的版本号到 4.11.0，同时移除 @koishijs/cli 的版本号 +2. 在依赖管理中，修改 koishi 的版本号到 4.11.0，并移除 @koishijs/cli 3. 点击「应用更改」按钮 ## HMR 更新 v4.12.0 -在 4.12.0 版本中，我们将模块热替换相关功能移至专门的插件 @koishijs/plugin-hmr 中。对于生产模式下的用户无影响，但开发者则需要在升级 Koishi 后手动安装新插件。你需要执行下列操作完成升级： +在 4.12.0 版本中，我们将模块热替换相关功能移至专门的插件 @koishijs/plugin-hmr 中。如果你使用了 hmr 插件，你需要执行下列操作完成升级： 1. 安装最新版本的 @koishijs/plugin-hmr -2. 修改你的配置文件，加上 [模块热替换](../guide/develop/script.md#模块热替换) 中提到的部分 +2. 修改你的配置文件，加上 [模块热替换](../guide/develop/script.md#hmr) 中提到的部分 3. 移除 `package.json` 文件中 `scripts.dev` 的 `--watch` 参数 ## 插件市场更新 v4.13.0 @@ -51,7 +51,7 @@ 1. 首先确保你的 market 插件是最新版 (应该是 2.0.0 以上版本) 2. 打开「插件市场」页面，安装最新版的 config 插件 -3. 打开「资源管理器」页面，找到 `koishi.yml` 页面，打开并编辑： +3. 打开「资源管理器」页面，找到 `koishi.yml` 文件，打开并编辑： ```yaml host: 127.0.0.1 @@ -104,7 +104,7 @@ for await (const item of bot.getChannelIter()) // new [`User`](../api/resources/user.md) 类型的 `userId` 属性改为 `id`，同理对于 [`Channel`](../api/resources/channel.md), [`Guild`](../api/resources/guild.md), [`Message`](../api/resources/message.md) 也是如此。此外，`Author` 被重构为了 `User` 和 `Member` 两个部分。 -[`Session`](../api/core/session.md) 引入了 `event` 属性用于存放所有事件相关的资源。尽管我们在会话中提供了 [访问器属性](../api/core/session.md#访问器属性) 以保证了大部分 API 的向下兼容，但对于没有提供访问器的事件属性，或是在使用 Bot API 的返回值时，你都需要手动修改代码。 +[`Session`](../api/core/session.md) 引入了 `event` 属性用于存放所有事件相关的资源。尽管我们在会话中提供了 [访问器属性](../api/core/session.md#accessor-property) 以保证了大部分 API 的向下兼容，但对于没有提供访问器的事件属性，或是在使用 Bot API 的返回值时，你都需要手动修改代码。 `Adapter.Server` 和 `Adapter.Client` 两个基类被移除。现在可以直接使用 [`Adapter`](../api/core/adapter.md) 基类，并通过 `reusable` 属性决定其是否可重用。 diff --git a/zh-CN/api/core/session.md b/zh-CN/api/core/session.md index 92e1054d19eb..bdbb2615b576 100644 --- a/zh-CN/api/core/session.md +++ b/zh-CN/api/core/session.md @@ -62,7 +62,7 @@ 这个属性对应的是 Koishi 内置数据结构中的用户数据，而不是平台的用户数据。如果你需要访问平台用户数据，请使用 `session.event.user`。 ::: -## 访问器属性 +## 访问器属性 {#accessor-property} 对于部分常用的事件体属性，我们提供了访问器属性。 diff --git a/zh-CN/guide/develop/script.md b/zh-CN/guide/develop/script.md index f50cdf9faf74..4bfe274cb0dd 100644 --- a/zh-CN/guide/develop/script.md +++ b/zh-CN/guide/develop/script.md @@ -80,7 +80,7 @@ Koishi 模板项目原生地支持 TypeScript 开发。上述 `-r esbuild-regist 我们并不推荐使用高级语言来编写配置文件，因为动态的配置无法支持环境变量、配置热重载和插件市场等特性。大部分情况下我们建议仅将 `-r` 用于开发目的。 ::: -### 模块热替换 +### 模块热替换 {#hmr} 如果你开发着一个巨大的 Koishi 项目，可能光是加载一遍全部插件就需要好几秒了。在这种时候，像前端框架一样支持模块热替换就成了一个很棒的主意。幸运的是，Koishi 也做到了这一点！内置插件 @koishijs/plugin-hmr 实现了插件级别的热替换。每当你修改你的本地文件时，Koishi 就会尝试重载你的插件，并在命令行中提醒你。