Files
easygoadmin-wiki/EasyGoAdmin_Gin_EleVue
2026-10-25 17:24:27 +08:00
..
2026-10-25 17:24:27 +08:00
2026-10-25 17:24:27 +08:00
2026-10-25 17:24:27 +08:00
2026-10-25 17:24:27 +08:00
2026-10-20 21:19:44 +08:00
2026-10-25 17:24:27 +08:00
2026-10-25 17:24:27 +08:00
2026-10-25 17:24:27 +08:00
2026-10-25 17:24:27 +08:00
2026-10-20 21:19:44 +08:00
2026-10-20 21:19:44 +08:00

EasyGoAdmin 文档

基于 VitePress 构建的项目开发者文档站点(Gin + GORM + Vue3 + ElementPlus 版)。

本地开发

# 安装依赖
pnpm install

# 启动开发服务器
pnpm docs

# 构建静态站点
pnpm docs:build

# 预览构建结果
pnpm docs:preview

文档结构

zh/
├── introduction.md          # 项目介绍
├── quickstart/              # 快速入门
├── guide/                   # 模块开发实战
├── architecture/            # 架构设计
├── core/                    # 核心功能
├── modules/                 # 业务模块
├── tools/                   # 文件处理
├── api-spec/                # 接口规范与对接
├── frontend/                # 前端开发
├── generator/               # 代码生成器
├── deploy/                  # 运维部署
├── standards/               # 规范标准
├── appendix/                # 附录
└── other/                   # 其他(贡献指南、免责声明)

目录约定

  • 侧边栏结构在 .vitepress/config/zh.ts 中维护,页标题须与侧边栏编号一致(如 # 3.1 概述与目标)
  • 跨章链接使用绝对路径 + .html 后缀(如 [详见第 9 章](/zh/frontend/overview.html))
  • 代码示例首行注释标注源文件路径