Skip to content

Commit

Permalink
📝 fix mdx v3 warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
StarHeartHunt committed Sep 18, 2024
1 parent 6f3880c commit 96ca8d9
Show file tree
Hide file tree
Showing 24 changed files with 100 additions and 100 deletions.
14 changes: 7 additions & 7 deletions website/docs/best-practice/alconna/command.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,14 @@ alc = Alconna(".rd{roll:int}")
assert alc.parse(".rd123").header["roll"] == 123
```

Bracket Header 类似 python 里的 f-string 写法,通过 "{}" 声明匹配类型
Bracket Header 类似 python 里的 f-string 写法,通过 `"{}"` 声明匹配类型

"{}" 中的内容为 "name:type or pat":
`"{}"` 中的内容为 "name:type or pat":

- "{}", "{:}" ⇔ "(.+)", 占位符
- "{foo}" ⇔ "(?P<foo>.+)"
- "{:\d+}" ⇔ "(\d+)"
- "{foo:int}" ⇔ "(?P<foo>\d+)",其中 "int" 部分若能转为 `BasePattern` 则读取里面的表达式
- `"{}"`, `"{:}"``"(.+)"`, 占位符
- `"{foo}"``"(?P<foo>.+)"`
- `"{:\d+}"``"(\d+)"`
- `"{foo:int}"``"(?P<foo>\d+)"`,其中 `"int"` 部分若能转为 `BasePattern` 则读取里面的表达式

## 参数声明(Args)

Expand Down Expand Up @@ -321,7 +321,7 @@ opt2 = Option("--foo", default=OptionResult(value=False, args={"bar": 1}))
- `keep_crlf`: 命令解析时是否保留换行字符
- `compact`: 命令是否允许第一个参数紧随头部
- `strict`: 命令是否严格匹配,若为 False 则未知参数将作为名为 $extra 的参数
- `context_style`: 命令上下文插值的风格,None 为关闭,bracket 为 {...},parentheses 为 $(...)
- `context_style`: 命令上下文插值的风格,None 为关闭,bracket 为 `{...}`,parentheses 为 `$(...)`
- `extra`: 命令的自定义额外信息

元数据一定使用 `meta=...` 形式传入:
Expand Down
4 changes: 2 additions & 2 deletions website/docs/best-practice/alconna/uniseg.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ msg.extend([Text("text")])

这里额外说明 `UniMessage.template` 的拓展控制符

相比 `Message`,UniMessage 对于 {:XXX} 做了另一类拓展。其能够识别例如 At(xxx, yyy) 或 Emoji(aaa, bbb)的字符串并执行
相比 `Message`,UniMessage 对于 `{:XXX}` 做了另一类拓展。其能够识别例如 At(xxx, yyy) 或 Emoji(aaa, bbb)的字符串并执行

以 At(...) 为例:

Expand All @@ -305,7 +305,7 @@ UniMessage(At("user", "123"))
UniMessage(At("user", "123"))
```

而在 `AlconnaMatcher` 中,{:XXX} 更进一步地提供了获取 `event``bot` 中的属性的功能:
而在 `AlconnaMatcher` 中,`{:XXX}` 更进一步地提供了获取 `event``bot` 中的属性的功能:

```python title=在AlconnaMatcher中使用通用消息段的拓展控制符
from arclet.alconna import Alconna, Args
Expand Down
2 changes: 1 addition & 1 deletion website/docs/ospp/2021.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: 开源软件供应链点亮计划 - 暑期 2021

**开源软件供应链点亮计划 - 暑期 2021****中国科学院软件研究所****openEuler 社区**共同举办的一项面向高校学生的暑期活动,旨在鼓励在校学生积极参与开源软件的开发维护,促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式,请查看该活动的 [官网](https://summer.iscas.ac.cn/)[帮助文档](https://summer.iscas.ac.cn/help/)

NoneBot 社区有幸作为开源社区参与了本次活动,下面列出了目前我们已经发布的项目,欢迎感兴趣的同学在上面给出的活动官网报名,或通过 <contact@nonebot.dev> 联系我们。
NoneBot 社区有幸作为开源社区参与了本次活动,下面列出了目前我们已经发布的项目,欢迎感兴趣的同学在上面给出的活动官网报名,或通过 [contact@nonebot.dev](mailto:contact@nonebot.dev) 联系我们。

## NoneBot v1

Expand Down
14 changes: 7 additions & 7 deletions website/docs/ospp/2022.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: 开源之夏 - 暑期 2022

**开源之夏 - 暑期 2022** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所****openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of Code(GSoC),旨在鼓励在校学生积极参与开源软件的开发维护,促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式,请查看该活动的 [官网](https://summer-ospp.ac.cn/)[帮助文档](https://summer-ospp.ac.cn/help/)

NoneBot 社区有幸作为开源社区 [参与](https://summer-ospp.ac.cn/#/org/orgdetail/e1fb5b8d-125a-4138-b756-25bd32c0a31a/) 了本次活动,下面列出了目前我们已经发布的项目,欢迎感兴趣的同学加入 QQ 群 [737131827](https://jq.qq.com/?_wv=1027&k=PEgyGeEu) 或通过 <contact@nonebot.dev> 联系我们。
NoneBot 社区有幸作为开源社区 [参与](https://summer-ospp.ac.cn/#/org/orgdetail/e1fb5b8d-125a-4138-b756-25bd32c0a31a/) 了本次活动,下面列出了目前我们已经发布的项目,欢迎感兴趣的同学加入 QQ 群 [737131827](https://jq.qq.com/?_wv=1027&k=PEgyGeEu) 或通过 [contact@nonebot.dev](mailto:contact@nonebot.dev) 联系我们。

## NoneBot2 命令行 CLI 交互体验升级

Expand Down Expand Up @@ -36,8 +36,8 @@ NoneBot2 为用户提供了命令行脚手架 ──`nb-cli`,辅助用户更

**成果仓库**

- <https://github.com/nonebot/nb-cli>
- <https://github.com/nonebot/nonebot2>
- [https://github.com/nonebot/nb-cli]
- [https://github.com/nonebot/nonebot2]

## NoneBot2 命令行即时交互通信设计与实现

Expand All @@ -63,16 +63,16 @@ NoneBot2 在早期提供了基于网页的 nonebot-plugin-test 插件,无需

**成果仓库**

- <https://github.com/nonebot/adapter-console>
- [https://github.com/nonebot/adapter-console]

## NoneBot2 用户上手与深入教程设计

NoneBot2 为用户提供了详细的文档介绍,辅助用户更好的上手项目以及进行开发。文档分为基础与进阶两个部分。基础部分帮助新用户快速上手开发,主要包括:安装 NoneBot2、使用脚手架、创建配置项目、使用适配器、加载插件、定义消息事件、处理消息事件、调用平台 API 等。进阶部分向已经熟悉开发流程的用户介绍更多高级技巧,主要包括:NoneBot2 工作原理、定时任务、权限控制、钩子函数、跨插件访问、单元测试、发布插件等。目前文档对于用户而言过于费解,导致用户难以理解 NoneBot2 开发。本项目旨在优化文档内容,使其更加通俗易懂,不让文档成为用户上手的阻碍,同时完善进阶内容,让有更复杂需求的用户,同样能从文档中受益。

相关 issue:

- <https://github.com/nonebot/nonebot2/issues/793>
- <https://github.com/nonebot/nonebot2/issues/295>
- [https://github.com/nonebot/nonebot2/issues/793]
- [https://github.com/nonebot/nonebot2/issues/295]

**难度**:进阶

Expand All @@ -93,4 +93,4 @@ NoneBot2 为用户提供了详细的文档介绍,辅助用户更好的上手

**成果仓库**

- <https://github.com/nonebot/nonebot2>
- [https://github.com/nonebot/nonebot2]
8 changes: 4 additions & 4 deletions website/docs/ospp/2023.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: 开源之夏 - 暑期 2023

**开源之夏 - 暑期 2023** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所****openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of Code(GSoC),旨在鼓励在校学生积极参与开源软件的开发维护,促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式,请查看该活动的 [官网](https://summer-ospp.ac.cn/)[帮助文档](https://summer-ospp.ac.cn/help/)

NoneBot 社区有幸作为开源社区 [参与](https://summer-ospp.ac.cn/org/orgdetail/e1fb5b8d-125a-4138-b756-25bd32c0a31a?lang=zh) 了本次活动,下面列出了目前我们已经发布的项目,欢迎感兴趣的同学通过 <contact@nonebot.dev> 联系我们。
NoneBot 社区有幸作为开源社区 [参与](https://summer-ospp.ac.cn/org/orgdetail/e1fb5b8d-125a-4138-b756-25bd32c0a31a?lang=zh) 了本次活动,下面列出了目前我们已经发布的项目,欢迎感兴趣的同学通过 [contact@nonebot.dev](mailto:contact@nonebot.dev) 联系我们。

## NoneBot 项目管理图形化面板

Expand All @@ -34,7 +34,7 @@ NoneBot 目前提供了开箱即用的命令行脚手架来帮助初次使用的

**成果仓库**

- <https://github.com/nonebot/cli-plugin-webui>
- [https://github.com/nonebot/cli-plugin-webui]

## NoneBot Discord 适配器

Expand All @@ -57,7 +57,7 @@ NoneBot 作为一个跨平台聊天机器人框架,目前已有 OneBot、飞

**成果仓库**

- <https://github.com/nonebot/adapter-discord>
- [https://github.com/nonebot/adapter-discord]

## NoneBot 数据库支持插件

Expand Down Expand Up @@ -86,4 +86,4 @@ NoneBot 的插件系统为用户实现应用提供了极高的便捷性,但因

**成果仓库**

- <https://github.com/nonebot/plugin-orm>
- [https://github.com/nonebot/plugin-orm]
8 changes: 4 additions & 4 deletions website/docs/ospp/2024.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: 开源之夏 - 暑期 2024

**开源之夏 - 暑期 2024****中国科学院软件研究所**发起的**开源软件供应链点亮计划**系列暑期活动,旨在鼓励高校学生积极参与开源软件的开发维护,促进优秀开源软件社区的蓬勃发展。活动联合各大开源社区,针对重要开源软件的开发与维护提供项目开发任务,并向全球高校学生开放报名。关于具体的活动规划、报名方式,请查看该活动的 [官网](https://summer-ospp.ac.cn/)[帮助文档](https://summer-ospp.ac.cn/help/)

NoneBot 社区有幸作为开源社区 [参与](https://summer-ospp.ac.cn/org/orgdetail/e1fb5b8d-125a-4138-b756-25bd32c0a31a?lang=zh) 了本次活动,下面列出了目前我们已经发布的项目,欢迎感兴趣的同学通过 <contact@nonebot.dev> 联系我们。
NoneBot 社区有幸作为开源社区 [参与](https://summer-ospp.ac.cn/org/orgdetail/e1fb5b8d-125a-4138-b756-25bd32c0a31a?lang=zh) 了本次活动,下面列出了目前我们已经发布的项目,欢迎感兴趣的同学通过 [contact@nonebot.dev](mailto:contact@nonebot.dev) 联系我们。

## NonePress 官网组件库更新与优化

Expand Down Expand Up @@ -39,7 +39,7 @@ NoneBot 官网目前采用基于 TailwindCSS 自研的 NonePress 组件库及 Do

**成果仓库**

- <https://github.com/nonebot/docusaurus-theme-nonepress>
- [https://github.com/nonebot/docusaurus-theme-nonepress]

## NoneFlow 社区自动化工作流管理优化

Expand Down Expand Up @@ -70,7 +70,7 @@ NoneFlow 在 NoneBot 社区中承担着重要的角色,它由 NoneBot 框架

**成果仓库**

- <https://github.com/nonebot/noneflow>
- [https://github.com/nonebot/noneflow]

## NoneBlockly 低代码框架开发

Expand Down Expand Up @@ -100,4 +100,4 @@ NoneFlow 在 NoneBot 社区中承担着重要的角色,它由 NoneBot 框架

**成果仓库**

- <https://github.com/nonebot/noneblockly>
- [https://github.com/nonebot/noneblockly]
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,14 @@ alc = Alconna(".rd{roll:int}")
assert alc.parse(".rd123").header["roll"] == 123
```

Bracket Header 类似 python 里的 f-string 写法,通过 "{}" 声明匹配类型
Bracket Header 类似 python 里的 f-string 写法,通过 `"{}"` 声明匹配类型

"{}" 中的内容为 "name:type or pat":
`"{}"` 中的内容为 "name:type or pat":

- "{}", "{:}" ⇔ "(.+)", 占位符
- "{foo}" ⇔ "(?P&lt;foo&gt;.+)"
- "{:\d+}" ⇔ "(\d+)"
- "{foo:int}" ⇔ "(?P&lt;foo&gt;\d+)",其中 "int" 部分若能转为 `BasePattern` 则读取里面的表达式
- `"{}"`, `"{:}"``"(.+)"`, 占位符
- `"{foo}"``"(?P&lt;foo&gt;.+)"`
- `"{:\d+}"``"(\d+)"`
- `"{foo:int}"``"(?P&lt;foo&gt;\d+)"`,其中 `"int"` 部分若能转为 `BasePattern` 则读取里面的表达式

## 参数声明(Args)

Expand Down Expand Up @@ -321,7 +321,7 @@ opt2 = Option("--foo", default=OptionResult(value=False, args={"bar": 1}))
- `keep_crlf`: 命令解析时是否保留换行字符
- `compact`: 命令是否允许第一个参数紧随头部
- `strict`: 命令是否严格匹配,若为 False 则未知参数将作为名为 $extra 的参数
- `context_style`: 命令上下文插值的风格,None 为关闭,bracket 为 {...},parentheses 为 $(...)
- `context_style`: 命令上下文插值的风格,None 为关闭,bracket 为 `{...}`,parentheses 为 `$(...)`
- `extra`: 命令的自定义额外信息

元数据一定使用 `meta=...` 形式传入:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ msg.extend([Text("text")])

这里额外说明 `UniMessage.template` 的拓展控制符

相比 `Message`,UniMessage 对于 {:XXX} 做了另一类拓展。其能够识别例如 At(xxx, yyy) 或 Emoji(aaa, bbb)的字符串并执行
相比 `Message`,UniMessage 对于 `{:XXX}` 做了另一类拓展。其能够识别例如 At(xxx, yyy) 或 Emoji(aaa, bbb)的字符串并执行

以 At(...) 为例:

Expand All @@ -305,7 +305,7 @@ UniMessage(At("user", "123"))
UniMessage(At("user", "123"))
```

而在 `AlconnaMatcher` 中,{:XXX} 更进一步地提供了获取 `event``bot` 中的属性的功能:
而在 `AlconnaMatcher` 中,`{:XXX}` 更进一步地提供了获取 `event``bot` 中的属性的功能:

```python title=在AlconnaMatcher中使用通用消息段的拓展控制符
from arclet.alconna import Alconna, Args
Expand Down
2 changes: 1 addition & 1 deletion website/versioned_docs/version-2.3.1/ospp/2021.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: 开源软件供应链点亮计划 - 暑期 2021

**开源软件供应链点亮计划 - 暑期 2021****中国科学院软件研究所****openEuler 社区**共同举办的一项面向高校学生的暑期活动,旨在鼓励在校学生积极参与开源软件的开发维护,促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式,请查看该活动的 [官网](https://summer.iscas.ac.cn/)[帮助文档](https://summer.iscas.ac.cn/help/)

NoneBot 社区有幸作为开源社区参与了本次活动,下面列出了目前我们已经发布的项目,欢迎感兴趣的同学在上面给出的活动官网报名,或通过 <contact@nonebot.dev> 联系我们。
NoneBot 社区有幸作为开源社区参与了本次活动,下面列出了目前我们已经发布的项目,欢迎感兴趣的同学在上面给出的活动官网报名,或通过 [contact@nonebot.dev](mailto:contact@nonebot.dev) 联系我们。

## NoneBot v1

Expand Down
14 changes: 7 additions & 7 deletions website/versioned_docs/version-2.3.1/ospp/2022.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: 开源之夏 - 暑期 2022

**开源之夏 - 暑期 2022** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所****openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of Code(GSoC),旨在鼓励在校学生积极参与开源软件的开发维护,促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式,请查看该活动的 [官网](https://summer-ospp.ac.cn/)[帮助文档](https://summer-ospp.ac.cn/help/)

NoneBot 社区有幸作为开源社区 [参与](https://summer-ospp.ac.cn/#/org/orgdetail/e1fb5b8d-125a-4138-b756-25bd32c0a31a/) 了本次活动,下面列出了目前我们已经发布的项目,欢迎感兴趣的同学加入 QQ 群 [737131827](https://jq.qq.com/?_wv=1027&k=PEgyGeEu) 或通过 <contact@nonebot.dev> 联系我们。
NoneBot 社区有幸作为开源社区 [参与](https://summer-ospp.ac.cn/#/org/orgdetail/e1fb5b8d-125a-4138-b756-25bd32c0a31a/) 了本次活动,下面列出了目前我们已经发布的项目,欢迎感兴趣的同学加入 QQ 群 [737131827](https://jq.qq.com/?_wv=1027&k=PEgyGeEu) 或通过 [contact@nonebot.dev](mailto:contact@nonebot.dev) 联系我们。

## NoneBot2 命令行 CLI 交互体验升级

Expand Down Expand Up @@ -36,8 +36,8 @@ NoneBot2 为用户提供了命令行脚手架 ──`nb-cli`,辅助用户更

**成果仓库**

- <https://github.com/nonebot/nb-cli>
- <https://github.com/nonebot/nonebot2>
- [https://github.com/nonebot/nb-cli]
- [https://github.com/nonebot/nonebot2]

## NoneBot2 命令行即时交互通信设计与实现

Expand All @@ -63,16 +63,16 @@ NoneBot2 在早期提供了基于网页的 nonebot-plugin-test 插件,无需

**成果仓库**

- <https://github.com/nonebot/adapter-console>
- [https://github.com/nonebot/adapter-console]

## NoneBot2 用户上手与深入教程设计

NoneBot2 为用户提供了详细的文档介绍,辅助用户更好的上手项目以及进行开发。文档分为基础与进阶两个部分。基础部分帮助新用户快速上手开发,主要包括:安装 NoneBot2、使用脚手架、创建配置项目、使用适配器、加载插件、定义消息事件、处理消息事件、调用平台 API 等。进阶部分向已经熟悉开发流程的用户介绍更多高级技巧,主要包括:NoneBot2 工作原理、定时任务、权限控制、钩子函数、跨插件访问、单元测试、发布插件等。目前文档对于用户而言过于费解,导致用户难以理解 NoneBot2 开发。本项目旨在优化文档内容,使其更加通俗易懂,不让文档成为用户上手的阻碍,同时完善进阶内容,让有更复杂需求的用户,同样能从文档中受益。

相关 issue:

- <https://github.com/nonebot/nonebot2/issues/793>
- <https://github.com/nonebot/nonebot2/issues/295>
- [https://github.com/nonebot/nonebot2/issues/793]
- [https://github.com/nonebot/nonebot2/issues/295]

**难度**:进阶

Expand All @@ -93,4 +93,4 @@ NoneBot2 为用户提供了详细的文档介绍,辅助用户更好的上手

**成果仓库**

- <https://github.com/nonebot/nonebot2>
- [https://github.com/nonebot/nonebot2]
8 changes: 4 additions & 4 deletions website/versioned_docs/version-2.3.1/ospp/2023.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: 开源之夏 - 暑期 2023

**开源之夏 - 暑期 2023** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所****openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of Code(GSoC),旨在鼓励在校学生积极参与开源软件的开发维护,促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式,请查看该活动的 [官网](https://summer-ospp.ac.cn/)[帮助文档](https://summer-ospp.ac.cn/help/)

NoneBot 社区有幸作为开源社区 [参与](https://summer-ospp.ac.cn/org/orgdetail/e1fb5b8d-125a-4138-b756-25bd32c0a31a?lang=zh) 了本次活动,下面列出了目前我们已经发布的项目,欢迎感兴趣的同学通过 <contact@nonebot.dev> 联系我们。
NoneBot 社区有幸作为开源社区 [参与](https://summer-ospp.ac.cn/org/orgdetail/e1fb5b8d-125a-4138-b756-25bd32c0a31a?lang=zh) 了本次活动,下面列出了目前我们已经发布的项目,欢迎感兴趣的同学通过 [contact@nonebot.dev](mailto:contact@nonebot.dev) 联系我们。

## NoneBot 项目管理图形化面板

Expand All @@ -34,7 +34,7 @@ NoneBot 目前提供了开箱即用的命令行脚手架来帮助初次使用的

**成果仓库**

- <https://github.com/nonebot/cli-plugin-webui>
- [https://github.com/nonebot/cli-plugin-webui]

## NoneBot Discord 适配器

Expand All @@ -57,7 +57,7 @@ NoneBot 作为一个跨平台聊天机器人框架,目前已有 OneBot、飞

**成果仓库**

- <https://github.com/nonebot/adapter-discord>
- [https://github.com/nonebot/adapter-discord]

## NoneBot 数据库支持插件

Expand Down Expand Up @@ -86,4 +86,4 @@ NoneBot 的插件系统为用户实现应用提供了极高的便捷性,但因

**成果仓库**

- <https://github.com/nonebot/plugin-orm>
- [https://github.com/nonebot/plugin-orm]
Loading

0 comments on commit 96ca8d9

Please sign in to comment.