📝 Docs: 升级到 Docusaurus V3 (#2956)

This commit is contained in:
StarHeart 2024-10-22 10:33:48 +08:00 committed by GitHub
parent 533e8794b2
commit c1c5f57e0b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
75 changed files with 6110 additions and 4739 deletions

View File

@ -40,7 +40,7 @@ jobs:
- name: Update Changelog - name: Update Changelog
uses: docker://ghcr.io/nonebot/auto-changelog:master uses: docker://ghcr.io/nonebot/auto-changelog:master
with: with:
changelog_file: website/src/pages/changelog.md changelog_file: website/src/changelog/changelog.md
latest_changes_position: '# 更新日志\n\n' latest_changes_position: '# 更新日志\n\n'
latest_changes_title: "## 最近更新" latest_changes_title: "## 最近更新"
replace_regex: '(?<=## 最近更新\n)[\s\S]*?(?=\n## )' replace_regex: '(?<=## 最近更新\n)[\s\S]*?(?=\n## )'

View File

@ -32,7 +32,7 @@ jobs:
- name: Archive Changelog - name: Archive Changelog
uses: docker://ghcr.io/nonebot/auto-changelog:master uses: docker://ghcr.io/nonebot/auto-changelog:master
with: with:
changelog_file: website/src/pages/changelog.md changelog_file: website/src/changelog/changelog.md
archive_regex: '(?<=## )最近更新(?=\n)' archive_regex: '(?<=## )最近更新(?=\n)'
archive_title: ${{ env.TAG_NAME }} archive_title: ${{ env.TAG_NAME }}
commit_and_push: false commit_and_push: false

1
.gitignore vendored
View File

@ -7,6 +7,7 @@ docs_build/_build
!tests/.env !tests/.env
.docusaurus .docusaurus
website/docs/api/**/*.md website/docs/api/**/*.md
website/src/pages/changelog/**/*
# Created by https://www.toptal.com/developers/gitignore/api/python,node,visualstudiocode,jetbrains,macos,windows,linux # Created by https://www.toptal.com/developers/gitignore/api/python,node,visualstudiocode,jetbrains,macos,windows,linux
# Edit at https://www.toptal.com/developers/gitignore?templates=python,node,visualstudiocode,jetbrains,macos,windows,linux # Edit at https://www.toptal.com/developers/gitignore?templates=python,node,visualstudiocode,jetbrains,macos,windows,linux

View File

@ -1,3 +1,3 @@
# Changelog # Changelog
See [changelog.md](./website/src/pages/changelog.md) or <https://nonebot.dev/changelog> See [changelog.md](./website/src/changelog/changelog.md) or <https://nonebot.dev/changelog>

View File

@ -39,6 +39,8 @@
- `require` => {ref}``require` <nonebot.plugin.load.require>` - `require` => {ref}``require` <nonebot.plugin.load.require>`
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 0 sidebar_position: 0
description: nonebot 模块 description: nonebot 模块
""" """

View File

@ -3,6 +3,8 @@
使用 {ref}`nonebot.drivers.Driver.register_adapter` 注册适配器 使用 {ref}`nonebot.drivers.Driver.register_adapter` 注册适配器
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 0 sidebar_position: 0
description: nonebot.adapters 模块 description: nonebot.adapters 模块
""" """

View File

@ -3,6 +3,8 @@
为兼容 Pydantic V1 V2 版本定义了一系列兼容函数与类供使用 为兼容 Pydantic V1 V2 版本定义了一系列兼容函数与类供使用
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 16 sidebar_position: 16
description: nonebot.compat 模块 description: nonebot.compat 模块
""" """

View File

@ -7,6 +7,8 @@ NoneBot 使用 [`pydantic`](https://pydantic-docs.helpmanual.io/) 以及
详情见 [`pydantic Field Type`](https://pydantic-docs.helpmanual.io/usage/types/) 文档 详情见 [`pydantic Field Type`](https://pydantic-docs.helpmanual.io/usage/types/) 文档
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 1 sidebar_position: 1
description: nonebot.config 模块 description: nonebot.config 模块
""" """

View File

@ -1,6 +1,8 @@
"""本模块包含了 NoneBot 事件处理过程中使用到的常量。 """本模块包含了 NoneBot 事件处理过程中使用到的常量。
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 9 sidebar_position: 9
description: nonebot.consts 模块 description: nonebot.consts 模块
""" """

View File

@ -1,6 +1,8 @@
"""本模块模块实现了依赖注入的定义与处理。 """本模块模块实现了依赖注入的定义与处理。
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 0 sidebar_position: 0
description: nonebot.dependencies 模块 description: nonebot.dependencies 模块
""" """

View File

@ -1,5 +1,7 @@
""" """
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 1 sidebar_position: 1
description: nonebot.dependencies.utils 模块 description: nonebot.dependencies.utils 模块
""" """

View File

@ -3,6 +3,8 @@
各驱动请继承以下基类 各驱动请继承以下基类
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 0 sidebar_position: 0
description: nonebot.drivers 模块 description: nonebot.drivers 模块
""" """

View File

@ -11,6 +11,8 @@ pip install nonebot2[aiohttp]
::: :::
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 2 sidebar_position: 2
description: nonebot.drivers.aiohttp 模块 description: nonebot.drivers.aiohttp 模块
""" """

View File

@ -11,6 +11,8 @@ pip install nonebot2[fastapi]
::: :::
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 1 sidebar_position: 1
description: nonebot.drivers.fastapi 模块 description: nonebot.drivers.fastapi 模块
""" """

View File

@ -11,6 +11,8 @@ pip install nonebot2[httpx]
::: :::
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 3 sidebar_position: 3
description: nonebot.drivers.httpx 模块 description: nonebot.drivers.httpx 模块
""" """

View File

@ -5,6 +5,8 @@
::: :::
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 6 sidebar_position: 6
description: nonebot.drivers.none 模块 description: nonebot.drivers.none 模块
""" """

View File

@ -11,6 +11,8 @@ pip install nonebot2[quart]
::: :::
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 5 sidebar_position: 5
description: nonebot.drivers.quart 模块 description: nonebot.drivers.quart 模块
""" """

View File

@ -11,6 +11,8 @@ pip install nonebot2[websockets]
::: :::
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 4 sidebar_position: 4
description: nonebot.drivers.websockets 模块 description: nonebot.drivers.websockets 模块
""" """

View File

@ -25,6 +25,8 @@ NoneBotException
``` ```
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 10 sidebar_position: 10
description: nonebot.exception 模块 description: nonebot.exception 模块
""" """

View File

@ -8,6 +8,8 @@ NoneBot 使用 [`loguru`][loguru] 来记录日志信息。
[loguru]: https://github.com/Delgan/loguru [loguru]: https://github.com/Delgan/loguru
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 7 sidebar_position: 7
description: nonebot.log 模块 description: nonebot.log 模块
""" """

View File

@ -1,6 +1,8 @@
"""本模块实现事件响应器的创建与运行,并提供一些快捷方法来帮助用户更好的与机器人进行对话。 """本模块实现事件响应器的创建与运行,并提供一些快捷方法来帮助用户更好的与机器人进行对话。
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 3 sidebar_position: 3
description: nonebot.matcher 模块 description: nonebot.matcher 模块
""" """

View File

@ -3,6 +3,8 @@
NoneBot 内部处理并按优先级分发事件给所有事件响应器提供了多个插槽以进行事件的预处理等 NoneBot 内部处理并按优先级分发事件给所有事件响应器提供了多个插槽以进行事件的预处理等
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 2 sidebar_position: 2
description: nonebot.message 模块 description: nonebot.message 模块
""" """

View File

@ -1,6 +1,8 @@
"""本模块定义了依赖注入的各类参数。 """本模块定义了依赖注入的各类参数。
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 4 sidebar_position: 4
description: nonebot.params 模块 description: nonebot.params 模块
""" """

View File

@ -5,6 +5,8 @@
只要有一个 `PermissionChecker` 检查结果为 `True` 时就会继续运行 只要有一个 `PermissionChecker` 检查结果为 `True` 时就会继续运行
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 6 sidebar_position: 6
description: nonebot.permission 模块 description: nonebot.permission 模块
""" """

View File

@ -32,6 +32,8 @@
- `PluginMetadata` => {ref}``PluginMetadata` <nonebot.plugin.model.PluginMetadata>` - `PluginMetadata` => {ref}``PluginMetadata` <nonebot.plugin.model.PluginMetadata>`
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 0 sidebar_position: 0
description: nonebot.plugin 模块 description: nonebot.plugin 模块
""" """

View File

@ -1,6 +1,8 @@
"""本模块定义插件加载接口。 """本模块定义插件加载接口。
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 1 sidebar_position: 1
description: nonebot.plugin.load 模块 description: nonebot.plugin.load 模块
""" """

View File

@ -3,6 +3,8 @@
参考: [import hooks](https://docs.python.org/3/reference/import.html#import-hooks), [PEP302](https://www.python.org/dev/peps/pep-0302/) 参考: [import hooks](https://docs.python.org/3/reference/import.html#import-hooks), [PEP302](https://www.python.org/dev/peps/pep-0302/)
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 5 sidebar_position: 5
description: nonebot.plugin.manager 模块 description: nonebot.plugin.manager 模块
""" """

View File

@ -1,6 +1,8 @@
"""本模块定义插件相关信息。 """本模块定义插件相关信息。
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 3 sidebar_position: 3
description: nonebot.plugin.model 模块 description: nonebot.plugin.model 模块
""" """

View File

@ -1,6 +1,8 @@
"""本模块定义事件响应器便携定义函数。 """本模块定义事件响应器便携定义函数。
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 2 sidebar_position: 2
description: nonebot.plugin.on 模块 description: nonebot.plugin.on 模块
""" """

View File

@ -5,6 +5,8 @@
只有当所有 `RuleChecker` 检查结果为 `True` 时继续运行 只有当所有 `RuleChecker` 检查结果为 `True` 时继续运行
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 5 sidebar_position: 5
description: nonebot.rule 模块 description: nonebot.rule 模块
""" """

View File

@ -6,6 +6,8 @@
[`typing`](https://docs.python.org/3/library/typing.html) [`typing`](https://docs.python.org/3/library/typing.html)
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 11 sidebar_position: 11
description: nonebot.typing 模块 description: nonebot.typing 模块
""" """

View File

@ -1,6 +1,8 @@
"""本模块包含了 NoneBot 的一些工具函数 """本模块包含了 NoneBot 的一些工具函数
FrontMatter: FrontMatter:
mdx:
format: md
sidebar_position: 8 sidebar_position: 8
description: nonebot.utils 模块 description: nonebot.utils 模块
""" """

View File

@ -22,7 +22,7 @@ include = ["nonebot/py.typed"]
[tool.poetry.urls] [tool.poetry.urls]
"Bug Tracker" = "https://github.com/nonebot/nonebot2/issues" "Bug Tracker" = "https://github.com/nonebot/nonebot2/issues"
"Changelog" = "https://nonebot.dev/changelog" "Changelog" = "https://nonebot.dev/changelog"
"Funding" = "https://afdian.net/@nonebot" "Funding" = "https://afdian.com/@nonebot"
[tool.poetry.dependencies] [tool.poetry.dependencies]
python = "^3.9" python = "^3.9"

View File

@ -166,7 +166,7 @@ COMMON_CONFIG=common config # 这个配置项在任何环境中都会被加载
在生产环境中,可以通过设置环境变量 `ENVIRONMENT=prod` 来确保 NoneBot 读取正确的环境配置。 在生产环境中,可以通过设置环境变量 `ENVIRONMENT=prod` 来确保 NoneBot 读取正确的环境配置。
::: :::
#### .env.{ENVIRONMENT} 文件 #### .env.\{ENVIRONMENT\} 文件
`.env.{ENVIRONMENT}` 文件类似于预设,可以让我们在多套不同的配置方案中灵活切换,默认 NoneBot 会读取 `.env.prod` 配置。如果你使用了 `nb-cli` 创建 `simple` 项目,那么将含有两套预设配置:`.env.dev` 和 `.env.prod`。 `.env.{ENVIRONMENT}` 文件类似于预设,可以让我们在多套不同的配置方案中灵活切换,默认 NoneBot 会读取 `.env.prod` 配置。如果你使用了 `nb-cli` 创建 `simple` 项目,那么将含有两套预设配置:`.env.dev` 和 `.env.prod`。

View File

@ -71,14 +71,14 @@ alc = Alconna(".rd{roll:int}")
assert alc.parse(".rd123").header["roll"] == 123 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;.+)" - `"{foo}"``"(?P&lt;foo&gt;.+)"`
- "{:\d+}" ⇔ "(\d+)" - `"{:\d+}"``"(\d+)"`
- "{foo:int}" ⇔ "(?P&lt;foo&gt;\d+)",其中 "int" 部分若能转为 `BasePattern` 则读取里面的表达式 - `"{foo:int}"``"(?P&lt;foo&gt;\d+)"`,其中 `"int"` 部分若能转为 `BasePattern` 则读取里面的表达式
## 参数声明(Args) ## 参数声明(Args)
@ -321,7 +321,7 @@ opt2 = Option("--foo", default=OptionResult(value=False, args={"bar": 1}))
- `keep_crlf`: 命令解析时是否保留换行字符 - `keep_crlf`: 命令解析时是否保留换行字符
- `compact`: 命令是否允许第一个参数紧随头部 - `compact`: 命令是否允许第一个参数紧随头部
- `strict`: 命令是否严格匹配,若为 False 则未知参数将作为名为 $extra 的参数 - `strict`: 命令是否严格匹配,若为 False 则未知参数将作为名为 $extra 的参数
- `context_style`: 命令上下文插值的风格None 为关闭bracket 为 {...}parentheses 为 $(...) - `context_style`: 命令上下文插值的风格None 为关闭bracket 为 `{...}`parentheses 为 `$(...)`
- `extra`: 命令的自定义额外信息 - `extra`: 命令的自定义额外信息
元数据一定使用 `meta=...` 形式传入: 元数据一定使用 `meta=...` 形式传入:

View File

@ -96,7 +96,7 @@ class Other(Segment):
``` ```
:::tips :::tip
或许你注意到了 `Segment` 上有一个 `children` 属性。 或许你注意到了 `Segment` 上有一个 `children` 属性。
@ -291,7 +291,7 @@ msg.extend([Text("text")])
这里额外说明 `UniMessage.template` 的拓展控制符 这里额外说明 `UniMessage.template` 的拓展控制符
相比 `Message`UniMessage 对于 {:XXX} 做了另一类拓展。其能够识别例如 At(xxx, yyy) 或 Emoji(aaa, bbb)的字符串并执行 相比 `Message`UniMessage 对于 `{:XXX}` 做了另一类拓展。其能够识别例如 At(xxx, yyy) 或 Emoji(aaa, bbb)的字符串并执行
以 At(...) 为例: 以 At(...) 为例:
@ -305,7 +305,7 @@ UniMessage(At("user", "123"))
UniMessage(At("user", "123")) UniMessage(At("user", "123"))
``` ```
而在 `AlconnaMatcher` 中,{:XXX} 更进一步地提供了获取 `event` 和 `bot` 中的属性的功能: 而在 `AlconnaMatcher` 中,`{:XXX}` 更进一步地提供了获取 `event` 和 `bot` 中的属性的功能:
```python title=在AlconnaMatcher中使用通用消息段的拓展控制符 ```python title=在AlconnaMatcher中使用通用消息段的拓展控制符
from arclet.alconna import Alconna, Args from arclet.alconna import Alconna, Args

View File

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

View File

@ -1,13 +1,15 @@
--- ---
sidebar_position: 1 sidebar_position: 1
description: 开源之夏 - 暑期 2022 description: 开源之夏 - 暑期 2022
mdx:
format: md
--- ---
# 暑期 2022 # 暑期 2022
**开源之夏 - 暑期 2022** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of CodeGSoC旨在鼓励在校学生积极参与开源软件的开发维护促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式请查看该活动的 [官网](https://summer-ospp.ac.cn/) 和 [帮助文档](https://summer-ospp.ac.cn/help/)。 **开源之夏 - 暑期 2022** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of CodeGSoC旨在鼓励在校学生积极参与开源软件的开发维护促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式请查看该活动的 [官网](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 交互体验升级 ## NoneBot2 命令行 CLI 交互体验升级

View File

@ -1,13 +1,15 @@
--- ---
sidebar_position: 2 sidebar_position: 2
description: 开源之夏 - 暑期 2023 description: 开源之夏 - 暑期 2023
mdx:
format: md
--- ---
# 暑期 2023 # 暑期 2023
**开源之夏 - 暑期 2023** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of CodeGSoC旨在鼓励在校学生积极参与开源软件的开发维护促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式请查看该活动的 [官网](https://summer-ospp.ac.cn/) 和 [帮助文档](https://summer-ospp.ac.cn/help/)。 **开源之夏 - 暑期 2023** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of CodeGSoC旨在鼓励在校学生积极参与开源软件的开发维护促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式请查看该活动的 [官网](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 项目管理图形化面板 ## NoneBot 项目管理图形化面板

View File

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

View File

@ -1,317 +0,0 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
// color mode config
/** @type {import('@nullbot/docusaurus-preset-nonepress').ThemeConfig["colorMode"]} */
const colorMode = {
defaultMode: "light",
respectPrefersColorScheme: true,
};
// navbar config
/** @type {import('@nullbot/docusaurus-preset-nonepress').ThemeConfig["navbar"]} */
const navbar = {
title: "NoneBot",
logo: {
alt: "NoneBot",
src: "logo.png",
href: "/",
target: "_self",
height: 32,
width: 32,
},
hideOnScroll: false,
items: [
{
label: "指南",
type: "docsMenu",
category: "tutorial",
},
{
label: "深入",
type: "docsMenu",
category: "appendices",
},
{
label: "进阶",
type: "docsMenu",
category: "advanced",
},
{
label: "API",
type: "doc",
docId: "api/index",
},
{
label: "更多",
type: "dropdown",
to: "/store/plugins",
items: [
{
label: "最佳实践",
type: "doc",
docId: "best-practice/scheduler",
},
{
label: "开发者",
type: "doc",
docId: "developer/plugin-publishing",
},
{ label: "社区", type: "doc", docId: "community/contact" },
{ label: "开源之夏", type: "doc", docId: "ospp/2024" },
{ label: "商店", to: "/store/plugins" },
{ label: "更新日志", to: "/changelog" },
{ label: "论坛", href: "https://discussions.nonebot.dev" },
],
},
],
};
// footer config
/** @type {import('@nullbot/docusaurus-preset-nonepress').ThemeConfig["footer"]} */
const footer = {
style: "light",
logo: {
alt: "NoneBot",
src: "logo.png",
href: "/",
target: "_self",
height: 32,
width: 32,
},
copyright: `Copyright © ${new Date().getFullYear()} NoneBot. All rights reserved.`,
links: [
{
title: "Learn",
items: [
{ label: "Introduction", to: "/docs/" },
{ label: "QuickStart", to: "/docs/quick-start" },
{ label: "Changelog", to: "/changelog" },
],
},
{
title: "NoneBot Team",
items: [
{
label: "Homepage",
href: "https://nonebot.dev",
},
{
label: "NoneBot V1",
href: "https://v1.nonebot.dev",
},
{ label: "NoneBot CLI", href: "https://cli.nonebot.dev" },
],
},
{
title: "Related",
items: [
{ label: "OneBot", href: "https://onebot.dev/" },
{ label: "go-cqhttp", href: "https://docs.go-cqhttp.org/" },
{ label: "Mirai", href: "https://mirai.mamoe.net/" },
],
},
],
};
// prism config
/** @type {import('prism-react-renderer').PrismTheme} */
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
// eslint-disable-next-line import/order
const lightCodeTheme = require("prism-react-renderer/themes/github");
/** @type {import('prism-react-renderer').PrismTheme} */
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
// eslint-disable-next-line import/order
const darkCodeTheme = require("prism-react-renderer/themes/dracula");
/** @type {import('@nullbot/docusaurus-preset-nonepress').ThemeConfig["prism"]} */
const prism = {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
additionalLanguages: ["docker", "ini"],
};
// algolia config
/** @type {import('@nullbot/docusaurus-preset-nonepress').ThemeConfig["algolia"]} */
const algolia = {
appId: "X0X5UACHZQ",
apiKey: "ac03e1ac2bd0812e2ea38c0cc1ea38c5",
indexName: "nonebot",
contextualSearch: true,
};
// nonepress config
/** @type {import('@nullbot/docusaurus-preset-nonepress').ThemeConfig["nonepress"]} */
const nonepress = {
tailwindConfig: require("./tailwind.config"),
navbar: {
docsVersionDropdown: {
dropdownItemsAfter: [
{
label: "1.x",
href: "https://v1.nonebot.dev/",
},
],
},
socialLinks: [
{
icon: ["fab", "github"],
href: "https://github.com/nonebot/nonebot2",
},
],
},
footer: {
socialLinks: [
{
icon: ["fab", "github"],
href: "https://github.com/nonebot/nonebot2",
},
{
icon: ["fab", "qq"],
href: "https://jq.qq.com/?_wv=1027&k=5OFifDh",
},
{
icon: ["fab", "telegram"],
href: "https://t.me/botuniverse",
},
{
icon: ["fab", "discord"],
href: "https://discord.gg/VKtE6Gdc4h",
},
],
},
};
// theme config
/** @type {import('@nullbot/docusaurus-preset-nonepress').ThemeConfig} */
const themeConfig = {
colorMode,
navbar,
footer,
prism,
algolia,
nonepress,
};
/** @type {import('@docusaurus/types').Config} */
const siteConfig = {
title: "NoneBot",
tagline: "跨平台 Python 异步机器人框架",
favicon: "icons/favicon.ico",
// Set the production url of your site here
url: "https://nonebot.dev",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: process.env.BASE_URL || "/",
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "nonebot", // Usually your GitHub org/user name.
projectName: "nonebot2", // Usually your repo name.
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
// Even if you don't use internalization, you can use this field to set useful
// metadata like html lang. For example, if your site is Chinese, you may want
// to replace "en" with "zh-Hans".
i18n: {
defaultLocale: "zh-Hans",
locales: ["zh-Hans"],
},
headTags: [
// 百度搜索资源平台
// https://ziyuan.baidu.com/
{
tagName: "meta",
attributes: {
name: "baidu-site-verification",
content: "codeva-0GTZpDnDrW",
},
},
],
scripts: [
// 百度统计
// https://tongji.baidu.com/
{
type: "text/javascript",
charset: "UTF-8",
src: "https://hm.baidu.com/hm.js?875efa50097818701ee681edd63eaac6",
async: true,
},
// 万维广告
// https://wwads.cn/
{
type: "text/javascript",
charset: "UTF-8",
src: "https://cdn.wwads.cn/js/makemoney.js",
async: true,
},
// uwu logo
{
type: "text/javascript",
charset: "UTF-8",
src: "/uwu.js",
},
],
presets: [
[
"@nullbot/docusaurus-preset-nonepress",
/** @type {import('@nullbot/docusaurus-preset-nonepress').Options} */
({
docs: {
sidebarPath: require.resolve("./sidebars.js"),
// Please change this to your repo.
editUrl: "https://github.com/nonebot/nonebot2/edit/master/website/",
showLastUpdateAuthor: true,
showLastUpdateTime: true,
// exclude: [
// "**/_*.{js,jsx,ts,tsx,md,mdx}",
// "**/_*/**",
// "**/*.test.{js,jsx,ts,tsx}",
// "**/__tests__/**",
// ],
// async sidebarItemsGenerator({
// isCategoryIndex: defaultCategoryIndexMatcher,
// defaultSidebarItemsGenerator,
// ...args
// }) {
// return defaultSidebarItemsGenerator({
// ...args,
// isCategoryIndex(doc) {
// // disable category index convention for generated API docs
// if (
// doc.directories.length > 0 &&
// doc.directories.at(-1) === "api"
// ) {
// return false;
// }
// return defaultCategoryIndexMatcher(doc);
// },
// });
// },
},
// theme: {
// customCss: require.resolve("./src/css/custom.css"),
// },
sitemap: {
changefreq: "daily",
priority: 0.5,
},
gtag: {
trackingID: "G-MRS1GMZG0F",
},
}),
],
],
plugins: [require("./src/plugins/webpack-plugin.cjs")],
themeConfig,
};
module.exports = siteConfig;

View File

@ -0,0 +1,353 @@
import type { Config } from "@docusaurus/types";
import type { Options as ChangelogOptions } from "@nullbot/docusaurus-plugin-changelog";
import type * as Preset from "@nullbot/docusaurus-preset-nonepress";
import { themes } from "prism-react-renderer";
// By default, we use Docusaurus Faster
// DOCUSAURUS_SLOWER=true is useful for benchmarking faster against slower
// hyperfine --prepare 'yarn clear:website' --runs 3 'DOCUSAURUS_SLOWER=true yarn build:website:fast' 'yarn build:website:fast'
const isSlower = process.env.DOCUSAURUS_SLOWER === "true";
if (isSlower) {
console.log("🐢 Using slower Docusaurus build");
}
// color mode config
const colorMode: Preset.ThemeConfig["colorMode"] = {
defaultMode: "light",
respectPrefersColorScheme: true,
};
// navbar config
const navbar: Preset.ThemeConfig["navbar"] = {
title: "NoneBot",
logo: {
alt: "NoneBot",
src: "logo.png",
href: "/",
target: "_self",
height: 32,
width: 32,
},
hideOnScroll: false,
items: [
{
label: "指南",
type: "docsMenu",
category: "tutorial",
},
{
label: "深入",
type: "docsMenu",
category: "appendices",
},
{
label: "进阶",
type: "docsMenu",
category: "advanced",
},
{
label: "API",
type: "doc",
docId: "api/index",
},
{
label: "更多",
type: "dropdown",
to: "/store/plugins",
items: [
{
label: "最佳实践",
type: "doc",
docId: "best-practice/scheduler",
},
{
label: "开发者",
type: "doc",
docId: "developer/plugin-publishing",
},
{ label: "社区", type: "doc", docId: "community/contact" },
{ label: "开源之夏", type: "doc", docId: "ospp/2024" },
{ label: "商店", to: "/store/plugins" },
{ label: "更新日志", to: "/changelog" },
{ label: "论坛", href: "https://discussions.nonebot.dev" },
],
},
],
};
// footer config
const footer: Preset.ThemeConfig["footer"] = {
style: "light",
logo: {
alt: "NoneBot",
src: "logo.png",
href: "/",
target: "_self",
height: 32,
width: 32,
},
copyright: `Copyright © ${new Date().getFullYear()} NoneBot. All rights reserved.`,
links: [
{
title: "Learn",
items: [
{ label: "Introduction", to: "/docs/" },
{ label: "QuickStart", to: "/docs/quick-start" },
{ label: "Changelog", to: "/changelog" },
],
},
{
title: "NoneBot Team",
items: [
{
label: "Homepage",
href: "https://nonebot.dev",
},
{
label: "NoneBot V1",
href: "https://v1.nonebot.dev",
},
{ label: "NoneBot CLI", href: "https://cli.nonebot.dev" },
],
},
{
title: "Related",
items: [
{ label: "OneBot", href: "https://onebot.dev/" },
{ label: "go-cqhttp", href: "https://docs.go-cqhttp.org/" },
{ label: "Mirai", href: "https://mirai.mamoe.net/" },
],
},
],
};
// prism config
const lightCodeTheme = themes.github;
const darkCodeTheme = themes.dracula;
const prism: Preset.ThemeConfig["prism"] = {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
additionalLanguages: ["docker", "ini"],
};
// algolia config
const algolia: Preset.ThemeConfig["algolia"] = {
appId: "X0X5UACHZQ",
apiKey: "ac03e1ac2bd0812e2ea38c0cc1ea38c5",
indexName: "nonebot",
contextualSearch: true,
};
// nonepress config
const nonepress: Preset.ThemeConfig["nonepress"] = {
tailwindConfig: require("./tailwind.config"),
navbar: {
docsVersionDropdown: {
dropdownItemsAfter: [
{
label: "1.x",
href: "https://v1.nonebot.dev/",
},
],
},
socialLinks: [
{
icon: ["fab", "github"],
href: "https://github.com/nonebot/nonebot2",
},
],
},
footer: {
socialLinks: [
{
icon: ["fab", "github"],
href: "https://github.com/nonebot/nonebot2",
},
{
icon: ["fab", "qq"],
href: "https://jq.qq.com/?_wv=1027&k=5OFifDh",
},
{
icon: ["fab", "telegram"],
href: "https://t.me/botuniverse",
},
{
icon: ["fab", "discord"],
href: "https://discord.gg/VKtE6Gdc4h",
},
],
},
};
// theme config
const themeConfig: Preset.ThemeConfig = {
colorMode,
navbar,
footer,
prism,
algolia,
nonepress,
};
export default async function createConfigAsync() {
return {
title: "NoneBot",
tagline: "跨平台 Python 异步机器人框架",
favicon: "icons/favicon.ico",
// Set the production url of your site here
url: "https://nonebot.dev",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: process.env.BASE_URL || "/",
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "nonebot", // Usually your GitHub org/user name.
projectName: "nonebot2", // Usually your repo name.
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
// Even if you don't use internalization, you can use this field to set useful
// metadata like html lang. For example, if your site is Chinese, you may want
// to replace "en" with "zh-Hans".
i18n: {
defaultLocale: "zh-Hans",
locales: ["zh-Hans"],
},
headTags: [
// 百度搜索资源平台
// https://ziyuan.baidu.com/
{
tagName: "meta",
attributes: {
name: "baidu-site-verification",
content: "codeva-0GTZpDnDrW",
},
},
],
scripts: [
// 百度统计
// https://tongji.baidu.com/
{
type: "text/javascript",
charset: "UTF-8",
src: "https://hm.baidu.com/hm.js?875efa50097818701ee681edd63eaac6",
async: true,
},
// 万维广告
// https://wwads.cn/
{
type: "text/javascript",
charset: "UTF-8",
src: "https://cdn.wwads.cn/js/makemoney.js",
async: true,
},
// uwu logo
{
type: "text/javascript",
charset: "UTF-8",
src: "/uwu.js",
},
],
presets: [
[
"@nullbot/docusaurus-preset-nonepress",
/** @type {import('@nullbot/docusaurus-preset-nonepress').Options} */
{
docs: {
sidebarPath: require.resolve("./sidebars.js"),
// Please change this to your repo.
editUrl: "https://github.com/nonebot/nonebot2/edit/master/website/",
showLastUpdateAuthor: true,
showLastUpdateTime: true,
// exclude: [
// "**/_*.{js,jsx,ts,tsx,md,mdx}",
// "**/_*/**",
// "**/*.test.{js,jsx,ts,tsx}",
// "**/__tests__/**",
// ],
// async sidebarItemsGenerator({
// isCategoryIndex: defaultCategoryIndexMatcher,
// defaultSidebarItemsGenerator,
// ...args
// }) {
// return defaultSidebarItemsGenerator({
// ...args,
// isCategoryIndex(doc) {
// // disable category index convention for generated API docs
// if (
// doc.directories.length > 0 &&
// doc.directories.at(-1) === "api"
// ) {
// return false;
// }
// return defaultCategoryIndexMatcher(doc);
// },
// });
// },
},
// theme: {
// customCss: require.resolve("./src/css/custom.css"),
// },
sitemap: {
changefreq: "daily",
priority: 0.5,
},
gtag: {
trackingID: "G-MRS1GMZG0F",
},
},
],
],
webpack: {
jsLoader: (isServer) => ({
loader: require.resolve("swc-loader"),
options: {
jsc: {
parser: {
syntax: "typescript",
tsx: true,
},
transform: {
react: {
runtime: "automatic",
},
},
target: "es2017",
},
module: {
type: isServer ? "commonjs" : "es6",
},
},
}),
},
plugins: [
require("./src/plugins/webpack-plugin.ts"),
[
"@nullbot/docusaurus-plugin-changelog",
{
changelogPath: "src/changelog/changelog.md",
changelogHeader: `description: Changelog
toc_max_heading_level: 2
sidebar_custom_props:
sidebar_id: changelog`,
} satisfies ChangelogOptions,
],
],
markdown: {
mdx1Compat: {
headingIds: true,
},
},
themeConfig,
} satisfies Config;
}

View File

@ -22,24 +22,27 @@
"typecheck": "tsc" "typecheck": "tsc"
}, },
"dependencies": { "dependencies": {
"@docusaurus/core": "^2.4.1", "@docusaurus/core": "^3.5.2",
"@mdx-js/react": "^1.6.22", "@mdx-js/react": "^3.0.0",
"@nullbot/docusaurus-preset-nonepress": "^2.1.2", "@nullbot/docusaurus-plugin-changelog": "^3.0.0",
"clsx": "^1.2.1", "@nullbot/docusaurus-preset-nonepress": "^3.0.0",
"copy-text-to-clipboard": "^3.0.1", "@swc/core": "^1.7.26",
"prism-react-renderer": "^1.3.5", "clsx": "^2.0.0",
"copy-text-to-clipboard": "^3.2.0",
"prism-react-renderer": "^2.3.0",
"raw-loader": "^4.0.2", "raw-loader": "^4.0.2",
"react": "^17.0.1", "react": "^18.0.0",
"react-color": "^2.19.3", "react-color": "^2.19.3",
"react-dom": "^17.0.1", "react-dom": "^18.0.0",
"react-use-pagination": "^2.0.1" "react-use-pagination": "^2.0.1",
"swc-loader": "^0.2.6"
}, },
"devDependencies": { "devDependencies": {
"@docusaurus/module-type-aliases": "^2.4.1", "@docusaurus/module-type-aliases": "^3.5.2",
"@tsconfig/docusaurus": "^1.0.5", "@nullbot/docusaurus-tsconfig": "^3.0.0",
"@types/react-color": "^3.0.10", "@types/react-color": "^3.0.10",
"asciinema-player": "^3.5.0", "asciinema-player": "^3.5.0",
"typescript": "^4.7.4" "typescript": "~5.5.2"
}, },
"browserslist": { "browserslist": {
"production": [ "production": [
@ -54,6 +57,6 @@
] ]
}, },
"engines": { "engines": {
"node": ">=16.14" "node": ">=18.0"
} }
} }

View File

@ -8,11 +8,15 @@
Create as many sidebars as you want. Create as many sidebars as you want.
*/ */
import path from "path";
// @ts-check import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
import { getChangelogItemsSync } from "@nullbot/docusaurus-plugin-changelog";
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const changelogPath = path.join(__dirname, "src/changelog/changelog.md");
const sidebars = { const changelogItems = getChangelogItemsSync(changelogPath, 10);
const sidebars: SidebarsConfig = {
tutorial: [ tutorial: [
{ {
type: "category", type: "category",
@ -133,6 +137,22 @@ const sidebars = {
], ],
}, },
], ],
changelog: [
{
type: "category",
label: "更新日志",
collapsible: false,
items: changelogItems.map<{ type: "link"; label: string; href: string }>(
(chunk, index) => ({
type: "link",
label: chunk[0]!.title,
href: `/changelog/${
index > 0 ? encodeURIComponent(chunk[0]!.title) : ""
}`,
})
),
},
],
}; };
module.exports = sidebars; export default sidebars;

View File

@ -1,7 +1,7 @@
import React from "react"; import React from "react";
import { useDocsVersionCandidates } from "@docusaurus/plugin-content-docs/client";
import { PageMetadata } from "@docusaurus/theme-common"; import { PageMetadata } from "@docusaurus/theme-common";
import { useDocsVersionCandidates } from "@docusaurus/theme-common/internal";
import { useVersionedSidebar } from "@nullbot/docusaurus-plugin-getsidebar/client"; import { useVersionedSidebar } from "@nullbot/docusaurus-plugin-getsidebar/client";
import { SidebarContentFiller } from "@nullbot/docusaurus-theme-nonepress/contexts"; import { SidebarContentFiller } from "@nullbot/docusaurus-theme-nonepress/contexts";
@ -25,7 +25,7 @@ function StorePage({ title, children }: Props): JSX.Element {
)!; )!;
return ( return (
<Page hideTableOfContents reduceContentWidth={false}> <Page hideTableOfContents reduceContentWidth={false} sidebarId={SIDEBAR_ID}>
<SidebarContentFiller items={sidebarItems} /> <SidebarContentFiller items={sidebarItems} />
<article className="prose max-w-full"> <article className="prose max-w-full">
<h1 className="store-title">{title}</h1> <h1 className="store-title">{title}</h1>

View File

@ -1,11 +1,8 @@
// @ts-check import path from "path";
const path = require("path"); import type { PluginConfig } from "@docusaurus/types";
/** export default (function webpackPlugin() {
* @returns {import('@docusaurus/types').Plugin}
*/
function webpackPlugin() {
return { return {
name: "webpack-plugin", name: "webpack-plugin",
configureWebpack() { configureWebpack() {
@ -18,6 +15,4 @@ function webpackPlugin() {
}; };
}, },
}; };
} } satisfies PluginConfig);
module.exports = webpackPlugin;

View File

@ -1,24 +1,26 @@
const lightTheme = require("daisyui/src/theming/themes")["[data-theme=light]"]; import typography from "@tailwindcss/typography";
const darkTheme = require("daisyui/src/theming/themes")["[data-theme=dark]"]; import daisyui from "daisyui";
import themes from "daisyui/src/theming/themes";
/** const lightTheme = themes.light;
* @param {{[key: string]: string}} theme const darkTheme = themes.dark;
* @param {string[]} exclude
* @returns {{[key: string]: string}} function excludeThemeColor(
*/ theme: { [key: string]: string },
function excludeThemeColor(theme, exclude) { exclude: string[]
/** @type {typeof theme} */ ): { [key: string]: string } {
const newObj = {}; const newObj: { [key: string]: string } = {};
for (const key in theme) { for (const key in theme) {
if (exclude.includes(key)) continue; if (exclude.includes(key)) continue;
newObj[key] = theme[key]; newObj[key] = theme[key]!;
} }
return newObj; return newObj;
} }
module.exports = { export default {
darkMode: ["class", '[data-theme="dark"]'], plugins: [typography, daisyui],
daisyui: { daisyui: {
base: false,
themes: [ themes: [
{ {
light: { light: {
@ -28,6 +30,7 @@ module.exports = {
"accent-content", "accent-content",
]), ]),
primary: "#ea5252", primary: "#ea5252",
"primary-content": "#ffffff",
secondary: "#ef9fbc", secondary: "#ef9fbc",
accent: "#65c3c8", accent: "#65c3c8",
}, },
@ -40,10 +43,13 @@ module.exports = {
"accent-content", "accent-content",
]), ]),
primary: "#ea5252", primary: "#ea5252",
"primary-content": "#ffffff",
secondary: "#ef9fbc", secondary: "#ef9fbc",
accent: "#65c3c8", accent: "#65c3c8",
}, },
}, },
], ],
darkTheme: false,
}, },
darkMode: ["class", '[data-theme="dark"]'],
}; };

View File

@ -1,36 +1,42 @@
{ {
// This file is not used in compilation. It is here just for a nice editor experience. // This file is not used in compilation. It is here just for a nice editor experience.
"extends": "@tsconfig/docusaurus/tsconfig.json", "extends": "@nullbot/docusaurus-tsconfig",
"compilerOptions": { "compilerOptions": {
"lib": ["DOM", "ESNext"],
"baseUrl": ".", "baseUrl": ".",
"types": [
"node",
"@docusaurus/module-type-aliases",
"@nullbot/docusaurus-theme-nonepress"
],
"paths": { "paths": {
"@/*": ["./src/*"], "@/*": ["./src/*"],
"@theme/*": ["./src/theme/*"] "@theme/*": ["./src/theme/*"]
}, },
/* Strict Type-Checking Options */
"strict": true,
"strictNullChecks": true,
"strictFunctionTypes": true,
"strictBindCallApply": true,
"strictPropertyInitialization": true,
"noImplicitThis": true,
"alwaysStrict": true,
/* Disabled on purpose (handled by ESLint, should not block compilation) */
"noUnusedParameters": false,
/* Advanced Options */
"resolveJsonModule": true, "resolveJsonModule": true,
"skipLibCheck": true, // @types/webpack and webpack/types.d.ts are not the same thing "allowArbitraryExtensions": true,
/* Use tslib */ // Duplicated from the root config, because TS does not support extending
"importHelpers": true, // multiple configs and we want to dogfood the @docusaurus/tsconfig one
"noEmitHelpers": true "allowUnreachableCode": false,
"exactOptionalPropertyTypes": false,
"noFallthroughCasesInSwitch": true,
"noImplicitOverride": true,
"noImplicitReturns": true,
"noPropertyAccessFromIndexSignature": false,
"noUncheckedIndexedAccess": true,
"strict": true,
"alwaysStrict": true,
"noImplicitAny": true,
"noImplicitThis": true,
"strictBindCallApply": true,
"strictFunctionTypes": true,
"strictNullChecks": true,
"strictPropertyInitialization": true,
"useUnknownInCatchVariables": true,
"noUnusedLocals": false,
"noUnusedParameters": false,
"importsNotUsedAsValues": "remove",
// This is important. We run `yarn tsc` in website so we can catch issues
// with our declaration files (mostly names that are forgotten to be
// imported, invalid semantics...). Because we don't have end-to-end type
// tests, removing this would make things much harder to catch.
"skipLibCheck": false
} }
} }

View File

@ -9,7 +9,7 @@ description: nonebot.consts 模块
## _var_ `RECEIVE_KEY` {#RECEIVE-KEY} ## _var_ `RECEIVE_KEY` {#RECEIVE-KEY}
- **类型:** Literal['\_receive\_{id}'] - **类型:** Literal['\_receive\_\{id\}']
- **说明:** `receive` 存储 key - **说明:** `receive` 存储 key
@ -21,7 +21,7 @@ description: nonebot.consts 模块
## _var_ `ARG_KEY` {#ARG-KEY} ## _var_ `ARG_KEY` {#ARG-KEY}
- **类型:** Literal['{key}'] - **类型:** Literal['\{key\}']
- **说明:** `arg` 存储 key - **说明:** `arg` 存储 key

View File

@ -166,7 +166,7 @@ COMMON_CONFIG=common config # 这个配置项在任何环境中都会被加载
在生产环境中,可以通过设置环境变量 `ENVIRONMENT=prod` 来确保 NoneBot 读取正确的环境配置。 在生产环境中,可以通过设置环境变量 `ENVIRONMENT=prod` 来确保 NoneBot 读取正确的环境配置。
::: :::
#### .env.{ENVIRONMENT} 文件 #### .env.\{ENVIRONMENT\} 文件
`.env.{ENVIRONMENT}` 文件类似于预设,可以让我们在多套不同的配置方案中灵活切换,默认 NoneBot 会读取 `.env.prod` 配置。如果你使用了 `nb-cli` 创建 `simple` 项目,那么将含有两套预设配置:`.env.dev` 和 `.env.prod`。 `.env.{ENVIRONMENT}` 文件类似于预设,可以让我们在多套不同的配置方案中灵活切换,默认 NoneBot 会读取 `.env.prod` 配置。如果你使用了 `nb-cli` 创建 `simple` 项目,那么将含有两套预设配置:`.env.dev` 和 `.env.prod`。

View File

@ -71,14 +71,14 @@ alc = Alconna(".rd{roll:int}")
assert alc.parse(".rd123").header["roll"] == 123 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;.+)" - `"{foo}"``"(?P&lt;foo&gt;.+)"`
- "{:\d+}" ⇔ "(\d+)" - `"{:\d+}"``"(\d+)"`
- "{foo:int}" ⇔ "(?P&lt;foo&gt;\d+)",其中 "int" 部分若能转为 `BasePattern` 则读取里面的表达式 - `"{foo:int}"``"(?P&lt;foo&gt;\d+)"`,其中 `"int"` 部分若能转为 `BasePattern` 则读取里面的表达式
## 参数声明(Args) ## 参数声明(Args)
@ -321,7 +321,7 @@ opt2 = Option("--foo", default=OptionResult(value=False, args={"bar": 1}))
- `keep_crlf`: 命令解析时是否保留换行字符 - `keep_crlf`: 命令解析时是否保留换行字符
- `compact`: 命令是否允许第一个参数紧随头部 - `compact`: 命令是否允许第一个参数紧随头部
- `strict`: 命令是否严格匹配,若为 False 则未知参数将作为名为 $extra 的参数 - `strict`: 命令是否严格匹配,若为 False 则未知参数将作为名为 $extra 的参数
- `context_style`: 命令上下文插值的风格None 为关闭bracket 为 {...}parentheses 为 $(...) - `context_style`: 命令上下文插值的风格None 为关闭bracket 为 `{...}`parentheses 为 `$(...)`
- `extra`: 命令的自定义额外信息 - `extra`: 命令的自定义额外信息
元数据一定使用 `meta=...` 形式传入: 元数据一定使用 `meta=...` 形式传入:

View File

@ -96,7 +96,7 @@ class Other(Segment):
``` ```
:::tips :::tip
或许你注意到了 `Segment` 上有一个 `children` 属性。 或许你注意到了 `Segment` 上有一个 `children` 属性。
@ -291,7 +291,7 @@ msg.extend([Text("text")])
这里额外说明 `UniMessage.template` 的拓展控制符 这里额外说明 `UniMessage.template` 的拓展控制符
相比 `Message`UniMessage 对于 {:XXX} 做了另一类拓展。其能够识别例如 At(xxx, yyy) 或 Emoji(aaa, bbb)的字符串并执行 相比 `Message`UniMessage 对于 `{:XXX}` 做了另一类拓展。其能够识别例如 At(xxx, yyy) 或 Emoji(aaa, bbb)的字符串并执行
以 At(...) 为例: 以 At(...) 为例:
@ -305,7 +305,7 @@ UniMessage(At("user", "123"))
UniMessage(At("user", "123")) UniMessage(At("user", "123"))
``` ```
而在 `AlconnaMatcher` 中,{:XXX} 更进一步地提供了获取 `event` 和 `bot` 中的属性的功能: 而在 `AlconnaMatcher` 中,`{:XXX}` 更进一步地提供了获取 `event` 和 `bot` 中的属性的功能:
```python title=在AlconnaMatcher中使用通用消息段的拓展控制符 ```python title=在AlconnaMatcher中使用通用消息段的拓展控制符
from arclet.alconna import Alconna, Args from arclet.alconna import Alconna, Args

View File

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

View File

@ -1,13 +1,15 @@
--- ---
sidebar_position: 1 sidebar_position: 1
description: 开源之夏 - 暑期 2022 description: 开源之夏 - 暑期 2022
mdx:
format: md
--- ---
# 暑期 2022 # 暑期 2022
**开源之夏 - 暑期 2022** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of CodeGSoC旨在鼓励在校学生积极参与开源软件的开发维护促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式请查看该活动的 [官网](https://summer-ospp.ac.cn/) 和 [帮助文档](https://summer-ospp.ac.cn/help/)。 **开源之夏 - 暑期 2022** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of CodeGSoC旨在鼓励在校学生积极参与开源软件的开发维护促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式请查看该活动的 [官网](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 交互体验升级 ## NoneBot2 命令行 CLI 交互体验升级

View File

@ -1,13 +1,15 @@
--- ---
sidebar_position: 2 sidebar_position: 2
description: 开源之夏 - 暑期 2023 description: 开源之夏 - 暑期 2023
mdx:
format: md
--- ---
# 暑期 2023 # 暑期 2023
**开源之夏 - 暑期 2023** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of CodeGSoC旨在鼓励在校学生积极参与开源软件的开发维护促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式请查看该活动的 [官网](https://summer-ospp.ac.cn/) 和 [帮助文档](https://summer-ospp.ac.cn/help/)。 **开源之夏 - 暑期 2023** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of CodeGSoC旨在鼓励在校学生积极参与开源软件的开发维护促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式请查看该活动的 [官网](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 项目管理图形化面板 ## NoneBot 项目管理图形化面板

View File

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

View File

@ -9,7 +9,7 @@ description: nonebot.consts 模块
## _var_ `RECEIVE_KEY` {#RECEIVE-KEY} ## _var_ `RECEIVE_KEY` {#RECEIVE-KEY}
- **类型:** Literal['\_receive\_{id}'] - **类型:** Literal['\_receive\_\{id\}']
- **说明:** `receive` 存储 key - **说明:** `receive` 存储 key
@ -21,7 +21,7 @@ description: nonebot.consts 模块
## _var_ `ARG_KEY` {#ARG-KEY} ## _var_ `ARG_KEY` {#ARG-KEY}
- **类型:** Literal['{key}'] - **类型:** Literal['\{key\}']
- **说明:** `arg` 存储 key - **说明:** `arg` 存储 key

View File

@ -166,7 +166,7 @@ COMMON_CONFIG=common config # 这个配置项在任何环境中都会被加载
在生产环境中,可以通过设置环境变量 `ENVIRONMENT=prod` 来确保 NoneBot 读取正确的环境配置。 在生产环境中,可以通过设置环境变量 `ENVIRONMENT=prod` 来确保 NoneBot 读取正确的环境配置。
::: :::
#### .env.{ENVIRONMENT} 文件 #### .env.\{ENVIRONMENT\} 文件
`.env.{ENVIRONMENT}` 文件类似于预设,可以让我们在多套不同的配置方案中灵活切换,默认 NoneBot 会读取 `.env.prod` 配置。如果你使用了 `nb-cli` 创建 `simple` 项目,那么将含有两套预设配置:`.env.dev` 和 `.env.prod`。 `.env.{ENVIRONMENT}` 文件类似于预设,可以让我们在多套不同的配置方案中灵活切换,默认 NoneBot 会读取 `.env.prod` 配置。如果你使用了 `nb-cli` 创建 `simple` 项目,那么将含有两套预设配置:`.env.dev` 和 `.env.prod`。

View File

@ -71,14 +71,14 @@ alc = Alconna(".rd{roll:int}")
assert alc.parse(".rd123").header["roll"] == 123 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;.+)" - `"{foo}"``"(?P&lt;foo&gt;.+)"`
- "{:\d+}" ⇔ "(\d+)" - `"{:\d+}"``"(\d+)"`
- "{foo:int}" ⇔ "(?P&lt;foo&gt;\d+)",其中 "int" 部分若能转为 `BasePattern` 则读取里面的表达式 - `"{foo:int}"``"(?P&lt;foo&gt;\d+)"`,其中 `"int"` 部分若能转为 `BasePattern` 则读取里面的表达式
## 参数声明(Args) ## 参数声明(Args)
@ -321,7 +321,7 @@ opt2 = Option("--foo", default=OptionResult(value=False, args={"bar": 1}))
- `keep_crlf`: 命令解析时是否保留换行字符 - `keep_crlf`: 命令解析时是否保留换行字符
- `compact`: 命令是否允许第一个参数紧随头部 - `compact`: 命令是否允许第一个参数紧随头部
- `strict`: 命令是否严格匹配,若为 False 则未知参数将作为名为 $extra 的参数 - `strict`: 命令是否严格匹配,若为 False 则未知参数将作为名为 $extra 的参数
- `context_style`: 命令上下文插值的风格None 为关闭bracket 为 {...}parentheses 为 $(...) - `context_style`: 命令上下文插值的风格None 为关闭bracket 为 `{...}`parentheses 为 `$(...)`
- `extra`: 命令的自定义额外信息 - `extra`: 命令的自定义额外信息
元数据一定使用 `meta=...` 形式传入: 元数据一定使用 `meta=...` 形式传入:

View File

@ -96,7 +96,7 @@ class Other(Segment):
``` ```
:::tips :::tip
或许你注意到了 `Segment` 上有一个 `children` 属性。 或许你注意到了 `Segment` 上有一个 `children` 属性。
@ -291,7 +291,7 @@ msg.extend([Text("text")])
这里额外说明 `UniMessage.template` 的拓展控制符 这里额外说明 `UniMessage.template` 的拓展控制符
相比 `Message`UniMessage 对于 {:XXX} 做了另一类拓展。其能够识别例如 At(xxx, yyy) 或 Emoji(aaa, bbb)的字符串并执行 相比 `Message`UniMessage 对于 `{:XXX}` 做了另一类拓展。其能够识别例如 At(xxx, yyy) 或 Emoji(aaa, bbb)的字符串并执行
以 At(...) 为例: 以 At(...) 为例:
@ -305,7 +305,7 @@ UniMessage(At("user", "123"))
UniMessage(At("user", "123")) UniMessage(At("user", "123"))
``` ```
而在 `AlconnaMatcher` 中,{:XXX} 更进一步地提供了获取 `event` 和 `bot` 中的属性的功能: 而在 `AlconnaMatcher` 中,`{:XXX}` 更进一步地提供了获取 `event` 和 `bot` 中的属性的功能:
```python title=在AlconnaMatcher中使用通用消息段的拓展控制符 ```python title=在AlconnaMatcher中使用通用消息段的拓展控制符
from arclet.alconna import Alconna, Args from arclet.alconna import Alconna, Args

View File

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

View File

@ -1,13 +1,15 @@
--- ---
sidebar_position: 1 sidebar_position: 1
description: 开源之夏 - 暑期 2022 description: 开源之夏 - 暑期 2022
mdx:
format: md
--- ---
# 暑期 2022 # 暑期 2022
**开源之夏 - 暑期 2022** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of CodeGSoC旨在鼓励在校学生积极参与开源软件的开发维护促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式请查看该活动的 [官网](https://summer-ospp.ac.cn/) 和 [帮助文档](https://summer-ospp.ac.cn/help/)。 **开源之夏 - 暑期 2022** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of CodeGSoC旨在鼓励在校学生积极参与开源软件的开发维护促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式请查看该活动的 [官网](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 交互体验升级 ## NoneBot2 命令行 CLI 交互体验升级

View File

@ -1,13 +1,15 @@
--- ---
sidebar_position: 2 sidebar_position: 2
description: 开源之夏 - 暑期 2023 description: 开源之夏 - 暑期 2023
mdx:
format: md
--- ---
# 暑期 2023 # 暑期 2023
**开源之夏 - 暑期 2023** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of CodeGSoC旨在鼓励在校学生积极参与开源软件的开发维护促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式请查看该活动的 [官网](https://summer-ospp.ac.cn/) 和 [帮助文档](https://summer-ospp.ac.cn/help/)。 **开源之夏 - 暑期 2023** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of CodeGSoC旨在鼓励在校学生积极参与开源软件的开发维护促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式请查看该活动的 [官网](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 项目管理图形化面板 ## NoneBot 项目管理图形化面板

View File

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

View File

@ -9,7 +9,7 @@ description: nonebot.consts 模块
## _var_ `RECEIVE_KEY` {#RECEIVE-KEY} ## _var_ `RECEIVE_KEY` {#RECEIVE-KEY}
- **类型:** Literal['\_receive\_{id}'] - **类型:** Literal['\_receive\_\{id\}']
- **说明:** `receive` 存储 key - **说明:** `receive` 存储 key
@ -21,7 +21,7 @@ description: nonebot.consts 模块
## _var_ `ARG_KEY` {#ARG-KEY} ## _var_ `ARG_KEY` {#ARG-KEY}
- **类型:** Literal['{key}'] - **类型:** Literal['\{key\}']
- **说明:** `arg` 存储 key - **说明:** `arg` 存储 key

View File

@ -166,7 +166,7 @@ COMMON_CONFIG=common config # 这个配置项在任何环境中都会被加载
在生产环境中,可以通过设置环境变量 `ENVIRONMENT=prod` 来确保 NoneBot 读取正确的环境配置。 在生产环境中,可以通过设置环境变量 `ENVIRONMENT=prod` 来确保 NoneBot 读取正确的环境配置。
::: :::
#### .env.{ENVIRONMENT} 文件 #### .env.\{ENVIRONMENT\} 文件
`.env.{ENVIRONMENT}` 文件类似于预设,可以让我们在多套不同的配置方案中灵活切换,默认 NoneBot 会读取 `.env.prod` 配置。如果你使用了 `nb-cli` 创建 `simple` 项目,那么将含有两套预设配置:`.env.dev` 和 `.env.prod`。 `.env.{ENVIRONMENT}` 文件类似于预设,可以让我们在多套不同的配置方案中灵活切换,默认 NoneBot 会读取 `.env.prod` 配置。如果你使用了 `nb-cli` 创建 `simple` 项目,那么将含有两套预设配置:`.env.dev` 和 `.env.prod`。

View File

@ -71,14 +71,14 @@ alc = Alconna(".rd{roll:int}")
assert alc.parse(".rd123").header["roll"] == 123 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;.+)" - `"{foo}"``"(?P&lt;foo&gt;.+)"`
- "{:\d+}" ⇔ "(\d+)" - `"{:\d+}"``"(\d+)"`
- "{foo:int}" ⇔ "(?P&lt;foo&gt;\d+)",其中 "int" 部分若能转为 `BasePattern` 则读取里面的表达式 - `"{foo:int}"``"(?P&lt;foo&gt;\d+)"`,其中 `"int"` 部分若能转为 `BasePattern` 则读取里面的表达式
## 参数声明(Args) ## 参数声明(Args)
@ -321,7 +321,7 @@ opt2 = Option("--foo", default=OptionResult(value=False, args={"bar": 1}))
- `keep_crlf`: 命令解析时是否保留换行字符 - `keep_crlf`: 命令解析时是否保留换行字符
- `compact`: 命令是否允许第一个参数紧随头部 - `compact`: 命令是否允许第一个参数紧随头部
- `strict`: 命令是否严格匹配,若为 False 则未知参数将作为名为 $extra 的参数 - `strict`: 命令是否严格匹配,若为 False 则未知参数将作为名为 $extra 的参数
- `context_style`: 命令上下文插值的风格None 为关闭bracket 为 {...}parentheses 为 $(...) - `context_style`: 命令上下文插值的风格None 为关闭bracket 为 `{...}`parentheses 为 `$(...)`
- `extra`: 命令的自定义额外信息 - `extra`: 命令的自定义额外信息
元数据一定使用 `meta=...` 形式传入: 元数据一定使用 `meta=...` 形式传入:

View File

@ -96,7 +96,7 @@ class Other(Segment):
``` ```
:::tips :::tip
或许你注意到了 `Segment` 上有一个 `children` 属性。 或许你注意到了 `Segment` 上有一个 `children` 属性。
@ -291,7 +291,7 @@ msg.extend([Text("text")])
这里额外说明 `UniMessage.template` 的拓展控制符 这里额外说明 `UniMessage.template` 的拓展控制符
相比 `Message`UniMessage 对于 {:XXX} 做了另一类拓展。其能够识别例如 At(xxx, yyy) 或 Emoji(aaa, bbb)的字符串并执行 相比 `Message`UniMessage 对于 `{:XXX}` 做了另一类拓展。其能够识别例如 At(xxx, yyy) 或 Emoji(aaa, bbb)的字符串并执行
以 At(...) 为例: 以 At(...) 为例:
@ -305,7 +305,7 @@ UniMessage(At("user", "123"))
UniMessage(At("user", "123")) UniMessage(At("user", "123"))
``` ```
而在 `AlconnaMatcher` 中,{:XXX} 更进一步地提供了获取 `event` 和 `bot` 中的属性的功能: 而在 `AlconnaMatcher` 中,`{:XXX}` 更进一步地提供了获取 `event` 和 `bot` 中的属性的功能:
```python title=在AlconnaMatcher中使用通用消息段的拓展控制符 ```python title=在AlconnaMatcher中使用通用消息段的拓展控制符
from arclet.alconna import Alconna, Args from arclet.alconna import Alconna, Args

View File

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

View File

@ -1,13 +1,15 @@
--- ---
sidebar_position: 1 sidebar_position: 1
description: 开源之夏 - 暑期 2022 description: 开源之夏 - 暑期 2022
mdx:
format: md
--- ---
# 暑期 2022 # 暑期 2022
**开源之夏 - 暑期 2022** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of CodeGSoC旨在鼓励在校学生积极参与开源软件的开发维护促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式请查看该活动的 [官网](https://summer-ospp.ac.cn/) 和 [帮助文档](https://summer-ospp.ac.cn/help/)。 **开源之夏 - 暑期 2022** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of CodeGSoC旨在鼓励在校学生积极参与开源软件的开发维护促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式请查看该活动的 [官网](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 交互体验升级 ## NoneBot2 命令行 CLI 交互体验升级

View File

@ -1,13 +1,15 @@
--- ---
sidebar_position: 2 sidebar_position: 2
description: 开源之夏 - 暑期 2023 description: 开源之夏 - 暑期 2023
mdx:
format: md
--- ---
# 暑期 2023 # 暑期 2023
**开源之夏 - 暑期 2023** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of CodeGSoC旨在鼓励在校学生积极参与开源软件的开发维护促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式请查看该活动的 [官网](https://summer-ospp.ac.cn/) 和 [帮助文档](https://summer-ospp.ac.cn/help/)。 **开源之夏 - 暑期 2023** 是由**开源软件供应链点亮计划**发起、由**中国科学院软件研究所**与 **openEuler 社区**主办的一项面向高校学生的暑期活动,类似 Google Summer of CodeGSoC旨在鼓励在校学生积极参与开源软件的开发维护促进优秀开源软件社区的蓬勃发展。关于具体的活动规划、报名方式请查看该活动的 [官网](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 项目管理图形化面板 ## NoneBot 项目管理图形化面板

View File

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

View File

@ -123,5 +123,35 @@
} }
] ]
} }
],
"changelog": [
{
"type": "category",
"label": "更新日志",
"collapsible": false,
"items": [
{
"type": "link",
"label": "最近更新",
"href": "/changelog/"
},
{
"type": "link",
"label": "v2.1.0",
"href": "/changelog/v2.1.0"
},
{
"type": "link",
"label": "v2.0.0-beta.2",
"href": "/changelog/v2.0.0-beta.2"
},
{
"type": "link",
"label": "v2.0.0a7",
"href": "/changelog/v2.0.0a7"
}
],
"collapsed": false
}
] ]
} }

9766
yarn.lock

File diff suppressed because it is too large Load Diff