chore: Rename the website directory to docs

This commit is contained in:
vben
2024-08-01 21:05:31 +08:00
parent 4a7a4f97ee
commit 06ad5ad871
73 changed files with 154 additions and 374 deletions

View File

@@ -0,0 +1,3 @@
# 更新日志
TODO

View File

@@ -0,0 +1,84 @@
---
outline: deep
---
# 快速开始 {#quick-start}
## 前置准备
::: info 环境要求
在启动项目前,你需要确保你的环境满足以下要求:
- [Node.js](https://nodejs.org/en) 20 及以上版本,推荐使用 [fnm](https://github.com/Schniz/fnm) 或者 [nvm](https://github.com/nvm-sh/nvm) 进行版本管理。
- [Git](https://git-scm.com/) 任意版本。
验证你的环境是否满足以上要求,你可以通过以下命令查看版本:
```bash
# 出现相应 node LTS版本即可
node -v
# 出现相应 git 版本即可
git -v
```
:::
## 启动项目
### 获取源码
::: code-group
```bash [GitHub]
# clone 代码
git clone https://github.com/vbenjs/vue-vben-admin.git
```
```bash [Gitee]
# clone 代码
# Gitee 的代码可能不是最新的
git clone https://gitee.com/annsion/vue-vben-admin.git
```
:::
::: danger 注意
注意存放代码的目录及所有父级目录不能存在中文、韩文、日文以及空格,否则安装依赖后启动会出错。
:::
### 安装依赖
在你的代码目录内打开终端,并执行以下命令:
```bash
# 进入项目目录
cd vue-vben-admin
# 使用项目指定的pnpm版本进行依赖安装
corepack enable
# 安装依赖
pnpm install
```
::: tip 注意
项目只支持使用 `pnpm` 进行依赖安装,默认会使用 `corepack` 来安装指定版本的 `pnpm`。:
:::
### 运行项目
执行以下命令即可运行项目:
```bash
# 启动项目
pnpm dev
```
现在,你可以在浏览器访问 `http://localhost:5555` 查看项目。

View File

@@ -0,0 +1,3 @@
# 路线图
TODO:

View File

@@ -0,0 +1,51 @@
# 关于 Vben Admin
::: info 你正在阅读的是 [Vben Admin](https://github.com/vbenjs/vue-vben-admin) `5.0`版本的文档!
- Vben Admin 2.x 目前已经存档,只修复一些严重的问题。
- 新版本与旧版本不兼容如果你使用的是旧版本v2、v3请查看 [Vue Vben Admin 2.x 文档](https://doc.vvbin.cn)
- 如发现文档有误,欢迎提提交 Issue 帮助我们改进。
- 如果你只是想体验一下,你可以查看 [快速开始](./quick-start.md)。
:::
[Vben Admin](https://github.com/vbenjs/vue-vben-admin) 是一个基于 [Vue3.0](https://github.com/vuejs/core)、[Vite](https://github.com/vitejs/vite)、 [TypeScript](https://www.typescriptlang.org/) 的后台解决方案目标是为开发中大型项目提供开箱即用的解决方案。包括二次封装组件、utils、hooks、动态菜单、权限校验、多主题配置、按钮级别权限控制等功能。项目会使用前端较新的技术栈可以作为项目的启动模版以帮助你快速搭建企业级中后台产品原型。也可以作为一个示例用于学习 `vue3``vite``ts` 等主流技术。该项目会持续跟进最新技术,并将其应用在项目中。
## 特点
- **最新技术栈**:使用 `Vue3``Vite``TypeScript` 等前端前沿技术开发。
- **国际化**:内置完善的国际化方案,支持多语言切换。
- **权限验证**:完善的权限验证方案,按钮级别权限控制。
- **多主题**:内置多种主题配置&黑暗模式,满足个性化需求。
- **动态菜单**:支持动态菜单,可以根据权限配置显示菜单。
- **Mock 数据**:基于 Nitro 的本地高性能 Mock 数据方案。
- **组件丰富**:提供了丰富的组件,可以满足大部分的业务需求。
- **规范**:代码规范,使用 `ESLint``Prettier``Stylelint``Publint``cspell` 等工具保证代码质量。
- **工程化**:使用 `Pnpm Monorepo``TurboRepo``Changeset` 等工具,提高开发效率。
- **多UI库支持**:支持 `Ant Design Vue``Element Plus``Vuetify` 等主流 UI 库,不再限制于特定框架。
## 浏览器支持
**本地开发**推荐使用`Chrome 最新版`浏览器,**不支持**`Chrome 80`以下版本。
**生产环境**支持现代浏览器,不支持 IE。
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/archive/internet-explorer_9-11/internet-explorer_9-11_48x48.png" alt="IE" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)Safari |
| :-: | :-: | :-: | :-: | :-: |
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
## 贡献
- [Vben Admin](https://github.com/vbenjs/vue-vben-admin) 还在持续更新中,本项目欢迎您的参与,共同维护,逐步完善,打造更好的中后台解决方案。
- 如果你想加入我们,可以多提供一些好的建议或者提交 pr我们会根据你的活跃度邀请你加入。
::: info 加入我们
如果你想加入我们,你可以从以下几个方面开始,我们会根据你的活跃度邀请你加入:
- 长期提交 `PR`
- 提供一些好的建议。
- 参与讨论,帮助解决一些 `issue`
- 共同维护文档。
:::

View File

@@ -0,0 +1,9 @@
# 为什么选择我们?
首先,我们不会去和其他框架做比较。我们认为每个框架都有自己的特点,适合不同的场景。我们的目标是提供一个简单、易用的框架,让开发者可以快速上手,专注于业务逻辑的开发。所以我们只会不断完善和优化我们的框架,提供更好的体验。
## 框架历程
从 Vue Vben Admin 1.x 版本开始,框架经历了许多迭代和优化。从一开始使用 `Vite 0.x` 版本,没有现成的插件,开发了很多自定义插件来弥合 Webpack 和 Vite 之间的差异。虽然很多现在已经被代替,但是我们的初衷一直没有变,就是提供一个简单、易用的框架。
虽然中间有段时间由社区维护,但我们一直密切关注 Vue Vben Admin 的发展。见证了许多开发者使用 Vben Admin并提供了许多宝贵的建议和反馈。非常感谢大家的支持和贡献这些都是我们持续改进 Vben Admin 的动力。新版本中,我们持续收集用户反馈,重新开始,不断优化框架,以提供更好的用户体验。我们的目标是让开发者能够快速上手,专注于业务逻辑的开发。