47 lines
1.7 KiB
Markdown
47 lines
1.7 KiB
Markdown
# EasyGoAdmin GoFrame+ElementPlus 文档
|
||
|
||
基于 VitePress 构建的 EasyGoAdmin（GoFrame v2 + Vue3 + Element Plus）开发者文档站点。
|
||
|
||
+ 官网：[https://www.easygoadmin.vip](https://www.easygoadmin.vip)
|
||
+ Gitee 仓库：[https://gitee.com/easygoadmin/EasyGoAdmin_GoFrame_EleVue](https://gitee.com/easygoadmin/EasyGoAdmin_GoFrame_EleVue)
|
||
+ 在线文档：[http://docs.goframe.elevue.easygoadmin.vip/](http://docs.goframe.elevue.easygoadmin.vip/)
|
||
|
||
## 本地开发
|
||
|
||
```bash
|
||
# 安装依赖
|
||
pnpm install
|
||
|
||
# 启动开发服务器
|
||
pnpm docs
|
||
|
||
# 构建静态站点
|
||
pnpm docs:build
|
||
|
||
# 预览构建结果
|
||
pnpm docs:preview
|
||
```
|
||
|
||
## 文档结构
|
||
|
||
```
|
||
index.md # 文档首页（hero + features）
|
||
zh/
|
||
├── introduction.md # 1.1 项目介绍（及 why/directory/course/tech-stack/changelog）
|
||
├── quickstart/ # 第 2 章 快速入门
|
||
├── guide/ # 第 3 章 模块开发实战
|
||
├── architecture/ # 第 4 章 架构设计
|
||
├── core/ # 第 5 章 核心功能
|
||
├── modules/ # 第 6 章 业务模块
|
||
├── tools/ # 第 7 章 文件处理
|
||
├── api-spec/ # 第 8 章 接口规范与对接
|
||
├── frontend/ # 第 9 章 前端开发
|
||
├── generator/ # 第 10 章 代码生成器
|
||
├── deploy/ # 第 11 章 运维部署
|
||
├── standards/ # 第 12 章 规范标准
|
||
├── appendix/ # 附录 A-J
|
||
└── other/ # 附录 K-M（贡献指南、免责声明、赞助）
|
||
```
|
||
|
||
侧栏与导航配置：`.vitepress/config/zh.ts`。
|