File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ {
2+ "pages" : [
3+ " start" ,
4+ " message" ,
5+ " command" ,
6+ " protocol" ,
7+ " plugin" ,
8+ " logging" ,
9+ " context"
10+ ]
11+ }
Original file line number Diff line number Diff line change 22title : 快速开始
33---
44
5- 欢迎来到 Fraq 的文档!Fraq 是一个 Milky 协议下的聊天机器人框架。Milky 是基于 HTTP / WebSocket 通信的 QQ 机器人应用接口标准。你可以通过 [ Milky 的官方网站] ( https://milky.ntqqrev.org/ ) 来了解更多关于 Milky 的信息,例如它的设计理念、API 规范、支持该协议的协议端等。
5+ import { ServerIcon , SquareCodeIcon } from ' lucide-react' ;
6+
7+ 欢迎来到 Fraq 的文档!Fraq 是一个 Milky 协议下的 TypeScript 聊天机器人框架。Milky 是基于 HTTP / WebSocket 通信的 QQ 机器人应用接口标准。你可以随时通过 [ Milky 的官方网站] ( https://milky.ntqqrev.org/ ) 来了解更多关于 Milky 的信息。
68
79## 安装 Fraq
810
@@ -17,3 +19,20 @@ pnpm add @fraqjs/fraq
1719```
1820
1921Fraq 需要在 Node.js 22+ 环境(或其他的支持 WebSocket API 的服务端 JS 环境)中运行。强烈建议使用 TypeScript 来编写 Fraq 代码,并使用 [ tsx] ( https://www.npmjs.com/package/tsx ) 来运行你的项目。
22+
23+ ## 阅读指南
24+
25+ 根据需求的不同,我们准备了如下的文档供你参考:
26+
27+ <Cards >
28+ <Card
29+ icon = { <SquareCodeIcon />}
30+ href = " ./docs/development/start"
31+ title = " 开发指南"
32+ >
33+ 从简单的 Echo 机器人开始,逐步深入了解 Fraq 的各种功能和特性。
34+ </Card >
35+ <Card icon = { <ServerIcon />} title = " 使用指南" >
36+ (Work In Progress) 了解如何安装和配置插件,进而搭建一个属于你的 Fraq 机器人。
37+ </Card >
38+ </Cards >
Original file line number Diff line number Diff line change 11{
22 "pages" : [
33 " index" ,
4- " ---开发指南---" ,
5- " development/start" ,
6- " development/message" ,
7- " development/command" ,
8- " development/protocol" ,
9- " development/plugin" ,
10- " development/logging" ,
11- " development/context"
4+ " ---[SquareCode]开发指南---" ,
5+ " ...development" ,
6+ " ---[Server]使用指南---" ,
7+ " ...usage" ,
8+ " ---外部资源---" ,
9+ " external:[Milky 官网](https://milky.ntqqrev.org/)"
1210 ]
1311}
Original file line number Diff line number Diff line change 11import { docs } from 'collections/server' ;
22import { loader } from 'fumadocs-core/source' ;
3+ import { icons } from 'lucide-react' ;
4+ import { createElement } from 'react' ;
35
46import { docsContentRoute , docsImageRoute , docsRoute } from './shared' ;
57
68// See https://fumadocs.dev/docs/headless/source-api for more info
79export const source = loader ( {
810 baseUrl : docsRoute ,
911 source : docs . toFumadocsSource ( ) ,
12+ icon ( icon ) {
13+ if ( ! icon ) {
14+ return ;
15+ }
16+ if ( icon in icons ) return createElement ( icons [ icon as keyof typeof icons ] ) ;
17+ } ,
1018 plugins : [ ] ,
1119} ) ;
1220
You can’t perform that action at this time.
0 commit comments