mirror of
				https://github.com/dromara/RuoYi-Vue-Plus.git
				synced 2025-11-04 08:13:44 +08:00 
			
		
		
		
	update 全新文档 全面上线
This commit is contained in:
		
							
								
								
									
										36
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										36
									
								
								README.md
									
									
									
									
									
								
							@@ -14,13 +14,13 @@
 | 
			
		||||
> 项目代码、文档 均开源免费可商用 遵循开源协议在项目中保留开源协议文件即可<br>
 | 
			
		||||
活到老写到老 为兴趣而开源 为学习而开源 为让大家真正可以学到技术而开源
 | 
			
		||||
 | 
			
		||||
> 系统演示: [传送门](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=4836388&doc_id=1469725)
 | 
			
		||||
> 系统演示: [传送门](https://javalionli.gitee.io/plus-doc/#/common/demo_system)
 | 
			
		||||
 | 
			
		||||
> 前端项目地址: [plus-ui](https://gitee.com/JavaLionLi/plus-ui)
 | 
			
		||||
 | 
			
		||||
| 功能介绍     | 使用技术                | 文档地址                                                                                              | 特性注意事项                     |
 | 
			
		||||
|----------|---------------------|---------------------------------------------------------------------------------------------------|----------------------------|
 | 
			
		||||
| 当前框架     | RuoYi-Vue-Plus      | [RuoYi-Vue-Plus文档](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages)                       | 重写RuoYi-Vue全方位升级(不兼容原框架)   |
 | 
			
		||||
| 当前框架     | RuoYi-Vue-Plus      | [RuoYi-Vue-Plus文档](https://javalionli.gitee.io/plus-doc)                       | 重写RuoYi-Vue全方位升级(不兼容原框架)   |
 | 
			
		||||
| 微服务分支    | RuoYi-Cloud-Plus    | [微服务分支地址](https://gitee.com/JavaLionLi/RuoYi-Cloud-Plus)                                          | 重写RuoYi-Cloud全方位升级(不兼容原框架) |
 | 
			
		||||
| 原框架      | RuoYi-Vue           | [RuoYi-Vue官网](http://ruoyi.vip/)                                                                  | 定期同步需要的功能                  |
 | 
			
		||||
| 前端开发框架   | Vue3、Element Plus   | [Element Plus官网](https://element-plus.org/zh-CN/#/zh-CN)                                          |                            |
 | 
			
		||||
@@ -44,14 +44,14 @@
 | 
			
		||||
| 分布式链路追踪  | Apache SkyWalking   | [Apache SkyWalking文档](https://skywalking.apache.org/docs/)                                        | 链路追踪、网格分析、度量聚合、可视化         |
 | 
			
		||||
| 分布式任务调度  | Xxl-Job             | [Xxl-Job官网](https://www.xuxueli.com/xxl-job/)                                                     | 高性能 高可靠 易扩展                |
 | 
			
		||||
| 文件存储     | Minio               | [Minio文档](https://docs.min.io/)                                                                   | 本地存储                       |
 | 
			
		||||
| 文件存储     | 七牛、阿里、腾讯            | [OSS使用文档](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=4359146&doc_id=1469725) | 云存储                        |
 | 
			
		||||
| 短信模块     | 阿里、腾讯               | [短信使用文档](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=5578491&doc_id=1469725)  | 短信发送                       |
 | 
			
		||||
| 文件存储     | 七牛、阿里、腾讯            | [OSS使用文档](https://javalionli.gitee.io/plus-doc/#/ruoyi-vue-plus/framework/basic/oss) | 云存储                        |
 | 
			
		||||
| 短信模块     | 阿里、腾讯               | [短信使用文档](https://javalionli.gitee.io/plus-doc/#/ruoyi-vue-plus/framework/extend/sms)  | 短信发送                       |
 | 
			
		||||
| 监控框架     | SpringBoot-Admin    | [SpringBoot-Admin文档](https://codecentric.github.io/spring-boot-admin/current/)                    | 全方位服务监控                    |
 | 
			
		||||
| 校验框架     | Validation          | [Validation文档](https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/)    | 增强接口安全性、严谨性 支持国际化          |
 | 
			
		||||
| Excel框架  | Alibaba EasyExcel   | [EasyExcel文档](https://www.yuque.com/easyexcel/doc/easyexcel)                                      | 性能优异 扩展性强                  |
 | 
			
		||||
| 文档框架     | SpringDoc、javadoc   | [接口文档](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=5805266&doc_id=1469725)    | 无注解零入侵基于java注释             |
 | 
			
		||||
| 文档框架     | SpringDoc、javadoc   | [接口文档](https://javalionli.gitee.io/plus-doc/#/ruoyi-vue-plus/framework/association/doc)    | 无注解零入侵基于java注释             |
 | 
			
		||||
| 工具类框架    | Hutool、Lombok       | [Hutool文档](https://www.hutool.cn/docs/)                                                           | 减少代码冗余 增加安全性               |
 | 
			
		||||
| 代码生成器    | 适配MP、SpringDoc规范化代码 | [代码生成文档](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=5522329&doc_id=1469725)  | 一键生成前后端代码                  |
 | 
			
		||||
| 代码生成器    | 适配MP、SpringDoc规范化代码 | [代码生成文档](https://javalionli.gitee.io/plus-doc/#/ruoyi-vue-plus/framework/basic/code_generate)  | 一键生成前后端代码                  |
 | 
			
		||||
| 部署方式     | Docker              | [Docker文档](https://docs.docker.com/)                                                              | 容器编排 一键部署业务集群              |
 | 
			
		||||
| 国际化      | SpringMessage       | [SpringMVC文档](https://docs.spring.io/spring-framework/docs/current/reference/html/web.html#mvc)   | Spring标准国际化方案              |
 | 
			
		||||
 | 
			
		||||
@@ -59,21 +59,21 @@
 | 
			
		||||
 | 
			
		||||
使用框架前请仔细阅读文档重点注意事项
 | 
			
		||||
<br>
 | 
			
		||||
>[初始化项目 必看](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=4164117&doc_id=1469725)
 | 
			
		||||
>>[https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=4164117&doc_id=1469725](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=4164117&doc_id=1469725)
 | 
			
		||||
>[初始化项目 必看](https://javalionli.gitee.io/plus-doc/#/ruoyi-vue-plus/quickstart/init)
 | 
			
		||||
>>[https://javalionli.gitee.io/plus-doc/#/ruoyi-vue-plus/quickstart/init](https://javalionli.gitee.io/plus-doc/#/ruoyi-vue-plus/quickstart/init)
 | 
			
		||||
>
 | 
			
		||||
>[专栏与视频 入门必看](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=5473272&doc_id=1469725)
 | 
			
		||||
>>[https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=5473272&doc_id=1469725](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=5473272&doc_id=1469725)
 | 
			
		||||
>[专栏与视频 入门必看](https://javalionli.gitee.io/plus-doc/#/common/column)
 | 
			
		||||
>>[https://javalionli.gitee.io/plus-doc/#/common/column](https://javalionli.gitee.io/plus-doc/#/common/column)
 | 
			
		||||
>
 | 
			
		||||
>[部署项目 必看](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=4219382&doc_id=1469725)
 | 
			
		||||
>>[https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=4219382&doc_id=1469725](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=4219382&doc_id=1469725)
 | 
			
		||||
>[部署项目 必看](https://javalionli.gitee.io/plus-doc/#/ruoyi-vue-plus/quickstart/deploy)
 | 
			
		||||
>>[https://javalionli.gitee.io/plus-doc/#/ruoyi-vue-plus/quickstart/deploy](https://javalionli.gitee.io/plus-doc/#/ruoyi-vue-plus/quickstart/deploy)
 | 
			
		||||
> 
 | 
			
		||||
>[参考文档 Wiki](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages)
 | 
			
		||||
>>[https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages)
 | 
			
		||||
>[参考文档 Wiki](https://javalionli.gitee.io/plus-doc)
 | 
			
		||||
>>[https://javalionli.gitee.io/plus-doc](https://javalionli.gitee.io/plus-doc)
 | 
			
		||||
 | 
			
		||||
## 软件架构图
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||

 | 
			
		||||
## 贡献代码
 | 
			
		||||
 | 
			
		||||
欢迎各路英雄豪杰 `PR` 代码 请提交到 `dev` 开发分支 统一测试发版
 | 
			
		||||
@@ -86,11 +86,11 @@
 | 
			
		||||
* GitHub 地址 [RuoYi-Vue-Plus-github](https://github.com/JavaLionLi/RuoYi-Vue-Plus)
 | 
			
		||||
* 前端项目 地址 [plus-ui](https://gitee.com/JavaLionLi/plus-ui)
 | 
			
		||||
* 微服务 分支 [RuoYi-Cloud-Plus](https://gitee.com/JavaLionLi/RuoYi-Cloud-Plus)
 | 
			
		||||
* 用户扩展项目 [扩展项目列表](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=4478302&doc_id=1469725)
 | 
			
		||||
* 用户扩展项目 [扩展项目列表](https://javalionli.gitee.io/plus-doc/#/ruoyi-vue-plus/extend-project/list)
 | 
			
		||||
 | 
			
		||||
## 加群与捐献
 | 
			
		||||
>[加群与捐献](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/加群与捐献?sort_id=4104598)
 | 
			
		||||
>>[https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/加群与捐献?sort_id=4104598](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/加群与捐献?sort_id=4104598)
 | 
			
		||||
>[加群与捐献](https://javalionli.gitee.io/plus-doc/#/ruoyi-vue-plus/other/group_chat)
 | 
			
		||||
>>[https://javalionli.gitee.io/plus-doc/#/ruoyi-vue-plus/other/group_chat](https://javalionli.gitee.io/plus-doc/#/ruoyi-vue-plus/other/group_chat)
 | 
			
		||||
 | 
			
		||||
## 捐献作者
 | 
			
		||||
作者为兼职做开源,平时还需要工作,如果帮到了您可以请作者吃个盒饭  
 | 
			
		||||
 
 | 
			
		||||
@@ -9,7 +9,7 @@ export default {
 | 
			
		||||
  name: 'RuoYiDoc',
 | 
			
		||||
  data() {
 | 
			
		||||
    return {
 | 
			
		||||
      url: 'https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages'
 | 
			
		||||
      url: 'https://javalionli.gitee.io/plus-doc'
 | 
			
		||||
    }
 | 
			
		||||
  },
 | 
			
		||||
  methods: {
 | 
			
		||||
 
 | 
			
		||||
@@ -64,7 +64,7 @@
 | 
			
		||||
            size="mini"
 | 
			
		||||
            icon="el-icon-cloudy"
 | 
			
		||||
            plain
 | 
			
		||||
            @click="goTarget('https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/wikis/pages?sort_id=4106467&doc_id=1469725')"
 | 
			
		||||
            @click="goTarget('https://javalionli.gitee.io/plus-doc/#/ruoyi-vue-plus/changlog')"
 | 
			
		||||
          >更新日志</el-button
 | 
			
		||||
          >
 | 
			
		||||
        </p>
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user