docs: 引入 Fumadocs

ci: set up github actions
This commit is contained in:
Palm Civet
2025-09-05 20:00:05 +08:00
parent f89a17f14d
commit 29232afadc
32 changed files with 1422 additions and 4 deletions

View File

@@ -0,0 +1,43 @@
---
title: 后端开发
description: OpenIsle 后端服务开发指南
---
# 后端开发
OpenIsle 后端基于 Spring Boot 框架构建,提供完整的 RESTful API 服务。
## 技术栈
- **Spring Boot** - 主框架
- **Spring Security** - 安全认证
- **MyBatis** - 数据访问层
- **MySQL** - 数据库
- **Redis** - 缓存和会话存储
## 项目结构
```
backend/
├── src/main/java/com/
│ ├── controller/ # 控制器层
│ ├── service/ # 业务逻辑层
│ ├── mapper/ # 数据访问层
│ ├── entity/ # 实体类
│ └── config/ # 配置类
└── src/main/resources/
├── application.properties
└── mapper/ # MyBatis 映射文件
```
## 开发环境设置
1. 安装 Java 17+
2. 安装 MySQL 8.0+
3. 安装 Redis
4. 配置数据库连接
5. 启动应用
## API 接口
详细的 API 接口文档请查看 [API 文档](/docs/openapi)。

View File

@@ -0,0 +1,3 @@
{
"root": true
}

View File

@@ -0,0 +1,53 @@
---
title: 前端开发
description: OpenIsle 前端应用开发指南
---
# 前端开发
OpenIsle 前端基于 Nuxt.js 框架构建,提供现代化的用户界面和交互体验。
## 技术栈
- **Nuxt.js** - Vue.js 全栈框架
- **Vue 3** - 前端框架
- **TypeScript** - 类型安全
- **Tailwind CSS** - 样式框架
- **Pinia** - 状态管理
## 项目结构
```
frontend_nuxt/
├── components/ # Vue 组件
├── pages/ # 页面路由
├── composables/ # 组合式函数
├── plugins/ # 插件配置
├── utils/ # 工具函数
└── assets/ # 静态资源
```
## 开发环境设置
1. 安装 Node.js 18+
2. 安装依赖:`npm install`
3. 启动开发服务器:`npm run dev`
4. 访问 http://localhost:3000
## 主要功能
- 用户认证和授权
- 文章发布和管理
- 评论和互动
- 实时消息
- 用户个人资料
- 管理后台
## 组件库
项目使用自定义组件库,主要组件包括:
- `BaseInput` - 输入框组件
- `BasePopup` - 弹窗组件
- `PostEditor` - 文章编辑器
- `CommentEditor` - 评论编辑器

View File

@@ -0,0 +1,3 @@
{
"root": true
}

View File

@@ -0,0 +1,14 @@
---
title: 欢迎使用 OpenIsle
description: OpenIsle 文档首页
---
# 欢迎使用 OpenIsle
OpenIsle 是一个现代化的社区平台,提供完整的社交功能。
## 快速开始
- [后端开发指南](/docs/backend) - 了解后端架构和开发
- [前端开发指南](/docs/frontend) - 了解前端技术栈和组件
- [API 文档](/docs/openapi) - 查看完整的 API 接口文档

View File

@@ -0,0 +1,3 @@
{
"pages": ["index", "frontend", "backend", "openapi"]
}

1
docs/content/docs/openapi/.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
(generated)/

View File

@@ -0,0 +1,4 @@
---
title: API 概览
description: Open API 接口文档
---

View File

@@ -0,0 +1,4 @@
{
"pages": ["index", "...(generated)"],
"root": true
}