Skip to content

Latest commit

 

History

History
54 lines (46 loc) · 2.91 KB

File metadata and controls

54 lines (46 loc) · 2.91 KB

Buckyball Documents 功能清单

这个文档需要永远保持最新,请实时同步,并保持绝对简洁

前端页面

页面 路径 说明
文档首页 /docs/:locale 侧边栏目录树 + 欢迎提示
文档阅读 /docs/:locale/* Markdown 渲染(支持内嵌 HTML),管理员可见编辑/翻译/删除按钮
文档编辑 /edit/:locale/* ByteMD 编辑器(tab 模式),保存后 commit 到 GitHub,可管理图片
新建文档 /docs/:locale/new 输入路径 + 编辑内容
OAuth 回调 /auth/callback 存 token 后跳转
后台管理 /admin 管理管理员列表

后端 API

端点 方法 权限 说明
/api/health GET 公开 健康检查
/api/auth/login GET 公开 GitHub OAuth 跳转
/api/auth/callback GET 公开 OAuth 回调,签发 JWT
/api/auth/me GET 登录 当前用户信息 + 角色
/api/docs/tree/{locale} GET 公开 文档目录树
/api/docs/file/{locale}/{path} GET 公开 获取文档内容
/api/docs/file/{locale}/{path} PUT 管理员 更新文档
/api/docs/file/{locale}/{path} POST 管理员 新建文档
/api/docs/file/{locale}/{path} DELETE 管理员 删除文档
/api/docs/rename/{locale}/{path} POST 管理员 重命名/移动文档(所有语言同步,创建新路径 + 删除旧路径)
/api/docs/order GET 公开 获取侧边栏排序
/api/docs/order PUT 管理员 更新侧边栏排序(存储在 content/.order.json)
/api/docs/image/{locale}/{path} GET 公开 获取图片二进制内容(代理 GitHub)
/api/docs/images/{locale}/{path} GET 公开 列出文档对应 images/ 目录下的图片
/api/docs/images/{locale}/{path} POST 管理员 上传图片到文档的 images/ 目录(multipart/form-data)
/api/docs/images/{locale}/{path} DELETE 管理员 删除指定图片
/api/translate POST 管理员 翻译文档
/api/users/admins GET 管理员 获取管理员列表
/api/users/admins PUT 管理员 更新管理员列表

前台 / 后台分工

前台(所有人可访问):

  • 浏览文档、切换文档语言(en/zh)、切换 UI 语言
  • 登录后管理员额外可见:编辑、新建、删除、翻译按钮
  • 编辑页面可上传/查看/删除文档图片,图片存储在文档同级 images/ 目录下
  • 图片上传后可一键复制 Markdown 图片链接
  • 管理员可在侧边栏双击文件名重命名
  • 管理员可在侧边栏拖拽文件到文件夹移动层级
  • 管理员可在侧边栏拖拽调整文件/文件夹排序
  • 切换 EN/中文 同时切换文档语言和 UI 语言

后台(仅管理员,/admin):

  • 管理管理员列表(添加/移除 GitHub 用户名)
  • 左侧导航栏预留扩展