首页文档编写。

This commit is contained in:
刘小平 2024-06-18 16:26:40 +08:00
parent c6aa17cc26
commit 42a28b7e65
3 changed files with 53 additions and 14 deletions

36
docs/README.md Normal file
View File

@ -0,0 +1,36 @@
## 安装yarn
```
npm install -g yarn
```
## 安装vitepress
```
yarn add --dev vitepress
```
## 启动
```
yarn dev
```
## 常见问题
### 安装 vitepress 提示 node 版本错误,如何切换 node 版本
访问 nvm-windows 的 [GitHub](https://github.com/coreybutler/nvm-windows) 页面。
下载并安装nvm-windows。
安装完成后打开命令行例如PowerShell或CMD
查看所有可用的Node.js版本
```
nvm list available
```
安装你想要的Node.js版本例如
```
nvm install 18.18.0
```
使用你刚刚安装的版本:
```
nvm use 18.18.0
```
验证是否成功切换到新版本:
```
node -v
```

View File

@ -19,6 +19,6 @@
"@soybeanjs/cli": "1.0.13",
"@types/node": "20.12.7",
"typescript": "5.4.5",
"vitepress": "1.2.3"
"vitepress": "^1.2.3"
}
}

View File

@ -21,24 +21,27 @@ hero:
- theme: alt
text: 在github上查看
link: https://github.com/lxp135/minio-plus
- theme: alt
text: 在gitee上查看
link: https://gitee.com/lxp135/minio-plus
features:
- icon: 🆕
title: Latest popular technology stack
details: Vue3, Vite5, TypeScript, Pinia, UnoCSS.
title: 文件秒传
details: 对每个上传的文件进行哈希摘要识别,用户上传同一个文件时,没有文件实际传输过程,做到秒传。
- icon: 🦋
title: Clean Structure
details: Use pnpm monorepo, clean and elegant structure, easy to maintain. Very high code specification.
title: 并发上传
details: 将文件切分为小块。同时并发上传多个小块,最大限度地利用带宽,加快上传速度。
- icon: 🛠️
title: TypeScript
details: Strictly typed, easy to maintain.
title: 断点续传
details: 在传输过程中遇到问题导致传输失败,只需重新传输未完成的小块,而不需要重新开始整个传输任务。
- icon: 🔩
title: Theme
details: Built-in rich theme configuration, easy to incorporate UnoCSS.
title: 缩略图生成
details: 识别文件类型,在图片上传时自动生成缩略图,缩略图大小可配置。
- icon: 🔗
title: File routing System
details: Automatic, intelligent file routing system.
title: 访问权限控制
details: 可支持基于用户、组的文件权限控制,保证重要文件的安全性。
- icon: 🔑
title: Auth Router
details: Support front-end static routing and back-end dynamic routing.
title: 客户端直连
details: 前端直连 MinIO ,项目工程不做文件流的搬运,在支持以上特性的情况下提供 MinIO 原生性能。
---