📚 文档中心
了解平台功能、使用指南和 API 接口说明
📋 平台介绍
本平台是一个以社区为核心的开发者交流平台,提供论坛讨论、帖子互动、产品授权等功能。
核心功能
- 社区论坛:发帖、评论、点赞、收藏、分类筛选
- 个人中心:资料管理、我的帖子/评论/点赞、密码修改
- 产品中心:产品展示、授权码购买与管理
- 暗色模式:一键切换明暗主题
- 移动端适配:底部导航栏、响应式布局
- 用量监控:实时追踪 Vercel 资源使用情况
🚀 快速开始
1. 注册账号
点击页面右上角「注册」按钮,填写用户名、邮箱和密码即可完成注册。 也支持通过 GitHub 账号一键登录。
2. 完善资料
登录后进入「个人中心」,可设置头像(支持图片 URL 或 Emoji)、 修改用户名和编写个人简介。
3. 参与社区
进入「社区论坛」,浏览帖子、发表新帖、评论互动。 支持 Markdown 格式编写帖子内容。
4. 搜索内容
使用顶部搜索框可快速搜索帖子标题和内容, 移动端点击底部导航栏的搜索图标即可使用。
💬 社区功能
发帖
登录后点击「发布新帖」按钮,填写标题和内容(支持 Markdown), 选择分类后即可发布。帖子发布后默认为「已发布」状态。
评论与回复
在帖子详情页可发表评论,支持多级回复。评论会自动进行敏感词检测, 命中敏感词的评论需管理员审核后才会显示。
点赞与收藏
可对帖子进行点赞和收藏操作。在个人中心的「我的点赞」标签页 可查看所有点赞过的帖子。
分类与排序
帖子支持按分类筛选(公告、反馈、教程、闲聊等), 并可按「最新」或「热门」排序。置顶帖子始终排在最前。
帖子编辑与删除
帖子作者可编辑和删除自己的帖子(软删除)。 管理员可执行置顶、加精、锁定等管理操作。
👤 个人中心
资料管理
支持修改头像(图片 URL 或 Emoji)、用户名和个人简介。 头像修改后会在全站同步更新。
我的帖子
查看自己发布的所有帖子,支持分页浏览,可快速编辑或查看。
我的评论
查看自己在各帖子下发表的所有评论,可快速跳转到原帖。
我的点赞
查看所有点赞过的帖子列表,支持分页浏览。
等级系统
通过发帖、评论、点赞等互动行为积累经验值,提升等级。 等级越高,称号越炫酷。
🌙 暗色模式
点击导航栏右侧的太阳/月亮图标可切换明暗主题。 系统会自动记住你的选择,下次访问时自动应用。
首次访问时,系统会根据你的浏览器偏好自动选择主题。 如果你的浏览器设置了暗色模式偏好,平台会自动切换到暗色。
📱 移动端使用
平台已全面适配移动端,在手机浏览器中访问会自动展示响应式布局。
底部导航栏
移动端底部提供四个快捷入口:首页、社区、搜索、我的。 可快速在不同功能区之间切换。
搜索功能
点击底部导航栏的搜索图标,进入搜索页面输入关键词即可搜索帖子。
🐙 GitHub 代码嵌入
在帖子中嵌入 GitHub 仓库的源代码文件,自动获取并语法高亮显示。 支持两种方式:搜索引用和手动嵌入。
方式一:搜索引用(推荐)
在发帖编辑器中,点击「GitHub 代码」按钮,输入关键词搜索开源代码, 点击搜索结果即可自动插入代码引用到帖子内容中。
支持筛选条件,点击搜索框右侧的「筛选」按钮可展开筛选面板:
- 编程语言:一键切换 TypeScript、Python、Go 等 20+ 常用语言
- 限定仓库:输入
owner/repo格式限定搜索范围 - 限定用户/组织:只搜索指定 GitHub 用户或组织下的代码
方式二:粘贴链接自动识别
在编辑器中直接粘贴 GitHub 文件链接,系统会自动识别并转换为代码块:
粘贴后自动转换为 github-code 代码块,支持 blob 链接和 raw 链接
方式三:短代码
使用 [github]URL[/github] 短代码包裹 GitHub 链接:
方式四:手动嵌入
在 Markdown 中使用 github-code 代码块:
可选参数
在路径后添加查询参数:
ref=main- 指定分支/tag/commit(默认 HEAD)lines=10-30- 只显示第 10-30 行lines=10- 只显示第 10 行
支持的文件类型
JavaScript、TypeScript、Python、Go、Rust、Java、C/C++、C#、PHP、 Ruby、Swift、Kotlin、Bash、YAML、JSON、XML、HTML、CSS、SCSS、SQL、 Markdown 等主流语言均支持语法高亮。文件大小限制 100KB 以内。
🚀 协同创作召集令
GitHub 协同创作召集令是平台的核心功能,帮助开发者发起开源协作项目, 邀请社区成员共同参与代码编写。支持手动添加已有仓库或登录 GitHub 创建新仓库, 包含任务清单、团队管理、提交贡献、审核流程等完整协作功能。
📖 完整使用教程请查看:召集令使用指南
发起召集令
访问 发起召集令 页面, 填写项目信息并关联 GitHub 仓库。支持两种方式:
- 手动添加:输入已有 GitHub 仓库 URL,自动解析仓库信息
- 创建新仓库:通过 GitHub API 直接创建新仓库(需配置 Token)
任务管理
项目 Owner/Maintainer 可创建开发任务,成员认领任务后开始开发。 任务状态流转:待认领 → 进行中 → 待审核 → 已完成。 支持优先级(紧急/高/中/低)、截止日期、指派人和标签。
提交贡献与审核
成员在 GitHub 提交代码后,可在平台记录贡献(commit/PR/issue/docs), 关联任务和分支信息。Owner/Maintainer 审核贡献,通过或拒绝。
协作规范
- 主分支受保护,通过 Pull Request 提交代码
- 每次提交需通过 CI 自动检查(语法、格式、测试)
- 任务需先认领再开发,避免重复工作
- Owner/Maintainer 审核 PR 后合并到主分支
角色权限
| 角色 | 权限说明 |
|---|---|
| Owner | 项目所有者,全部管理权限 |
| Maintainer | 维护者,可管理任务和审核贡献 |
| Member | 普通成员,可认领任务和提交贡献 |
🔌 API 文档
平台提供 RESTful API,大部分接口需要登录后才能访问(通过 Bearer Token 鉴权)。
| 接口 | 方法 | 说明 | 鉴权 |
|---|---|---|---|
| /api/forum/posts | GET | 获取帖子列表 | 否 |
| /api/forum/posts | POST | 发布新帖 | 是 |
| /api/forum/posts/[id] | GET | 获取帖子详情 | 否 |
| /api/forum/posts/[id] | PUT | 编辑帖子 | 是 |
| /api/forum/comments | GET | 获取评论列表 | 否 |
| /api/forum/comments | POST | 发表评论 | 是 |
| /api/forum/interact | POST | 点赞/收藏 | 是 |
| /api/user/profile | GET | 获取个人资料 | 是 |
| /api/user/likes | GET | 获取点赞列表 | 是 |
| /api/stats | GET | 获取站点统计 | 否 |
| /api/github/search | GET | 搜索 GitHub 代码 | 否 |
| /api/github/file | GET | 获取 GitHub 文件内容 | 否 |
鉴权方式:在请求头中添加 Authorization: Bearer <token>
❓ 常见问题
如何修改头像?
进入个人中心 → 编辑资料 → 头像区域,可输入图片 URL 或选择 Emoji 作为头像。
帖子支持什么格式?
帖子内容支持 Markdown 格式,包括标题、列表、代码块、链接、图片等。
评论为什么没有立即显示?
评论包含敏感词时会进入待审核状态,需管理员审核通过后才会显示。 正常评论会立即显示。
忘记密码怎么办?
如果绑定了 GitHub 账号,可通过 GitHub 登录。 其他情况请联系管理员重置密码。
用量监控数据是实时的吗?
是的。平台通过全局中间件实时追踪每次请求,数据会记录到数据库中。 监控页面每 60 秒自动刷新一次。
如何在帖子中嵌入 GitHub 代码?
发帖时点击编辑器上方的「GitHub 代码」按钮搜索开源代码,或手动使用```github-code代码块格式嵌入。详见上方「GitHub 代码嵌入」章节。