🔀 Merge pull request #187

Pre Release 2.0.0a9

Author: yanyongyu

.github/workflows/build_docs.yml

@@ -19,10 +19,17 @@ jobs:
           python-version: 3.8
           architecture: "x64"
 
-      - name: Install Dependences
+      - uses: Gr1N/setup-poetry@v4
+
+      - uses: actions/cache@v1
+        with:
+          path: ~/.cache/pypoetry/virtualenvs
+          key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-poetry-
+
+      - name: Set up dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install poetry
           poetry install
 
       - name: Build Doc

README.md

@@ -21,6 +21,9 @@ _✨ Python 异步机器人框架 ✨_
   <a href="https://github.com/howmanybots/onebot/blob/master/README.md">
     <img src="https://img.shields.io/badge/OneBot-v11-black?style=social&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABABAMAAABYR2ztAAAAIVBMVEUAAAAAAAADAwMHBwceHh4UFBQNDQ0ZGRkoKCgvLy8iIiLWSdWYAAAAAXRSTlMAQObYZgAAAQVJREFUSMftlM0RgjAQhV+0ATYK6i1Xb+iMd0qgBEqgBEuwBOxU2QDKsjvojQPvkJ/ZL5sXkgWrFirK4MibYUdE3OR2nEpuKz1/q8CdNxNQgthZCXYVLjyoDQftaKuniHHWRnPh2GCUetR2/9HsMAXyUT4/3UHwtQT2AggSCGKeSAsFnxBIOuAggdh3AKTL7pDuCyABcMb0aQP7aM4AnAbc/wHwA5D2wDHTTe56gIIOUA/4YYV2e1sg713PXdZJAuncdZMAGkAukU9OAn40O849+0ornPwT93rphWF0mgAbauUrEOthlX8Zu7P5A6kZyKCJy75hhw1Mgr9RAUvX7A3csGqZegEdniCx30c3agAAAABJRU5ErkJggg==" alt="cqhttp">
   </a>
+  <a href="http://github.com/mamoe/mirai">
+    <img src="https://img.shields.io/badge/mirai-HTTP-lightgrey?style=social">
+  </a>
   <a href="https://ding-doc.dingtalk.com/document#/org-dev-guide/elzz1p">
     <img src="https://img.shields.io/badge/%E9%92%89%E9%92%89-Bot-lightgrey?style=social&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAAAnFBMVEUAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD4jUzeAAAAM3RSTlMAQKSRaA+/f0YyFevh29R3cyklIfrlyrGsn41tVUs48c/HqJm9uZdhX1otGwkF9IN8V1CX0Q+IAAABY0lEQVRYw+3V2W7CMBAF0JuNQAhhX9OEfYdu9///rUVWpagE27Ef2gfO+0zGozsKnv6bMGzAhkNytIe5gDdzrwtTCwrbI8x4/NF668NAxgI3Q3UtFi3TyPwNQtPLUUmDd8YfqGLNe4v22XwEYb5zoOuF5baHq2UHtsKe5ivWfGAwrWu2mC34QM0PoCAuqZdOmiwV+5BLyMRtZ7dTSEcs48rzWfzwptMLyzpApka1SJ5FtR4kfCqNIBPEVDmqoqgwUYY5plQOlf6UEjNoOPnuKB6wzDyCrks///TDza8+PnR109WQdxLo8RKWq0PPnuXG0OXKQ6wWLFnCg75uYYbhmMIVVdQ709q33aHbGIj6Duz+2k1HQFX9VwqmY8xYsEJll2ahvhWgsjYLHFRXvIi2Qb0jzMQCzC3FAoydxCma88UCzE3JCWwkjCNYyMUCzHX4DiuTMawEwwhW6hnshPhjZzzJfAH0YacpbmRd7QAAAABJRU5ErkJggg==" alt="ding">
   </a>
@@ -71,6 +74,7 @@ NoneBot2 的驱动框架 `Driver` 以及通信协议 `Adapter` 均可**自定义
 目前 NoneBot2 内置的协议适配：
 
 - [OneBot(CQHTTP) 协议](https://github.com/howmanybots/onebot/blob/master/README.md) (QQ 等)
+- [Mirai-API-HTTP 协议](https://github.com/project-mirai/mirai-api-http)
 - [钉钉](https://ding-doc.dingtalk.com/document#/org-dev-guide/elzz1p) _开发中_
 - [Telegram](https://core.telegram.org/bots/api) _计划中_
 
@@ -110,3 +114,9 @@ NoneBot2 的驱动框架 `Driver` 以及通信协议 `Adapter` 均可**自定义
 如果你在使用过程中发现任何问题，可以 [提交 issue](https://github.com/nonebot/nonebot2/issues/new) 或自行 fork 修改后提交 pull request。
 
 如果你要提交 pull request，请确保你的代码风格和项目已有的代码保持一致，遵循 [PEP 8](https://www.python.org/dev/peps/pep-0008/)，变量命名清晰，有适当的注释。
+
+## 许可证
+
+`NoneBot` 采用 `MIT` 协议开源，协议文件参考 [LICENSE](./LICENSE)。
+
+特别的，由于 `mirai` 使用 `AGPLv3` 协议并要求使用 `mirai` 的软件同样以 `AGPLv3` 协议开源，本项目 `mirai` 适配器部分（即 [`nonebot/adapters/mirai/`](./nonebot/adapters/mirai/) 目录）以 `AGPLv3` 协议开源，协议文件参考 [LICENSE](./nonebot/adapters/mirai/LICENSE)。

archive/2.0.0a8.post2/advanced/scheduler.md

@@ -96,10 +96,14 @@ scheduler = require('nonebot_plugin_apscheduler').scheduler
 
 对于大多数情况，我们需要在 `nonebot2` 项目被启动时启动定时任务，则此处设为 `true`
 
+### 在 `.env` 中添加
+
 ```bash
 APSCHEDULER_AUTOSTART=true
 ```
 
+### 在 `bot.py` 中添加
+
 ```python
 nonebot.init(apscheduler_autostart=True)
 ```
@@ -116,10 +120,14 @@ nonebot.init(apscheduler_autostart=True)
 
 > 官方文档在绝大多数时候能提供最准确和最具时效性的指南
 
+### 在 `.env` 中添加
+
 ```bash
 APSCHEDULER_CONFIG={"apscheduler.timezone": "Asia/Shanghai"}
 ```
 
+### 在 `bot.py` 中添加
+
 ```python
 nonebot.init(apscheduler_config={
     "apscheduler.timezone": "Asia/Shanghai"

archive/2.0.0a8.post2/guide/creating-a-matcher.md

@@ -128,7 +128,7 @@ def check(arg1, args2):
     async def _checker(bot: Bot, event: Event, state: T_State) -> bool:
         return bool(arg1 + arg2)
 
-    return Rule(_check)
+    return Rule(_checker)
 ```
 
 `Rule` 和 `RuleChecker` 之间可以使用 `与 &` 互相组合：

archive/2.0.0a9/README.md

@@ -0,0 +1,15 @@
+---
+home: true
+heroImage: /logo.png
+tagline: An asynchronous bot framework.
+actionText: 开始使用
+actionLink: guide/
+features:
+  - title: 简洁
+    details: 提供极其简洁易懂的 API，使你可以毫无压力地开始验证你的绝佳创意，只需编写最少量的代码，即可实现丰富的功能。
+  - title: 易于扩展
+    details: 精心设计的消息处理流程使得你可以很方便地将原型扩充为具有大量实用功能的完整聊天机器人，并持续保证扩展性。
+  - title: 高性能
+    details: 采用异步 I/O，利用 WebSocket 进行通信，以获得极高的性能；同时，支持使用多账号同时接入，减少业务宕机的可能。
+footer: MIT Licensed | Copyright © 2018 - 2020 NoneBot Team
+---

archive/2.0.0a9/advanced/README.md

@@ -0,0 +1,7 @@
+# 深入
+
+## 它如何工作？
+
+<!-- TODO: how to work -->
+
+~~未填坑~~

archive/2.0.0a9/advanced/export-and-require.md

@@ -0,0 +1 @@
+# 跨插件访问

archive/2.0.0a9/advanced/overloaded-handlers.md

@@ -0,0 +1 @@
+# 事件处理函数重载

archive/2.0.0a9/advanced/permission.md

@@ -0,0 +1 @@
+# 权限控制

archive/2.0.0a9/advanced/publish-plugin.md

@@ -0,0 +1 @@
+# 发布插件