Clawline文档站

基于 VitePress 的 Clawline 产品文档站,聚合渲染五个子仓库的文档,提供产品介绍、使用手册和开发指南。

概述

Clawline 文档站是为 Clawline 产品线建设的统一文档网站。采用”文档跟着代码走,站点聚合渲染”的架构,各子项目在自己的 docs/ 目录维护文档,文档站构建时自动拉取合并渲染。

项目由 Ottor 主导产品定义和首页内容编写,webbot 负责站点框架搭建。

域名与环境

环境域名
生产www.clawlines.net
开发docs.dev.dora.restry.cn

技术方案

  • 框架:VitePress(Vue 生态,Markdown 原生驱动,中文生态好)
  • 语言:中文为主
  • 仓库clawline/docs(独立 repo)

文档站结构

clawline/docs/
├── .vitepress/config.ts    ← 导航、侧边栏配置
├── index.md                ← 首页(产品介绍)
├── guide/
│   ├── what-is.md          ← Clawline 是什么
│   ├── architecture.md     ← 三端协作架构图
│   └── quickstart.md       ← 5 分钟跑起来
├── scripts/sync.mjs        ← 构建前从三个 repo 拉最新 docs/
└── package.json

聚合渲染机制

构建时 sync.mjs 从五个子仓库拉取最新文档:

gateway/docs/     → docs/gateway/
channel/docs/     → docs/channel/
client-web/docs/  → docs/client-web/
sdk/docs/         → docs/sdk/
  • 各 Bot 改代码时,docs/ 就在手边,同 PR 更新
  • 90% 的文档内容在各自项目里维护
  • 文档站 repo 主要是”壳”——只存首页和跨项目概述
  • CI 触发:任一 repo push → webhook 触发文档站重新构建

五个子仓库

Repo职责语言
channelOpenClaw 插件,WS 事件、历史持久化、agent 隔离TypeScript
client-webReact 前端聊天客户端TypeScript (React + Vite)
gatewayWS 代理,连接管理、channel 路由、用户认证JavaScript (Node.js)
sdk@clawlines/sdk 通用 WS 客户端库TypeScript
docsVitePress 文档站Markdown + Vue

产品定位

Clawline 的核心定位是 OpenClaw 的 Web 接入方案,而非独立产品。

首页叙事:痛点 → 方案 → 优势

没有 Clawline 的痛点:

  1. OpenClaw 只能通过 Telegram/Discord/微信等第三方平台对话——被平台绑架
  2. 想嵌入自己的网站/App?得从零写 WebSocket、鉴权、消息路由、文件上传、断线重连
  3. 第三方平台有 rate limit、API 随时变、UI 不可控、数据不在自己手里
  4. 内网部署的 Agent 无法暴露公网端口给第三方 webhook

Clawline 的优势:

  1. 自有渠道 — 你的域名、你的 UI、你的数据
  2. Relay 架构 — Agent 主动连出来,不需要公网端口,穿墙友好
  3. 开箱即用 — 三个组件拼起来就能跑,PWA 移动端直接用
  4. 已验证的全链路 — 流式输出、文件上传、记忆、历史记录、断线续传全部内置
  5. 可替换 — 不喜欢 Client Web?只用 Gateway + Channel,自己写前端

页面总数

22 页,涵盖 Guide、Gateway、Channel、Client-Web、SDK 五大板块。

相关页面