From 0eae3f8c472752061de38f805c4483dbb89f9c82 Mon Sep 17 00:00:00 2001 From: freefire <97975089@qq.com> Date: Tue, 16 Jun 2026 06:00:44 +0800 Subject: [PATCH] =?UTF-8?q?=E6=81=A2=E5=A4=8D=20README=20=E5=8E=9F?= =?UTF-8?q?=E6=9C=89=E6=8E=92=E7=89=88=EF=BC=9A=E5=B1=85=E4=B8=AD=E6=A0=87?= =?UTF-8?q?=E9=A2=98=E3=80=81=E5=BE=BD=E7=AB=A0=E3=80=81=E6=88=AA=E5=9B=BE?= =?UTF-8?q?=E8=A1=A8=E6=A0=BC=E4=B8=8E=20HTML=20=E5=B8=83=E5=B1=80?= =?UTF-8?q?=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Cursor --- README.md | 119 +++++++++++++++++++++++++++++------------------------- 1 file changed, 65 insertions(+), 54 deletions(-) diff --git a/README.md b/README.md index b6d29e1..dc41552 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - +
# 姜十三论坛 Jiang13 Forum @@ -6,13 +6,12 @@ 面向小圈子内部交流，编译为单个 Go 二进制，前端 SPA 内嵌，内置 SQLite，开箱即用。 - +
- -[License: MIT](LICENSE) -[Go](go.mod) -[React](frontend/package.json) -[SQLite](#) +[![License: MIT](https://img.shields.io/badge/License-MIT-18a058?style=flat-square)](LICENSE) +[![Go](https://img.shields.io/badge/Go-1.26-00ADD8?style=flat-square&logo=go&logoColor=white)](go.mod) +[![React](https://img.shields.io/badge/React-18-61DAFB?style=flat-square&logo=react&logoColor=white)](frontend/package.json) +[![SQLite](https://img.shields.io/badge/SQLite-内置-003B57?style=flat-square&logo=sqlite&logoColor=white)](#) [快速开始](#-快速开始) · [界面预览](#-界面预览) · @@ -20,20 +19,18 @@ [路线图](ROADMAP.md) · [参与贡献](CONTRIBUTING.md) - +
+姜十三论坛首页 - 浅色主题三栏布局 +浅色主题 · 三栏布局 · Feed 排序 · 虚拟滚动帖列表 - -浅色主题 · 三栏布局 · Feed 排序 · 虚拟滚动帖列表 - - - +
> **开发状态：** 项目积极开发中。管理后台已统一为 React SPA（`/admin`），欢迎参与共建。 > 查看 [路线图 ROADMAP.md](ROADMAP.md) · [Issues 反馈](https://git.iioio.com/freefire/jiang13-forum/issues) - +
--- @@ -41,15 +38,37 @@ > 论坛用户第一眼看到的是界面。姜十三论坛采用清新绿色主题、高密度信息布局，兼顾桌面与移动端体验。 + + + + + + + + + +
+ 浅色主题首页 +
浅色主题
+ 左栏板块导航 · Feed 排序切换 · 右栏热门/动态/在线 + 		+ 暗色主题首页 +
暗色主题
+ 一键切换 · 护眼阅读 · 全局色彩自适应 +
+ 帖子详情页 +
帖子详情
+ TipTap 富文本渲染 · 标签展示 · 点赞收藏互动 + 		+ 移动端首页 +
移动端适配
+ 板块快捷筛选 · Feed 排序 · 触控友好列表 +
-| | | -| ---------------------------------------- | ----------------------------------- | -| **浅色主题** 左栏板块导航 · Feed 排序切换 · 右栏热门/动态/在线 | **暗色主题** 一键切换 · 护眼阅读 · 全局色彩自适应 | -| **帖子详情** TipTap 富文本渲染 · 标签展示 · 点赞收藏互动 | **移动端适配** 板块快捷筛选 · Feed 排序 · 触控友好列表 | - - - -**发帖** — 板块胶囊选择 · TipTap 工具栏 · 本地上传图片 +

+ 发帖页 +
发帖 — 板块胶囊选择 · TipTap 工具栏 · 本地上传图片 +

--- @@ -57,16 +76,14 @@ ### 界面与交互 - -| 特性 | 说明 | -| --------- | -------------------------------------------- | -| **三栏布局** | 左栏板块菜单（可折叠）+ 中间虚拟滚动帖列表 + 右栏热门/通知/在线 | -| **虚拟滚动** | `@tanstack/react-virtual` 驱动帖列表与楼层回复，长列表依然流畅 | -| **帖子排序** | 最新发帖 / 最新回复 / 热门讨论，一键切换 Feed 排序 | -| **主题切换** | 浅色 / 暗色一键切换，跟随 `prefers-color-scheme` 与本地记忆 | -| **响应式** | 平板 / 手机自动收起侧栏，搜索、发帖、登录触手可及 | -| **高密度排版** | V2EX / NGA 风格信息密度，一屏浏览更多内容 | - +| 特性 | 说明 | +|------|------| +| **三栏布局** | 左栏板块菜单（可折叠）+ 中间虚拟滚动帖列表 + 右栏热门/通知/在线 | +| **虚拟滚动** | `@tanstack/react-virtual` 驱动帖列表与楼层回复，长列表依然流畅 | +| **帖子排序** | 最新发帖 / 最新回复 / 热门讨论，一键切换 Feed 排序 | +| **主题切换** | 浅色 / 暗色一键切换，跟随 `prefers-color-scheme` 与本地记忆 | +| **响应式** | 平板 / 手机自动收起侧栏，搜索、发帖、登录触手可及 | +| **高密度排版** | V2EX / NGA 风格信息密度，一屏浏览更多内容 | ### 社区功能 @@ -140,26 +157,22 @@ cd .. && go build -trimpath -ldflags "-s -w" -o dist/jiang13 ./cmd/jiang13 ### 启动参数 - -| 参数 | 默认值 | 说明 | -| -------------- | -------- | ------------------------------------ | -| `--port` | `3000` | HTTP 监听端口 | -| `--data` | `./data` | 数据目录（SQLite、上传、日志） | -| `--jwt-secret` | 自动生成 | JWT 签名密钥（留空则持久化到 `data/.jwt_secret`） | - +| 参数 | 默认值 | 说明 | +|------|--------|------| +| `--port` | `3000` | HTTP 监听端口 | +| `--data` | `./data` | 数据目录（SQLite、上传、日志） | +| `--jwt-secret` | 自动生成 | JWT 签名密钥（留空则持久化到 `data/.jwt_secret`） | --- ## 技术栈 - -| 层级 | 技术 | -| ------ | -------------------------------------------------------------- | -| **后端** | Go 1.26 · Gin · GORM · SQLite | +| 层级 | 技术 | +|------|------| +| **后端** | Go 1.26 · Gin · GORM · SQLite | | **前端** | React 18 · TipTap · Radix UI · Tailwind CSS · TanStack Virtual | -| **构建** | Vite → `go:embed` 内嵌 SPA，单二进制发布 | -| **认证** | bcrypt · JWT Cookie | - +| **构建** | Vite → `go:embed` 内嵌 SPA，单二进制发布 | +| **认证** | bcrypt · JWT Cookie | --- @@ -224,14 +237,12 @@ data/ 项目**积极开发中**，作为论坛产品功能尚未完善，欢迎参与共建。 - -| 类型 | 示例 | -| ------ | ---------------------------------- | -| ✅ 已可用 | 三栏布局、暗色主题、虚拟滚动、Feed 排序、楼层评论 | -| ✅ 发帖体验 | TipTap 富文本、正文图片上传、修订历史、可配置编辑时限 | +| 类型 | 示例 | +|------|------| +| ✅ 已可用 | 三栏布局、暗色主题、虚拟滚动、Feed 排序、楼层评论 | +| ✅ 发帖体验 | TipTap 富文本、正文图片上传、修订历史、可配置编辑时限 | | ✅ 管理后台 | React SPA：仪表盘、帖子置顶、用户禁言、论坛参数与敏感词配置 | -| 📋 计划中 | 通知动态优化、邮件提醒 | - +| 📋 计划中 | 通知动态优化、邮件提醒 | 完整列表见 **[路线图 ROADMAP.md](ROADMAP.md)**。发现问题请提交 [Issues](https://git.iioio.com/freefire/jiang13-forum/issues)，认领任务请参考 [CONTRIBUTING.md](CONTRIBUTING.md)。 @@ -245,4 +256,4 @@ data/ ## 许可证 -[MIT](LICENSE) — 自由使用、修改与分发。 \ No newline at end of file +[MIT](LICENSE) — 自由使用、修改与分发。