zhamao-framework/mkdocs.yml

site_name: 炸毛框架文档

repo_name: '炸毛框架'
repo_url: 'https://github.com/zhamao-robot/zhamao-framework'
edit_uri: 'blob/master/docs/'

theme:
  name: material
  logo: assets/logos.png
  favicon: assets/favicon.png
  language: zh
  palette:
    primary: indigo
    accent: indigo
  features:
    - navigation.tabs
    - navigation.sections
extra_javascript:
  - javascripts/library/highlight.min.js
  - javascripts/config.js
extra_css:
  - assets/css/extra.css
  - assets/css/library/default.min.css
plugins:
  - search:
      lang: ja
markdown_extensions:
  - admonition
  - pymdownx.tabbed
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.details
  - abbr
  - pymdownx.highlight:
      linenums: true
      linenums_style: pymdownx.inline
extra:
  version:
    provider: mike

copyright: 'Copyright &copy; 2019 - 2022 CrazyBot Team&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="tx-switch">
                 <button data-md-color-scheme="default"><code>默认模式</code></button>
                 <button data-md-color-scheme="slate"><code>暗黑模式</code></button>
               </span>

               <script>
                 var buttons = document.querySelectorAll("button[data-md-color-scheme]");
                 buttons.forEach(function(button) {
                   button.addEventListener("click", function() {
                     var attr = this.getAttribute("data-md-color-scheme");
                     setCookie("_theme", attr);
                     document.body.setAttribute("data-md-color-scheme", attr);
                     var name = document.querySelector("#__code_0 code span:nth-child(7)");
                     name.textContent = attr;
                   })
                 })
               </script><br><a href="http://beian.miit.gov.cn">沪ICP备2021010446号-1</a>'

nav:
  - 指南:
      - 介绍: index.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
      - 升级指南: guide/upgrade.md
      - 错误码对照表: guide/errcode.md
  - 事件和注解:
      - 事件和注解: event/index.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
      - 聊天机器人组件:
          - 机器人动作（V12）: component/bot/robot-api-12.md
          - 机器人动作（V11）: component/bot/robot-api.md
          - CQ 码（多媒体消息）: component/bot/cqcode.md
          - 机器人消息处理: component/bot/message-util.md
          - Token 验证: component/bot/access-token.md
          - 图灵机器人 API: component/bot/turing-api.md
      - 存储:
          - LightCache 轻量缓存: component/store/light-cache.md
          - MySQL 查询器:
              - 简介: component/store/mysql/mysql.md
              - 配置: component/store/mysql/config.md
              - 执行 SQL 语句: component/store/mysql/common-query.md
          - MySQL 查询器（废弃）: component/store/mysql-db.md
          - Redis 数据库: component/store/redis.md
          - ZMAtomic 原子计数器: component/store/atomics.md
          - SpinLock 自旋锁: component/store/spin-lock.md
          - 文件管理: component/store/data-provider.md
      - 通用组件:
          - 上下文: component/common/context.md
          - 协程池: component/common/coroutine-pool.md
          - 单例类: component/common/singleton-trait.md
          - ZMUtil 杂项: component/common/zmutil.md
          - 全局方法: component/common/global-functions.md
          - Console 终端: component/common/console.md
          - TaskWorker 管理: component/common/task-worker.md
          - Terminal 终端: component/common/remote-terminal.md
          - EventTracer 事件追踪器: component/common/event-tracer.md
      - HTTP 服务器工具类:
          - HTTP 和 WebSocket 客户端: component/http/zmrequest.md
          - HTTP 路由管理: component/http/route-manager.md
      - 模块/插件管理:
          - 模块打包: component/module/module-pack.md
          - 模块解包: component/module/module-unpack.md
  - 进阶开发:
      - 进阶开发: advanced/index.md
      - 框架高级开发:
          - 框架剖析: advanced/framework-structure.md
          - 框架启动模式: advanced/custom-start.md
          - 手动安装环境: advanced/manually-install.md
          - 内部类文件手册: advanced/inside-class.md
          - 框架多进程: advanced/multi-process.md
          - TaskWorker 提高并发: advanced/task-worker.md
      - 开发实战教程:
          - 接入 WebSocket 客户端: advanced/connect-ws-client.md
          - 编写管理员才能触发的功能: advanced/example/admin.md
          - 接入青云客聊天API: advanced/example/integrate-qingyunke-chatbot.md
          - 开发天气机器人: advanced/example/weather-bot.md
  - FAQ:
      - FAQ: faq/FAQ.md
      - 从 v1 升级: faq/to-v2.md
      - 框架常见问题（持续更新）: faq/usual-question.md
      - 启动时报错 Address already in use: faq/address-already-in-use.md
      - 出现 deadlock 字样: faq/display-deadlock.md
      - 使用 LightCache 关闭时无法正常保存持久化: faq/light-cache-wrong.md
      - CQBefore 过滤不了 waitMessage: faq/wait-message-cqbefore.md
  - 更新日志:
      - 更新日志（v2）: update/v2.md
      - 更新日志（v1）: update/v1.md
      - 更新日志（build update）: update/build-update.md
      - 配置文件更新日志: update/config.md
  - <u>炸毛框架 v1</u>: https://docs-v1.zhamao.xin/