Merge pull request #29 from huankong233/main

chore: docs

.markdownlint.json

@@ -0,0 +1,4 @@
+{
+ "MD024": false,
+ "MD013": false
+}

README.md

@@ -1 +1,3 @@
 # NapCat
+
+喵呜(困)

docs/.vitepress/zh-CN.ts

@@ -1,8 +1,8 @@
-import { createRequire } from 'module'
+// import { createRequire } from 'module'
 import { defineConfig } from 'vitepress'
 
-const require = createRequire(import.meta.url)
-const pkg = require('vitepress/package.json')
+// const require = createRequire(import.meta.url)
+// const pkg = require('vitepress/package.json')
 
 export const zhCN = defineConfig({
  lang: 'zh-CN',
@@ -49,46 +49,49 @@ export const zhCN = defineConfig({
 
 function nav() {
  return [
- { text: '使用', link: '/zh-CN/guide/getting-started', activeMatch: '/zh-CN/guide' },
- { text: '开发', link: '/zh-CN/develop/api', activeMatch: '/zh-CN/develop' }
+ { text: '使用', link: '/zh-CN/guide/getting-started' },
+ { text: '开发', link: '/zh-CN/develop/compatibility/api' }
  ]
 }
+
 function sidebarGuide() {
  return [
- { text: '快速开始', link: 'guide/getting-started', activeMatch: '/zh-CN/guide/' },
+ { text: '快速开始', link: 'guide/getting-started' },
  {
  text: '配置',
  items: [
- { text: '基础配置', link: 'guide/config/basic', activeMatch: '/zh-CN/guide/' },
- { text: '进阶配置', link: 'guide/config/advanced', activeMatch: '/zh-CN/guide/' },
+ { text: '基础配置', link: '/guide/config/basic' },
+ { text: '进阶配置', link: '/guide/config/advanced' },
+ { text: 'ffmpeg配置', link: '/guide/config/ffmpeg' }
  ]
  },
- { text: '接入框架', link: 'guide/integration', activeMatch: '/zh-CN/guide/' },
- { text: '常见问题', link: 'guide/faq', activeMatch: '/zh-CN/guide/' },
- { text: '社区资源', link: 'guide/resource', activeMatch: '/zh-CN/guide/' },
- // { text: '版本日志', link: 'guide/version', activeMatch: '/zh-CN/guide/' }
+ { text: '接入框架', link: '/guide/integration' },
+ { text: '常见问题', link: '/guide/faq' },
+ { text: '社区资源', link: '/guide/resource' }
  ]
 }
 function sidebarDevelop() {
  return [
+ {
+ text: '兼容情况',
+ items: [
+ { text: '请求接口', link: 'develop/compatibility/api' },
+ { text: '上报事件', link: 'develop/compatibility/event' },
+ { text: '消息类型', link: 'develop/compatibility/msg' }
+ ]
+ },
  {
  text: '开发信息',
- collapsed: false,
  items: [
- { text: 'API List', link: 'develop/api', activeMatch: '/zh-CN/develop/' },
- { text: '上报事件', link: 'develop/event', activeMatch: '/zh-CN/develop/event' },
- { text: '消息类型', link: 'develop/msg', activeMatch: '/zh-CN/develop/msg' },
  {
  text: '扩展 API',
- link: 'develop/extends_api',
- activeMatch: '/zh-CN/develop/extends_api'
+ link: 'develop/extends_api'
  },
  {
  text: '状态列表',
- link: 'develop/status_list',
- activeMatch: '/zh-CN/develop/status_list'
+ link: 'develop/status_list'
  },
- { text: '关于项目', link: 'develop/about', activeMatch: '/zh-CN/develop/about' }
+ { text: '关于项目', link: 'develop/about' }
  ]
  }
  ]

docs/en-US/develop/api.md

@@ -6,75 +6,75 @@ NapCatQQ implements most of the [OneBot 11](https://11.onebot.dev/) and [go-cqht
 
 | Connection Method | Available |
 | ---------------------- | :-------: |
-| HTTP Interface Call | ✔ |
-| HTTP POST Event Push | ✔ |
-| HTTP POST Quick Action | ✔ |
-| Forward WS Connection | ✔ |
-| Reverse WS Connection | ✔ |
+| HTTP Interface Call | ✅ |
+| HTTP POST Event Push | ✅ |
+| HTTP POST Quick Action | ✅ |
+| Forward WS Connection | ✅ |
+| Reverse WS Connection | ✅ |
 
 ## API Support
 
 ::: details OneBot 11 API
 
 | Function | API | Available | Remarks |
 | ------------------------------ | ----------------------- | :-------: | ------------------------------ |
-| Get bot account info | get_login_info | ✔ | |
-| Send message | send_msg | ✔ | |
-| Send group message | send_group_msg | ✔ | |
-| Send private message | send_private_msg | ✔ | Does not support temp messages |
-| Get message details | get_msg | ✔ | |
-| Recall message | delete_msg | ✔ | |
-| Like | send_like | ✔ | Supports liking group members |
-| Get friend list | get_friend_list | ✔ | |
-| Handle friend requests | set_friend_add_request | ✔ | |
-| Get group list | get_group_list | ✔ | |
-| Get group info | get_group_info | ✔ | |
-| Get group member list | get_group_member_list | ✔ | |
-| Get group member info | get_group_member_info | ✔ | |
-| Get group honor info | get_group_honor_info | ✔ | |
+| Get bot account info | get_login_info | ✅ | |
+| Send message | send_msg | ✅ | |
+| Send group message | send_group_msg | ✅ | |
+| Send private message | send_private_msg | ✅ | Does not support temp messages |
+| Get message details | get_msg | ✅ | |
+| Recall message | delete_msg | ✅ | |
+| Like | send_like | ✅ | Supports liking group members |
+| Get friend list | get_friend_list | ✅ | |
+| Handle friend requests | set_friend_add_request | ✅ | |
+| Get group list | get_group_list | ✅ | |
+| Get group info | get_group_info | ✅ | |
+| Get group member list | get_group_member_list | ✅ | |
+| Get group member info | get_group_member_info | ✅ | |
+| Get group honor info | get_group_honor_info | ✅ | |
 | Set group exclusive title | set_group_special_title | ❌ | |
 | Group anonymous ban | set_group_anonymous_ban | ❌ | |
 | Toggle group anonymity | set_group_anonymous | ❌ | |
-| Handle group join requests | set_group_add_request | ✔ | |
-| Leave group | set_group_leave | ✔ | |
-| Kick group members | set_group_kick | ✔ | |
-| Group mute | set_group_ban | ✔ | |
-| Group mute all | set_group_whole_ban | ✔ | |
-| Set administrator | set_group_admin | ✔ | |
-| Set group card | set_group_card | ✔ | |
-| Set group name | set_group_name | ✔ | |
-| Get stranger info | get_stranger_info | ✔ | Can only get group member info |
-| Get version info | get_version_info | ✔ | |
-| Get status | get_status | ✔ | |
-| Check if can send image | can_send_image | ✔ | |
-| Check if can send record | can_send_record | ✔ | |
-| Get image details | get_image | ✔ | |
-| Get record file | get_record | ✔ | |
-| Get file details | get_file | ✔ | |
-| Get Cookies | get_cookies | ✔ | |
+| Handle group join requests | set_group_add_request | ✅ | |
+| Leave group | set_group_leave | ✅ | |
+| Kick group members | set_group_kick | ✅ | |
+| Group mute | set_group_ban | ✅ | |
+| Group mute all | set_group_whole_ban | ✅ | |
+| Set administrator | set_group_admin | ✅ | |
+| Set group card | set_group_card | ✅ | |
+| Set group name | set_group_name | ✅ | |
+| Get stranger info | get_stranger_info | ✅ | Can only get group member info |
+| Get version info | get_version_info | ✅ | |
+| Get status | get_status | ✅ | |
+| Check if can send image | can_send_image | ✅ | |
+| Check if can send record | can_send_record | ✅ | |
+| Get image details | get_image | ✅ | |
+| Get record file | get_record | ✅ | |
+| Get file details | get_file | ✅ | |
+| Get Cookies | get_cookies | ✅ | |
 | Get CSRF Token | get_csrf_token | ❌ | |
 | Get QQ-related API credentials | get_credentials | ❌ | |
-| Restart OneBot implementation | set_restart | ✔ | |
-| Clean cache | clean_cache | ✔ | |
+| Restart OneBot implementation | set_restart | ✅ | |
+| Clean cache | clean_cache | ✅ | |
 
 :::
 
 ::: details go-cqhttp API
 
 | API | Available |
 | ------------------------ | :-------: |
-| send_forward_msg | ✔ |
-| send_private_forward_msg | ✔ |
-| send_group_forward_msg | ✔ |
-| get_forward_msg | ✔ |
-| upload_group_file | ✔ |
-| download_file | ✔ |
-| _get_group_notice | ✔ |
-| get_essence_msg_list | ✔ |
-| _send_group_notice | ✔ |
-| _get_group_notice | ✔ |
-| get_group_system_msg | ✔ |
-| ocr_image | ✔ |
-| get_online_clients | ✔ |
+| send_forward_msg | ✅ |
+| send_private_forward_msg | ✅ |
+| send_group_forward_msg | ✅ |
+| get_forward_msg | ✅ |
+| upload_group_file | ✅ |
+| download_file | ✅ |
+| _get_group_notice | ✅ |
+| get_essence_msg_list | ✅ |
+| _send_group_notice | ✅ |
+| _get_group_notice | ✅ |
+| get_group_system_msg | ✅ |
+| ocr_image | ✅ |
+| get_online_clients | ✅ |
 
 :::

docs/en-US/develop/event.md

@@ -2,26 +2,26 @@
 
 | Event Type | Available | Note |
 | ---------------------------- | :-------: | :------------------------------------: |
-| Message | ✔ | |
-| Reaction | ✔ | |
-| Friend Message Recall | ✔ | |
-| Group Message Recall | ✔ | |
-| Friend Request | ✔ | |
-| Group Invite Request | ✔ | |
-| Group Join Request | ✔ | Requires admin permissions |
-| Management Change | ✔ | Requires admin permissions |
-| Group Member Addition | ✔ | |
-| Group Member Removal | ✔ | |
-| Group File Upload | ✔ | |
-| Group Mute | ✔ | |
-| Group Member Nickname Change | ✔ | |
-| Group Member Title Change | ✔ | |
-| Poke in Group | ✔ | ID not available will be reported as 0 |
-| Poke a Friend | ✔ | |
+| Message | ✅ | |
+| Reaction | ✅ | |
+| Friend Message Recall | ✅ | |
+| Group Message Recall | ✅ | |
+| Friend Request | ✅ | |
+| Group Invite Request | ✅ | |
+| Group Join Request | ✅ | Requires admin permissions |
+| Management Change | ✅ | Requires admin permissions |
+| Group Member Addition | ✅ | |
+| Group Member Removal | ✅ | |
+| Group File Upload | ✅ | |
+| Group Mute | ✅ | |
+| Group Member Nickname Change | ✅ | |
+| Group Member Title Change | ✅ | |
+| Poke in Group | ✅ | ID not available will be reported as 0 |
+| Poke a Friend | ✅ | |
 | Group Red Packet Luck King | ❌ | |
 | Group Member Honor Change | ❌ | |
-| Lifecycle | ✔ | Currently only ws connect available |
-| ws Heartbeat | ✔ | |
+| Lifecycle | ✅ | Currently only ws connect available |
+| ws Heartbeat | ✅ | |
 
 ## Reaction Reporting