summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/.nojekyll0
-rw-r--r--docs/_404.md5
-rw-r--r--docs/_navbar.md5
-rw-r--r--docs/_sidebar.md1
-rw-r--r--docs/index.html37
-rw-r--r--docs/index.md16
-rw-r--r--docs/modules/index.md23
-rw-r--r--docs/modules/plugin_admin.md96
-rw-r--r--docs/modules/plugin_anime.md0
-rw-r--r--docs/modules/plugin_chat.md0
-rw-r--r--docs/modules/plugin_pixiv.md0
-rw-r--r--docs/modules/plugin_rich.md0
-rw-r--r--docs/modules/plugin_sqlite.md0
-rw-r--r--docs/modules/plugin_status.md0
-rw-r--r--docs/modules/plugin_test.md0
-rw-r--r--docs/modules/plugin_utils.md0
-rw-r--r--docs/start.md38
17 files changed, 0 insertions, 221 deletions
diff --git a/docs/.nojekyll b/docs/.nojekyll
deleted file mode 100644
index e69de29..0000000
--- a/docs/.nojekyll
+++ /dev/null
diff --git a/docs/_404.md b/docs/_404.md
deleted file mode 100644
index 920a751..0000000
--- a/docs/_404.md
+++ /dev/null
@@ -1,5 +0,0 @@
-# 404 Not found
-
-诶呀!页面走丢了...
-
-或许是姿势不对?换个姿势试试! \ No newline at end of file
diff --git a/docs/_navbar.md b/docs/_navbar.md
deleted file mode 100644
index a8b4f76..0000000
--- a/docs/_navbar.md
+++ /dev/null
@@ -1,5 +0,0 @@
-* [交流](https://jq.qq.com/?_wv=1027&k=lpLvcfzh)
-
-* [GitHub](https://github.com/Kyomotoi/ATRI)
-
-* [更新日志](https://github.com/Kyomotoi/ATRI/blob/YHN-00B-XXX/changelog.md) \ No newline at end of file
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
deleted file mode 100644
index 1debb78..0000000
--- a/docs/_sidebar.md
+++ /dev/null
@@ -1 +0,0 @@
-* [一切的开始](start.md)
diff --git a/docs/index.html b/docs/index.html
deleted file mode 100644
index 23dd8a5..0000000
--- a/docs/index.html
+++ /dev/null
@@ -1,37 +0,0 @@
-<!DOCTYPE html>
-<html lang="zh">
-<head>
- <meta charset="UTF-8">
- <title>ATRI</title>
- <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
- <meta name="description" content="Description">
- <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
- <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
-</head>
-<body>
- <div id="app">Loading...</div>
- <script>
- window.$docsify = {
- el: '#app',
- name: 'ATRI User Docs',
- maxLevel: 3,
- homepage: 'index.md',
- themeColor: ' #00BFFF',
- loadNavbar: true,
- loadSidebar: true,
- notFoundPage: true,
- search: 'auto',
- search: {
- maxAge: 86400000,
- paths: 'auto',
- placeholder: '键入开始搜索...',
- noData: '这里没有你想要的东西...',
- namespace: 'atridocs'
- }
- }
- </script>
- <!-- Docsify v4 -->
- <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
- <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
-</body>
-</html>
diff --git a/docs/index.md b/docs/index.md
deleted file mode 100644
index c90157a..0000000
--- a/docs/index.md
+++ /dev/null
@@ -1,16 +0,0 @@
-![](https://socialify.git.ci/Kyomotoi/ATRI/image?description=1&descriptionEditable=A%20project%20for%20ATRI%2C%20Usage%20go-CQHTTP%20%2B%20NoneBot2.&forks=1&issues=1&language=1&logo=https%3A%2F%2Fi.loli.net%2F2020%2F11%2F12%2FYcINCkyp8vK2inD.png&owner=1&pattern=Circuit%20Board&stargazers=1&theme=Light)
-<h2>
- <center>ATRI 使用文档</center>
-</h2>
-
-> 适用分支:YHN-00B-XXX
-
-从此开始,本文将教会如何 ~~部署~~ 和 使用 ATRI。
-
-反馈群:[567297659](https://jq.qq.com/?_wv=1027&k=WoAAYXbJ)
-
-## 引导
-
-### • [一切的开始](start.md)
-
-### • [插件列表](modules/index.md)
diff --git a/docs/modules/index.md b/docs/modules/index.md
deleted file mode 100644
index aa761c1..0000000
--- a/docs/modules/index.md
+++ /dev/null
@@ -1,23 +0,0 @@
-# 插件列表
-索引:
- - [plugin_admin](modules/plugin_admin)
- - [plugin_anime](modules/plugin_anime)
- - [plugin_chat](modules/plugin_chat)
- - [plugin_pixiv](modules/plugin_pixiv)
- - [plugin_rich](modules/plugin_rich)
- - [plugin_sqlite](modules/plugin_sqlite)
- - [plugin_status](modules/plugin_status)
- - [plugin_test](modules/plugin_test)
- - [plugin_utils](modules/plugin_utils)
-
-本项目所使用的 NoneBot 具有自带的 [插件广场](https://v2.nonebot.dev/plugin-store.html) <br>
-当然前提是你已经安装`nonebot-cil`。
-```shell
-pip install nonebot2[cli]
-poetry add nonebot2[cli]
-```
-
-如需导入第三方插件,请使用命令
-```shell
- nb plugin 插件名
-```
diff --git a/docs/modules/plugin_admin.md b/docs/modules/plugin_admin.md
deleted file mode 100644
index 162a9b5..0000000
--- a/docs/modules/plugin_admin.md
+++ /dev/null
@@ -1,96 +0,0 @@
-当前目录:插件列表 > plugin_admin
-
-!> 此插件下的所有命令普通用户无权使用
-
-### 模块控制
-
-命令:
-```shell
-/switch on/off-{service} #单独控制群聊,群管理、维护者可用
-/switch all-on/off-{service} #控制全局,仅维护者可用
-```
-
-各个可控模块名称:
-```
- plugin_anime:
- anime-pic-search #以图搜图
- anime-vid-search #以图搜番
- anime-setu #涩图
-
- plugin_chat:
- drifting-bottle #漂流瓶
-
- plugin_pixiv:
- pixiv-pic-search #p站图片搜索
- pixiv-author-search #p站作者搜索
- pixiv-rank #p站排行榜
-
- plugin_utils:
- one-key-adult #虚拟身份证
- genshin-search #原神战绩查询
-```
-
-demo:
-```shell
-/switch on-anime-setu #此处的 anime-setu 即模块名(service)。
-```
-
-### 舆情监控
-
-命令:
-```shell
-/pubopin [key] [repo] [times] [ban time(bot)] #添加监控关键词
-/pubopin del [key] #删除关键词
-/pubopin list #列出启用关键词
-```
-
-参数类型:
-```
- * key: 关键词(将使用正则匹配)
- * repo: 触发后的关键词(可选),如为图片,键入 img
- * times: 容忍次数(n>0, int)
- * ban time: bot对其失效时间(min, int)
-```
-
-demo:
-```shell
-/pubopin test testrepo 233 114514
-```
-
-### 错误堆栈追踪
-
-命令:
-```shell
-/track [trackID] #此处的 trackID 为功能在运行时发生错误所返回的错误追踪码
-```
-
-错误返回示例:
-```
- ERROR! Reason: [请求数据失败,也可能为接口调用次数达上限] #此处为大致的错误引发原因
- trackID: McZNWjbI132r5DXl #此处即为错误码返回
- 请使用[来杯红茶]功能以联系维护者
- 并附上 trackID
-```
-
-demo:
-```shell
-/track McZNWjbI132r5DXl
-```
-
-### 群发
-
-命令:
-```shell
-/groupsend [Message]
-```
-
-返回示例:
-```
- 推送信息:
- Message
- ————————
- 总共:n
- 成功推送:n
- 失败[0]个:
- #推送失败的群会在此列出
-```
diff --git a/docs/modules/plugin_anime.md b/docs/modules/plugin_anime.md
deleted file mode 100644
index e69de29..0000000
--- a/docs/modules/plugin_anime.md
+++ /dev/null
diff --git a/docs/modules/plugin_chat.md b/docs/modules/plugin_chat.md
deleted file mode 100644
index e69de29..0000000
--- a/docs/modules/plugin_chat.md
+++ /dev/null
diff --git a/docs/modules/plugin_pixiv.md b/docs/modules/plugin_pixiv.md
deleted file mode 100644
index e69de29..0000000
--- a/docs/modules/plugin_pixiv.md
+++ /dev/null
diff --git a/docs/modules/plugin_rich.md b/docs/modules/plugin_rich.md
deleted file mode 100644
index e69de29..0000000
--- a/docs/modules/plugin_rich.md
+++ /dev/null
diff --git a/docs/modules/plugin_sqlite.md b/docs/modules/plugin_sqlite.md
deleted file mode 100644
index e69de29..0000000
--- a/docs/modules/plugin_sqlite.md
+++ /dev/null
diff --git a/docs/modules/plugin_status.md b/docs/modules/plugin_status.md
deleted file mode 100644
index e69de29..0000000
--- a/docs/modules/plugin_status.md
+++ /dev/null
diff --git a/docs/modules/plugin_test.md b/docs/modules/plugin_test.md
deleted file mode 100644
index e69de29..0000000
--- a/docs/modules/plugin_test.md
+++ /dev/null
diff --git a/docs/modules/plugin_utils.md b/docs/modules/plugin_utils.md
deleted file mode 100644
index e69de29..0000000
--- a/docs/modules/plugin_utils.md
+++ /dev/null
diff --git a/docs/start.md b/docs/start.md
deleted file mode 100644
index 3a28eae..0000000
--- a/docs/start.md
+++ /dev/null
@@ -1,38 +0,0 @@
-# 前言
-!> 在阅读本文档时如碰到让您费解的专业词汇,请善用 百度/Bing/Google。
-
-!> 在运行期间出现任何错误,欢迎提交issues。如需提问,请先了[解提问的智慧](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/master/README-zh_CN.md),否则,您的提问大概率非常通常不会回复。
-
-### 关于
-本项目名称、灵感均来自 [ANIPLEX](https://aniplex-exe.com/) 发行的 [ATRI-My Dear Moments-](https://atri-mdm.com/)
-
-本项目中所使用的任何有关 ATRI 的图标、LOGO,解释权、著作权均归 ANIPLEX,由于本项目为开源项目且不收取任何费用,根据其条款,可以将其司作品进行使用。
-
-为QQ群中复现一个活灵活现的 ATRI 是本项目的目标。
-
-Owner 接触 Python 未满一年,故此项目所展示的内容可能会让您血压升高,请谅解,咱会在以后进行不间断改进。
-
-### 实现
-ATRI 可以在任何平台下运行,无论是 Windows 还是 linux 或者 iot,只要你具备基本 Python 环境和一根接入了互联网的网线,均可以运行本项目。
-
-此项目的实现方式是 `go-CQHTTP` + `NoneBot2`,以 `Python` 为主语言的项目。
-
-目前正在不断更新递代,经综合考虑后随缘打包,平时请直接拉取默认分支,如想体验最新功能,请切换项目分支至 `test`。注意,测试分支存在不确定性因素,包括:造成您电脑卡顿,同您电脑中其他正在运行的软件抢内存,造成您电脑硬盘空间爆满。如出现以上现象,请自行解决。
-
-**前身框架 CoolQ,谨此纪念 CoolQ 的停运和 “802” 事件**
-
-**“愿我们能在更开放的平行世界里相遇”**
-
-### 附加的一些介绍
-虽然现已处于正式版,功能均能正常运行,但源码就一屎山,就目前水平“能 跑 就 行”,还请各大佬高抬贵手(
-
-如对其运作效果感兴趣,请加入示例群聊:567297659
-
-### 其他
-本项目已启用爱发电,您的支持就是对项目拥有者的最大鼓励!
-
-并会将您的ID写在项目 README 特别感谢一栏!
--> https://afdian.net/@Kyomotoi
-
-### 关于开源
-本项目使用 [GPLv3](https://github.com/Kyomotoi/Aya/blob/master/LICENSE) 开源协议,这意味着您可以运行本项目,并向您的用户提供服务,但如果您需要对项目的源码仅限修改,则必须将您修改后的版本对您的用户开源。