From 5afc7fa9bee042ed1cd7965b69d6dafb6cdf7f4d Mon Sep 17 00:00:00 2001 From: kevin Date: Thu, 27 Aug 2026 19:05:37 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20README=20=E9=A1=B9=E7=9B=AE=E7=BB=93?= =?UTF-8?q?=E6=9E=84=E7=AB=A0=E8=8A=82=E5=A2=9E=E5=8A=A0=E7=9B=AE=E5=BD=95?= =?UTF-8?q?=E4=BD=9C=E7=94=A8=E6=80=BB=E8=A7=88=E8=A1=A8=20+=20=E6=A0=B9?= =?UTF-8?q?=E7=9B=AE=E5=BD=95=E6=96=87=E4=BB=B6=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index e2797d7..b85e475 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,19 @@ CREATE DATABASE blog_go CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; ## 项目结构 +| 目录 | 作用 | +|---|---| +| `config/` | 配置加载与自动创建（区分 Linux/Windows 路径） | +| `models/` | 数据模型：用户、文章、标签、评论、附件、阅读统计、站点设置等 + GORM 初始化 | +| `handlers/` | HTTP 请求处理：首页、文章、登录/注册、评论、后台管理、个人中心、RSS、上传校验 | +| `middleware/` | 中间件：登录/角色鉴权、CSRF、HTTPS 检测、安全响应头（CSP/HSTS 等） | +| `i18n/` | 中英文翻译与浏览器语言检测 | +| `templates/` | HTML 模板：layouts 公共布局、pages 前台、admin 后台、user 用户文章 | +| `static/` | 静态资源：Tailwind 产物、前端 Markdown 渲染器、vendor 本地化第三方库（marked、highlight.js 等） | +| `scripts/` | 构建辅助脚本（Tailwind 重建、数据库迁移 SQL） | + +根目录文件：`main.go`（入口 + 路由注册）、`main_test.go` 与 `handlers/_test.go`（测试）、`fresh.conf`（fresh 热重载配置）、`install_linux.sh`（Linux 部署脚本）。逐文件说明： + ``` go_blog/ ├── main.go # 入口，路由注册，中间件装配