Skip to content

Commit

Permalink
docs: upgrade docs to v0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
ilharp committed Mar 10, 2024
1 parent 5107fd5 commit 9cc8900
Show file tree
Hide file tree
Showing 38 changed files with 407 additions and 122 deletions.
15 changes: 10 additions & 5 deletions packages/docs/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ const themeConfig: ThemeConfig = {
{
label: '使用',
position: 'left',
to: 'install',
to: 'guide/install/shell',
activeBasePath: 'guide',
},
{
label: '开发',
Expand Down Expand Up @@ -139,16 +140,20 @@ const themeConfig: ThemeConfig = {
title: '使用',
items: [
{
label: '安装',
to: '/install',
label: '安装 Chronocat',
to: '/guide/install/shell',
},
{
label: '安装引擎',
to: '/guide/install/engine',
},
{
label: '接入',
to: '/connect',
to: '/guide/connect',
},
{
label: '配置',
to: '/config',
to: '/guide/config',
},
],
},
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/docs/develop/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { AreaDevelop } from '@site/src/components/AreaDevelop'

<Link
className="button button--secondary button--lg button--normal"
to="/connect"
to="/guide/connect"
>
<span>前往接入</span>
</Link>
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/docs/faq/2/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Chronocat 自身实现了 Satori 协议,但并不实现任何特定的功能
引擎提供。你可以安装不同的 Chronocat 引擎来使用各种功能。

目前,已经有多个框架可供接入
Chronocat,支持的框架可参见 [接入](/connect) 页面。你也可以使用该页面列举的 SDK
Chronocat,支持的框架可参见 [接入](/guide/connect) 页面。你也可以使用该页面列举的 SDK
进行开发。
2 changes: 1 addition & 1 deletion packages/docs/docs/faq/3/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ sidebar_position: 3
正常运行。需要注意的是,登录后 Satori 服务才会启动,因此请先登录
QQ。

![恭喜](./congratulations.png)
![恭喜](congratulations.png)
2 changes: 1 addition & 1 deletion packages/docs/docs/faq/4/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ PR 是否修复了某个 bug;此时你可以在自己的环境中使用开发

<Link
className="button button--secondary button--lg button--normal"
to="/install"
to="/guide/install/shell"
>
<span>前往安装</span>
</Link>
2 changes: 1 addition & 1 deletion packages/docs/docs/faq/5/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 5

持续运行 Chronocat 30 天后,你会发现自己的 QQ 被踢下线。

![下线](./offline.png)
![下线](offline.png)

这是正常现象。PCQQ 持续登录超 30 天后会被下线。退出 QQ 后重新启动 QQ 并登录即可。

Expand Down
2 changes: 1 addition & 1 deletion packages/docs/docs/faq/6/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ sidebar_position: 6

如果你还未检查过插件加载器是否安装成功,Chronocat 插件是否安装成功,那么应当首先检查。

在一台全新的电脑上,可以通过检查 [配置文件](/config) 是否生成来快速确定 Chronocat 是否成功启动。
在一台全新的电脑上,可以通过检查 [配置文件](/guide/config) 是否生成来快速确定 Chronocat 是否成功启动。

## 2. QQ 尚未登录

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,6 @@ Chronocat 之前,你需要将所有 `DEFINE_CHRONO_TOKEN`

:::

### 从 v0.0.45 迁移

如果你从 Chronocat 版本 0.0.45 或更早迁移,那么:

- 新的默认配置会生成,且所有 token 配置项将会保持与旧的 `RED_PROTOCOL_TOKEN` 文件一致。
- **旧的 `RED_PROTOCOL_TOKEN` 文件将会失效,但将被保留。** 请在迁移后及时删除旧文件,避免造成混淆。

## 编辑

我们推荐使用任意一款带有 LSP 功能的编辑器来编辑 Chronocat 配置文件:
Expand All @@ -78,7 +71,7 @@ Chronocat 之前,你需要将所有 `DEFINE_CHRONO_TOKEN`

<Link
className="button button--secondary button--lg button--normal"
to="/config/reference"
to="/guide/config/reference"
>
<span>Chronocat 配置文件参考</span>
</Link>
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
28 changes: 28 additions & 0 deletions packages/docs/docs/guide/install/engine/chronocat-api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: chronocat-api
---

import Link from '@docusaurus/Link'

Chronocat API 引擎,实现了基础的 API 功能。绝大多数 API 都需要安装此引擎。

## 下载

可从 LiteLoaderQQNT 插件商店搜索「Chronocat Engine:API」直接安装,也可以在 Chronocat
下载页找到插件。文件名应当类似 `chronocat-llqqnt-engine-chronocat-api-v0.0.0.zip`

<Link
className="button button--secondary button--lg"
to="https://github.com/chrononeko/chronocat/releases"
>
<span>前往 Chronocat 下载页</span>
</Link>

## 提供

chronocat-api 引擎为 Chronocat 项目本身提供,与 Chronocat Shell 的版本号保持同步。

## 源代码

chronocat-api 引擎的源代码位于
[这里](https://github.com/chrononeko/chronocat/tree/master/packages/engine-chronocat-api)
28 changes: 28 additions & 0 deletions packages/docs/docs/guide/install/engine/chronocat-event.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: chronocat-event
---

import Link from '@docusaurus/Link'

Chronocat 事件引擎,实现了事件的监听和推送。监听消息需要安装此引擎。

## 下载

可从 LiteLoaderQQNT 插件商店搜索「Chronocat Engine:Event」直接安装,也可以在 Chronocat
下载页找到插件。文件名应当类似 `chronocat-llqqnt-engine-chronocat-event-v0.0.0.zip`

<Link
className="button button--secondary button--lg"
to="https://github.com/chrononeko/chronocat/releases"
>
<span>前往 Chronocat 下载页</span>
</Link>

## 提供

chronocat-event 引擎为 Chronocat 项目本身提供,与 Chronocat Shell 的版本号保持同步。

## 源代码

chronocat-event 引擎的源代码位于
[这里](https://github.com/chrononeko/chronocat/tree/master/packages/engine-chronocat-event)
40 changes: 40 additions & 0 deletions packages/docs/docs/guide/install/engine/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: 安装引擎
---

import Link from '@docusaurus/Link'
import DocCardList from '@theme/DocCardList'

Chronocat 自身实现了 Satori 协议,但并不实现任何特定的功能;这些功能由 Chronocat
引擎提供。你可以为 Chronocat 安装引擎来添加功能。

## :star: 一句话说明 :star:

**绝大多数情况下,安装「chronocat-api」和「chronocat-event」两个引擎即可。** 二者均可从 LiteLoaderQQNT
插件商店搜索「Chronocat」直接安装,也可以在 Chronocat 下载页找到插件。

<Link
className="button button--secondary button--lg"
to="https://github.com/chrononeko/chronocat/releases"
>
<span>前往 Chronocat 下载页</span>
</Link>

## 引擎一览

<DocCardList />

## 下一步

接下来,你可以将 Chronocat 接入你喜爱的应用或框架。

<Link
className="button button--secondary button--lg button--normal"
to="/guide/connect"
>
<span>前往接入</span>
</Link>

---

## 引擎功能参考
35 changes: 35 additions & 0 deletions packages/docs/docs/guide/install/engine/poke.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: poke
---

import Link from '@docusaurus/Link'

戳一戳事件引擎,实现了戳一戳消息的接收。

目前仅支持如下环境:

- Windows x64
- QQ 9.9.2-16183 及以上

开发者近期没有精力将此引擎移植到其他环境。

只能识别戳一戳消息的来源聊天/来源群。群内触发的戳一戳消息无法得知发送者。可以用于触发随机文字/表情包等内容回复。

## 下载

可从 LiteLoaderQQNT 插件商店搜索「Chronocat Engine:Poke」直接安装,也可以在项目发布仓库下载。

<Link
className="button button--secondary button--lg"
to="https://github.com/chrononeko/LiteLoaderQQNT-Plugin-Chronocat-Engine-Poke"
>
<span>LiteLoaderQQNT-Plugin-Chronocat-Engine-Poke</span>
</Link>

## 提供

poke 引擎为 Team Chrononeko 提供,但并不由 Chronocat 项目直接提供。最新版本以项目仓库提供的版本为准。

## 源代码

目前没有开放源代码的计划。
38 changes: 38 additions & 0 deletions packages/docs/docs/guide/install/shell/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: 安装 Chronocat
---

import Link from '@docusaurus/Link'
import { UntrustedContents } from '@site/src/components/UntrustedContents'

Chronocat 提供了多种安装方法,你可以根据自己的需求进行选择。

## :star: 一句话说明 :star:

安装最新版 [QQ](https://im.qq.com)
[LiteLoaderQQNT](https://liteloaderqqnt.github.io),在插件市场搜索安装「Chronocat」「Chronocat Engine:API」「Chronocat Engine:Event」,最后重启
QQ 即可。

## 本机安装(推荐)

本机安装会在当前电脑上安装 QQ 和 Chronocat 并运行,推荐使用这种方法安装 Chronocat。

<Link
className="button button--secondary button--lg button--normal"
to="/guide/install/shell/native"
>
<span>本机安装</span>
</Link>

## 手机安装

<UntrustedContents />

社区提供了在手机上安装和运行 Chronocat 的方法,基于 ZeroTermux。

<Link
className="button button--secondary button--lg button--normal"
to="/guide/install/shell/phone"
>
<span>手机安装</span>
</Link>
File renamed without changes
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ LiteLoaderQQNT 提供了详细的安装教程,可以直接前往 LiteLoaderQQN

<Link
className="button button--secondary button--lg"
to="https://llqqnt.mukapp.top"
to="https://liteloaderqqnt.github.io"
>
<span>前往 LiteLoaderQQNT</span>
</Link>
Expand Down Expand Up @@ -51,11 +51,11 @@ LiteLoaderQQNT 提供了详细的安装教程,可以直接前往 LiteLoaderQQN

结论:Chronocat 已成功安装在你的 QQ 上。

接下来,你可以将 Chronocat 接入你喜爱的应用或框架
接下来,你可以为 Chronocat 安装引擎来添加功能

<Link
className="button button--secondary button--lg button--normal"
to="/connect"
to="/guide/install/engine"
>
<span>前往接入</span>
<span>安装引擎</span>
</Link>
File renamed without changes
File renamed without changes
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ import { UntrustedContents } from '@site/src/components/UntrustedContents'

<UntrustedContents />

来自社区的 [@initialencounter](https://github.com/initialencounter) 在 ZeroTermux 软件和
[社区 Docker 镜像](/install/docker/community) 的基础上制作了 chronocat-termux,可以在手机上安装和使用 Chronocat。
来自社区的 [@initialencounter](https://github.com/initialencounter) 在 ZeroTermux 软件和社区
Docker 镜像的基础上制作了 chronocat-termux,可以在手机上安装和使用 Chronocat。

<Link
className="button button--secondary button--lg"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: 可信安装
---

import CodeBlock from '@theme/CodeBlock'
import DtiSource from '!!raw-loader!../../../../scripts/dti.cts'
import DtiSource from '!!raw-loader!../../../../../../scripts/dti.cts'

:::warning[面向插件框架开发者的文档]

Expand Down
Loading

0 comments on commit 9cc8900

Please sign in to comment.