mirror of
https://github.com/nagisa77/OpenIsle.git
synced 2026-05-08 03:37:28 +08:00
docs: 引入 Fumadocs
ci: set up github actions
This commit is contained in:
21
docs/README.md
Normal file
21
docs/README.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# OpenIsle Documentation
|
||||
## 要求
|
||||
|
||||
使用 [bun](https://bun.com/) 作为工具链的运行时,版本 1.2+。
|
||||
|
||||
使用 [Fumadocs](https://fumadocs.dev/) 作为文档工具。
|
||||
|
||||
## 开发调试
|
||||
|
||||
```bash
|
||||
bun install
|
||||
bun dev
|
||||
```
|
||||
|
||||
## 项目结构
|
||||
|
||||
使用以下路由:
|
||||
|
||||
- `docs/frontend/` 前端技术文档
|
||||
- `docs/backend/` 后端技术文档
|
||||
- `docs/openapi/` 后端 API 文档
|
||||
Reference in New Issue
Block a user