diff --git a/README.md b/README.md index 5b670b3b..2c608d05 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,9 @@ zhamao-framework 是一个 PHP Swoole 的聊天机器人框架,兼容 OneBot 3. 还可以使用 Dockerfile 构建 Docker 容器 ## 文档 -查看文档:[https://zhamao.xin/docs-v2/](https://zhamao.xin/docs-v2/) +查看文档:[https://docs-v2.zhamao.xin/](https://docs-v2.zhamao.xin/) + +备用链接:[http://docs-v2.zhamao.me/](http://docs-v2.zhamao.me/) 自行构建文档:`mkdocs build -d distribute` diff --git a/docs/index.md b/docs/index.md index 0341512a..930d6aa4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,7 @@ # 介绍 + +> 本文档为炸毛框架 v2 版本,如需查看 v1 版本,[点我](https://docs-v1.zhamao.xin/)。 + 炸毛框架使用 PHP 编写,采用 Swoole 扩展为基础,主要面向 API 服务,聊天机器人(CQHTTP 对接),包含 websocket、http 等监听和请求库,用户代码采用模块化处理,使用注解可以方便地编写各类功能。 框架主要用途为 HTTP 服务器,机器人搭建框架。尤其对于 QQ 机器人消息处理较为方便和全面,提供了众多会话机制和内部调用机制,可以以各种方式设计你自己的模块。 @@ -35,6 +38,10 @@ public function index() { 需要值得注意的是,本教程中所涉及的内容均为尽可能翻译为白话的方式进行描述,但对于框架的组件或事件等需要单独拆分说明文档的部分则需要足够详细,所以本教程提供一个快速上手的教程,并且会将最典型的安装方式写到快速教程篇。 +!!! bug "文档提示" + + 此文档采用 MkDocs 驱动,但因为本文档的搜索组件原生不支持中文搜索,所以搜索体验会大打折扣,敬请谅解!搜不到不是没这个东西哦! + ## 框架特色 - 支持MySQL数据库(连接池),自带查询缓存提高多查询时的效率