Skip to content

Commit

Permalink
更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
ikenxuan committed Jun 14, 2024
1 parent 8f25138 commit 9ea160a
Show file tree
Hide file tree
Showing 5 changed files with 91 additions and 62 deletions.
5 changes: 2 additions & 3 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import { defineConfig } from 'vitepress'
export default defineConfig({
lang: 'zh-CN',
title: "kkkkkk-10086",
description: "A VitePress Site",
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
editLink: {
Expand All @@ -24,6 +23,7 @@ export default defineConfig({
text: '简介',
items: [
{ text: '快速开始', link: '/page/start' },
{ text: '安装插件', link: '/page/install' },
{ text: '配置文件', link: '/page/start.config' },
]
},
Expand All @@ -40,7 +40,6 @@ export default defineConfig({
{
text: '其他',
items: [
{ text: '鸣谢', link: '/page/other/thanks' },
{ text: '友情链接', link: '/page/other/Friendlylink' },
{ text: '免责声明', link: '/page/other/disclaimer' },
]
Expand All @@ -59,7 +58,7 @@ export default defineConfig({
outlineTitle: "本页目录",
footer: {
message: "Released under the MIT License",
copyright: "Copyright © 2024-present ikenxuan",
copyright: "Copyright © 2023-2024 ikenxuan",
},
docFooter: {
prev: '上一页',
Expand Down
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ layout: home

hero:
name: "kkkkkk-10086"
tagline: 视频解析插件
tagline: Yunzai-Bot 的视频解析插件
actions:
- theme: brand
text: 快速开始
Expand Down
42 changes: 42 additions & 0 deletions page/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# 快速开始

阅读本文档立刻开始使用
## 安装插件
::: tip
本插件主在 `icqq` 适配器的基础上进行开发,其他适配器/协议端适配情况未知
:::

机器人目录下打开终端执行
::: code-group
```sh [GitHub]
# (国外推荐)使用 GitHub
git clone --depth=1 https://github.com/ikenxuan/kkkkkk-10086.git ./plugins/kkkkkk-10086/
```
```sh [Gitee]
# (国内推荐)使用 Gitee
git clone --depth=1 https://gitee.com/ikenxuan/kkkkkk-10086.git ./plugins/kkkkkk-10086/
```
```sh [ghproxy]
# (国内推荐)使用 ghproxy
git clone --depth=1 https://mirror.ghproxy.com/https://github.com/ikenxuan/kkkkkk-10086.git ./plugins/kkkkkk-10086/
```
:::

## 安装依赖

移动到插件目录
```sh
cd plugins/kkkkkk-10086/
```
自选一个包管理器安装依赖
::: code-group
```sh [npm]
npm install --production
```
```sh [pnpm]
pnpm install -P
```
```sh [yarn]
yarn --production
```
:::
23 changes: 0 additions & 23 deletions page/other/thanks.md

This file was deleted.

81 changes: 46 additions & 35 deletions page/start.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,53 @@
# 快速开始

阅读本文档立刻开始使用
## 安装插件
::: tip
本插件主在 `icqq` 适配器的基础上进行开发,其他适配器/协议端适配情况未知
::: tip 编辑提示
如果文档中发现错误,或提交文档修改,或丰富本站文档,可点击下方的编辑按钮
:::

机器人目录下打开终端执行
::: code-group
```sh [GitHub]
# (国外推荐)使用 GitHub
git clone --depth=1 https://github.com/ikenxuan/kkkkkk-10086.git ./plugins/kkkkkk-10086/
```
```sh [Gitee]
# (国内推荐)使用 Gitee
git clone --depth=1 https://gitee.com/ikenxuan/kkkkkk-10086.git ./plugins/kkkkkk-10086/
```
```sh [ghproxy]
# (国内推荐)使用 ghproxy
git clone --depth=1 https://mirror.ghproxy.com/https://github.com/ikenxuan/kkkkkk-10086.git ./plugins/kkkkkk-10086/
```
:::
## 鸣谢
**业务站点**

## 安装依赖
- [www.douyin.com](https://www.douyin.com) & [www.bilibili.com](https://www.bilibili.com)

移动到插件目录
```sh
cd plugins/kkkkkk-10086/
```
自选一个包管理器安装依赖
::: code-group
```sh [npm]
npm install --production
```
```sh [pnpm]
pnpm install -P
本项目的开发参考了以下开源项目部分代码,排名不分先后

**部分代码借鉴**

- [xfdown/xiaofei-plugin](https://gitee.com/xfdown/xiaofei-plugin)
- [ikechan8370/chatgpt-plugin](https://github.com/ikechan8370/chatgpt-plugin)
- [kyrzy0416/rconsole-plugin](https://gitee.com/kyrzy0416/rconsole-plugin)
- [think-first-sxs/reset-qianyu-plugin](https://gitee.com/think-first-sxs/reset-qianyu-plugin)
- [yeyang52/yenai-plugin](https://github.com/yeyang52/yenai-plugin)
- [XasYer/Shiranai-Plugin](https://github.com/XasYer/Shiranai-Plugin)
- ...

**接口文档与加密参数算法**

- [SocialSisterYi/bilibili-API-collect](https://github.com/SocialSisterYi/bilibili-API-collect)
- [NearHuiwen/TiktokDouyinCrawler](https://github.com/NearHuiwen/TiktokDouyinCrawler)
- [B1gM8c/X-Bogus](https://github.com/B1gM8c/X-Bogus)

::: details 开源协议 MIT
```
```sh [yarn]
yarn --production
MIT License
Copyright (c) 2023 ikenxuan
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
:::
:::

0 comments on commit 9ea160a

Please sign in to comment.