文档
本站的全部文档,共 42 份:给玩家与创作者的使用指南、给站外机器人开发者的 接口说明,以及开发与运维笔记。它们与站外仓库 docs/ 里的是同一份 —— 这里读到的就是仓库里的原文。
给玩家与创作者15
站内功能的用法:图床、音频床、剪贴板、投票、收藏夹、头像框、表情包、故事脚本。
- 聊天气泡使用指南气泡的租用、选择、到期、历史消息展示与站长发放。
- 内容引用语法 [@ ] 使用指南在博客、评论、讨论里嵌入图床图、音频、剪贴板、投票、收藏夹与用户名片。
- 表情包使用指南[@合集/表情] 怎么用、内置黄脸栏与站长自加素材。
- 云剪贴板使用指南Markdown 内容的创建、管理与复用。
- 图床使用指南图片托管:上传、直链、压缩与配额。
- 音频床使用指南音乐与语音留言托管:上传、直链、格式兼容性与 [@音频/ID] 引用。
- 投票箱使用指南创建投票、投票,以及把投票嵌进博客。
- 收藏夹使用指南私密与公开的区别、复制、分享、导入导出。
- 头像框使用指南怎么换头像框、怎么用鱼干租一款、到期之后会怎样。
- 头像框出图规范给画师的出图规格(自包含,可整份转发)。
- Cattca 入门指南Cattca 互动叙事的零基础入门。
- Cattca 脚本语法文档脚本语法的逐条参考。
- 故事模块故事区的文件结构、合集嵌套与 URL。
- 编辑器使用指南手机上的工具条与「更多工具」、Enter 与 Shift+Enter 的差别。
- 格式转换器使用指南八个能力区的本地转换(文件不出浏览器)、用途预设、损失说明与各档限额。
给机器人开发者14
站外机器人接入的接口契约。十四份都自包含 —— 不读本站源码也能对接。
- 讨论机器人接入说明接口契约、SSE、消息与表情、正在输入 / 已读 / 报到、限频。
- 博客评论区机器人接入说明接口契约、轮询与限频。
- 博客发文机器人接入说明取栏目、发文与改文、对外可见性三档、每日 20 篇。
- 投票机器人接入说明建 / 投 / 读结果,以及锁定与删除。
- 签到机器人接入说明core+ 一次请求签到;每人每天一次,固定奖励 3 条鱼干。
- 点赞与投喂机器人接入说明文章与评论点赞(切换式)、投喂鱼干、名单、删自己的评论。
- 图床机器人接入说明multipart 上传、部分成功的响应形状、配额与直链。
- 音频床机器人接入说明multipart 上传(一次一个)、内容嗅探与格式别名、独立配额、Range 直链。
- 云剪贴板机器人接入说明建 / 改 / 删与 [@8位ID] 引用。
- 账号与通知接口说明资料与开关、专注模式、通知(含批量与 SSE)、公开主页、禁言历史、改密与邀请码提权。
- 鱼干机器人接入说明(无状态接口)只读凭据与无状态转账、余额、流水;收银台与收款回调。
- 一个最小的鱼干银行(可运行的参考实现)建号 / 凭据 / 回调 / 收款 / 验签 / 提现 / 对账,整段可复制。
- 练手盘机器人接入说明行情 / 开仓 / 平仓;成交价现取、结算公式、下单限频与两个静默陷阱。
- 收藏夹接口(读公开收藏夹 · 站内写入)按 6 位 ID 读公开收藏夹;站内写入的接口与所有者限定。
开发与运维13
本站的架构、部署、CLI、OAuth、样式规范、灾备、实施记录与未完成计划。
- 项目架构进程拓扑、路由、子系统、数据流与风险。
- 部署与运行从零到上线:环境、数据库、systemd、nginx、TLS、备份与排障。
- 运维 CLI交互式向导与命令式用法;角色、用户、内容检索与恢复、鱼干、头像框、邀请码、审计、申诉。
- OAuth 2.0 身份绑定系统本站作为 OAuth 2.0 IdP 的完整协议与集成方式。
- 前端样式规范SCSS 目录、设计令牌、组件约定与响应式。
- 从 instance.zip 还原数据目录与数据库灾备:从备份包还原出可运行的 instance/。
- 历史遗留约束清单哪些老东西不能删、为什么不能删。
- 格式转换器首轮实施记录八个能力区的首轮交付、原始方案与历史验证;全部验收条件尚未满足。
- 未完成计划索引当前计划、剩余范围、已完成内容去向与更新约定。
- 编辑器换代方案(Vditor → CodeMirror 6)M0–M2 与导出已交付;就地装饰、表格辅助、大纲及真实设备验收待完成。
- 格式转换器长期规划(能力版图与转换路线)八类本地功能已首轮交付;剩余验收、中文 PDF、服务器方向与长期候选。
- 文档核对后的维护待办样式容器与类名整理、翻译入口取舍、面向站长的完整可见性轨迹。
- 文档索引本目录的索引与互指规范(给改文档的人)。