From 20ca3e7416c82bc24dbff15e21ec3f2ef3b608f5 Mon Sep 17 00:00:00 2001 From: jerry Date: Sat, 2 Jan 2021 13:28:26 +0800 Subject: [PATCH] update docs --- docs/component/{上下文.md => context.md} | 2 +- docs/component/{CQ码.md => cqcode.md} | 0 docs/component/{机器人API.md => robot-api.md} | 0 .../{自定义注解.md => custom-annotations.md} | 0 .../{事件分发器.md => event-dispatcher.md} | 0 ...架注解事件.md => framework-annotations.md} | 0 docs/event/{中间件.md => middleware.md} | 0 ...机器人注解事件.md => robot-annotations.md} | 0 .../{路由注解事件.md => route-annotations.md} | 0 docs/guide/{基本配置.md => basic-config.md} | 0 docs/guide/{安装.md => installation.md} | 0 .../guide/{OneBot实例.md => onebot-choose.md} | 0 .../{快速上手-http.md => quickstart-http.md} | 0 ...快速上手-机器人.md => quickstart-robot.md} | 0 .../{注册事件响应.md => register-event.md} | 0 docs/guide/{编写模块.md => write-module.md} | 0 mkdocs.yml | 32 +++++++++---------- 17 files changed, 17 insertions(+), 17 deletions(-) rename docs/component/{上下文.md => context.md} (99%) rename docs/component/{CQ码.md => cqcode.md} (100%) rename docs/component/{机器人API.md => robot-api.md} (100%) rename docs/event/{自定义注解.md => custom-annotations.md} (100%) rename docs/event/{事件分发器.md => event-dispatcher.md} (100%) rename docs/event/{框架注解事件.md => framework-annotations.md} (100%) rename docs/event/{中间件.md => middleware.md} (100%) rename docs/event/{机器人注解事件.md => robot-annotations.md} (100%) rename docs/event/{路由注解事件.md => route-annotations.md} (100%) rename docs/guide/{基本配置.md => basic-config.md} (100%) rename docs/guide/{安装.md => installation.md} (100%) rename docs/guide/{OneBot实例.md => onebot-choose.md} (100%) rename docs/guide/{快速上手-http.md => quickstart-http.md} (100%) rename docs/guide/{快速上手-机器人.md => quickstart-robot.md} (100%) rename docs/guide/{注册事件响应.md => register-event.md} (100%) rename docs/guide/{编写模块.md => write-module.md} (100%) diff --git a/docs/component/上下文.md b/docs/component/context.md similarity index 99% rename from docs/component/上下文.md rename to docs/component/context.md index b00a9c96..d7b93408 100644 --- a/docs/component/上下文.md +++ b/docs/component/context.md @@ -124,7 +124,7 @@ public function ping() { ## getRobot() - 获取机器人 API 对象 -返回当前上下文关联的机器人 API 调用对象 [ZMRobot](机器人API.md)。 +返回当前上下文关联的机器人 API 调用对象 [ZMRobot](robot-api.md)。 可以使用的事件：所有 HTTP API 发来的事件：`@CQCommand()`，`@CQMessage()` 等。 diff --git a/docs/component/CQ码.md b/docs/component/cqcode.md similarity index 100% rename from docs/component/CQ码.md rename to docs/component/cqcode.md diff --git a/docs/component/机器人API.md b/docs/component/robot-api.md similarity index 100% rename from docs/component/机器人API.md rename to docs/component/robot-api.md diff --git a/docs/event/自定义注解.md b/docs/event/custom-annotations.md similarity index 100% rename from docs/event/自定义注解.md rename to docs/event/custom-annotations.md diff --git a/docs/event/事件分发器.md b/docs/event/event-dispatcher.md similarity index 100% rename from docs/event/事件分发器.md rename to docs/event/event-dispatcher.md diff --git a/docs/event/框架注解事件.md b/docs/event/framework-annotations.md similarity index 100% rename from docs/event/框架注解事件.md rename to docs/event/framework-annotations.md diff --git a/docs/event/中间件.md b/docs/event/middleware.md similarity index 100% rename from docs/event/中间件.md rename to docs/event/middleware.md diff --git a/docs/event/机器人注解事件.md b/docs/event/robot-annotations.md similarity index 100% rename from docs/event/机器人注解事件.md rename to docs/event/robot-annotations.md diff --git a/docs/event/路由注解事件.md b/docs/event/route-annotations.md similarity index 100% rename from docs/event/路由注解事件.md rename to docs/event/route-annotations.md diff --git a/docs/guide/基本配置.md b/docs/guide/basic-config.md similarity index 100% rename from docs/guide/基本配置.md rename to docs/guide/basic-config.md diff --git a/docs/guide/安装.md b/docs/guide/installation.md similarity index 100% rename from docs/guide/安装.md rename to docs/guide/installation.md diff --git a/docs/guide/OneBot实例.md b/docs/guide/onebot-choose.md similarity index 100% rename from docs/guide/OneBot实例.md rename to docs/guide/onebot-choose.md diff --git a/docs/guide/快速上手-http.md b/docs/guide/quickstart-http.md similarity index 100% rename from docs/guide/快速上手-http.md rename to docs/guide/quickstart-http.md diff --git a/docs/guide/快速上手-机器人.md b/docs/guide/quickstart-robot.md similarity index 100% rename from docs/guide/快速上手-机器人.md rename to docs/guide/quickstart-robot.md diff --git a/docs/guide/注册事件响应.md b/docs/guide/register-event.md similarity index 100% rename from docs/guide/注册事件响应.md rename to docs/guide/register-event.md diff --git a/docs/guide/编写模块.md b/docs/guide/write-module.md similarity index 100% rename from docs/guide/编写模块.md rename to docs/guide/write-module.md diff --git a/mkdocs.yml b/mkdocs.yml index 44d788fc..127705be 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -52,26 +52,26 @@ copyright: 'Copyright © 2019 - 2020 CrazyBot Team    &n nav: - 指南: - 介绍: index.md - - 安装框架: guide/安装.md - - 快速上手（机器人篇）: guide/快速上手-机器人.md - - 快速上手（HTTP篇）: guide/快速上手-http.md - - 选择聊天机器人实例: guide/OneBot实例.md - - 基本配置: guide/基本配置.md - - 编写模块: guide/编写模块.md - - 注册事件响应: guide/注册事件响应.md + - 安装框架: guide/installation.md + - 快速上手（机器人篇）: guide/quickstart-robot.md + - 快速上手（HTTP篇）: guide/quickstart-http.md + - 选择聊天机器人实例: guide/onebot-choose.md + - 基本配置: guide/basic-config.md + - 编写模块: guide/write-module.md + - 注册事件响应: guide/register-event.md - 事件和注解: - 事件和注解: event/index.md - - 机器人注解事件: event/机器人注解事件.md - - HTTP 路由注解事件: event/路由注解事件.md - - 框架核心注解事件: event/框架注解事件.md - - 中间件注解: event/中间件.md - - 自定义注解: event/自定义注解.md - - 事件分发器: event/事件分发器.md + - 机器人注解事件: event/robot-annotations.md + - HTTP 路由注解事件: event/route-annotations.md + - 框架核心注解事件: event/framework-annotations.md + - 中间件注解: event/middleware.md + - 自定义注解: event/custom-annotations.md + - 事件分发器: event/event-dispatcher.md - 框架组件: - 框架组件: component/index.md - - 机器人 API: component/机器人API.md - - CQ 码（多媒体消息）: component/CQ码.md - - 上下文: component/上下文.md + - 机器人 API: component/robot-api.md + - CQ 码（多媒体消息）: component/cqcode.md + - 上下文: component/context.md - 进阶开发: - 进阶开发: advanced/index.md - 从 v1 升级: advanced/to-v2.md