docs: README 项目结构章节增加目录作用总览表 + 根目录文件说明

This commit is contained in:
2026-08-27 19:05:37 +08:00
parent f307781f58
commit 5afc7fa9be
+13
View File
@@ -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 # 入口,路由注册,中间件装配