浏览代码

docs: 统一图片路径和命名规则 (#359)

danny 5 年之前
父节点
当前提交
60e734d431
共有 43 个文件被更改,包括 30 次插入30 次删除
  1. 7 7
      README.md
  2. 1 1
      doc/FAQ.md
  3. 7 7
      doc/api.md
  4. 0 0
      doc/conf/nginx.conf
  5. 二进制
      doc/pic1/1-3.png
  6. 二进制
      doc/pic1/1-5.png
  7. 二进制
      doc/pic1/1-6.png
  8. 二进制
      doc/pic1/1-7.png
  9. 0 0
      doc/pics/admin/get.png
  10. 0 0
      doc/pics/admin/get_no_token.png
  11. 0 0
      doc/pics/admin/get_with_token.png
  12. 0 0
      doc/pics/admin/login.png
  13. 0 0
      doc/pics/admin/post_no_token.png
  14. 0 0
      doc/pics/admin/post_with_token.png
  15. 0 0
      doc/pics/faq/excluded.png
  16. 0 0
      doc/pics/platform/db-main.png
  17. 0 0
      doc/pics/platform/mybatis-generator.png
  18. 0 0
      doc/pics/platform/order-status.png
  19. 0 0
      doc/pics/project/deploy-single.png
  20. 0 0
      doc/pics/project/develop-stage.png
  21. 0 0
      doc/pics/project/idea-maven-insatll.png
  22. 0 0
      doc/pics/project/idea-run-all.png
  23. 0 0
      doc/pics/project/maven-profile.png
  24. 0 0
      doc/pics/project/online-deploy.png
  25. 0 0
      doc/pics/project/project-structure.png
  26. 0 0
      doc/pics/project/security-group.png
  27. 0 0
      doc/pics/project/spring-profile.png
  28. 0 0
      doc/pics/project/stage.png
  29. 0 0
      doc/pics/project/yml-resource.png
  30. 0 0
      doc/pics/readme/admin-dashboard.png
  31. 0 0
      doc/pics/readme/litemall_wx_demo.png
  32. 0 0
      doc/pics/readme/mobmall.png
  33. 0 0
      doc/pics/readme/project-structure.png
  34. 0 0
      doc/pics/readme/qq2.png
  35. 0 0
      doc/pics/readme/renard_wx_demo.png
  36. 0 0
      doc/pics/readme/technology-stack.png
  37. 3 3
      doc/platform.md
  38. 12 12
      doc/project.md
  39. 0 0
      doc/unused/3.png
  40. 0 0
      doc/unused/5.gif
  41. 0 0
      doc/unused/litemall.ico
  42. 0 0
      doc/unused/litemall.png
  43. 0 0
      doc/unused/qq.png

+ 7 - 7
README.md

@@ -15,13 +15,13 @@ litemall = Spring Boot后端 + Vue管理员前端 + 微信小程序用户前端
 
 * renard-wx模块实例
 
-![](./doc/pic/renard_wx_demo.png)    
+![](./doc/pics/readme/renard_wx_demo.png)
 
 > 注意:此实例是真实小商场,开发者可以购买商品和付款,但请不要尝试退款操作。
 
 * litemall-wx模块实例
 
-![](./doc/pic/litemall_wx_demo.png)    
+![](./doc/pics/readme/litemall_wx_demo.png)
 
 > 注意:此实例是测试小商场,开发者请不要尝试购买商品、付款、退款操作。
 
@@ -29,7 +29,7 @@ litemall = Spring Boot后端 + Vue管理员前端 + 微信小程序用户前端
 
 请手机扫描以下二维码访问:
 
-![](./doc/pic/mobmall.png)    
+![](./doc/pics/readme/mobmall.png)
 
 或者浏览器采用手机模式访问以下网址: [http://122.51.199.160:8080/vue/index.html#/](http://122.51.199.160:8080/vue/index.html#/)
 
@@ -39,7 +39,7 @@ litemall = Spring Boot后端 + Vue管理员前端 + 微信小程序用户前端
 
 ### 管理后台实例
 
-![](./doc/pic/4.png)    
+![](./doc/pics/readme/admin-dashboard.png)
 
 1. 浏览器打开,输入以下网址: [http://122.51.199.160:8080/#/login](http://122.51.199.160:8080/#/login)
 2. 管理员用户名`admin123`,管理员密码`admin123`
@@ -51,7 +51,7 @@ litemall = Spring Boot后端 + Vue管理员前端 + 微信小程序用户前端
 * [GitHub](https://github.com/linlinjava/litemall)
 
 ## 项目架构
-![](./doc/pic/1.png)    
+![](./doc/pics/readme/project-structure.png)
 
 ## 技术栈
 
@@ -59,7 +59,7 @@ litemall = Spring Boot后端 + Vue管理员前端 + 微信小程序用户前端
 > 2. Vue
 > 3. 微信小程序
 
-![](doc/pic/2.png)    
+![](doc/pics/readme/technology-stack.png)
 
 ## 功能
 
@@ -233,7 +233,7 @@ V 3.0.0 完成以下目标:
 
 ## 问题
 
-![](doc/pic/qq2.png)
+![](doc/pics/readme/qq2.png)
 
  * 开发者有问题或者好的建议可以用Issues反馈交流,请给出详细信息
  * 在开发交流群中应讨论开发、业务和合作问题

+ 1 - 1
doc/FAQ.md

@@ -275,7 +275,7 @@ node_modules是litemall-admin和litemall-vue模块所依赖的项目库,可能
 2. 然后分别创建空的node_modules文件夹;
 3. 重新打开IDEA,分别设置litemall-admin模块和litemall-vue模块的node_modules文件夹Excluded状态。
 
-![](./pic/excluded.png)    
+![](./pics/faq/excluded.png)
 
 ### 4.2 项目war打包
 

+ 7 - 7
doc/api.md

@@ -355,7 +355,7 @@ API应该存在版本控制,以保证兼容性。
 
 例如测试2.4.2节商品详情API
 
-![](./pic/get.png)    
+![](./pics/admin/get.png)
 
 #### 1.8.2 GET & Token 示例
 
@@ -365,15 +365,15 @@ API应该存在版本控制,以保证兼容性。
 
 如果没有登录,则返回未登录信息
 
-![](./pic/get_no_token.png)
+![](./pics/admin/get_no_token.png)
 
 因此测试这些API,需要先登录
 
-![](./pic/login.png)
+![](./pics/admin/login.png)
 
 然后,采用自定义`X-Litemall-Token`来携带token访问商场API
 
-![](./pic/get_with_token.png)
+![](./pics/admin/get_with_token.png)
 
 注意:
 > 访问受保护商场API是采用自定义`X-Litemall-Token`头部;
@@ -387,15 +387,15 @@ API应该存在版本控制,以保证兼容性。
 
 如果需要登录才能提交数据,则需要先向后端请求登录,得到token,然后请求时携带token。
 
-![](./pic/post_no_token.png)
+![](./pics/admin/post_no_token.png)
 
 因此测试这些API,需要先登录
 
-![](./pic/login.png)
+![](./pics/admin/login.png)
 
 然后,采用自定义`X-Litemall-Token`来携带token访问商场API
 
-![](./pic/get_with_token.png)
+![](./pics/admin/get_with_token.png)
 
 注意:
 > 访问受保护商场API是采用自定义`X-Litemall-Token`头部;

doc/pic/nginx.conf → doc/conf/nginx.conf


二进制
doc/pic1/1-3.png


二进制
doc/pic1/1-5.png


二进制
doc/pic1/1-6.png


二进制
doc/pic1/1-7.png


doc/pic/get.png → doc/pics/admin/get.png


doc/pic/get_no_token.png → doc/pics/admin/get_no_token.png


doc/pic/get_with_token.png → doc/pics/admin/get_with_token.png


doc/pic/login.png → doc/pics/admin/login.png


doc/pic/post_no_token.png → doc/pics/admin/post_no_token.png


doc/pic/post_with_token.png → doc/pics/admin/post_with_token.png


doc/pic/excluded.png → doc/pics/faq/excluded.png


doc/pic2/2-2.png → doc/pics/platform/db-main.png


doc/pic2/2-3.png → doc/pics/platform/mybatis-generator.png


doc/pic2/2-1.png → doc/pics/platform/order-status.png


doc/pic1/1-11.png → doc/pics/project/deploy-single.png


doc/pic1/1-2.png → doc/pics/project/develop-stage.png


doc/pic1/1-8.png → doc/pics/project/idea-maven-insatll.png


doc/pic1/1-9.png → doc/pics/project/idea-run-all.png


doc/pic1/1-13.png → doc/pics/project/maven-profile.png


doc/pic1/1-12.png → doc/pics/project/online-deploy.png


doc/pic1/1-1.png → doc/pics/project/project-structure.png


doc/pic1/1-4.png → doc/pics/project/security-group.png


doc/pic1/1-14.png → doc/pics/project/spring-profile.png


doc/pic1/1-10.png → doc/pics/project/stage.png


doc/pic1/1-15.png → doc/pics/project/yml-resource.png


doc/pic/4.png → doc/pics/readme/admin-dashboard.png


doc/pic/litemall_wx_demo.png → doc/pics/readme/litemall_wx_demo.png


doc/pic/mobmall.png → doc/pics/readme/mobmall.png


doc/pic/1.png → doc/pics/readme/project-structure.png


doc/pic/qq2.png → doc/pics/readme/qq2.png


doc/pic/renard_wx_demo.png → doc/pics/readme/renard_wx_demo.png


doc/pic/2.png → doc/pics/readme/technology-stack.png


+ 3 - 3
doc/platform.md

@@ -183,7 +183,7 @@ litemall_region表保存了行政区域信息,包括省级、市级、县级
 
 #### 2.1.4.1 订单状态
 
-![](pic2/2-1.png)
+![](./pics/platform/order-status.png)
 
 订单分成几种基本的状态:
 
@@ -587,7 +587,7 @@ litemall-db模块是一个普通的Spring Boot应用,基于mybatis框架实现
 * Mybatis Generator
 * Mybatis Generator非官方插件mybatis-generator-plugin
 
-![](./pic2/2-2.png)
+![](./pics/platform/db-main.png)
 
 这里litemall-db模块可以分成以下几种代码:
 
@@ -610,7 +610,7 @@ mybatis数据库访问代码是指dao接口代码、dao数据库XML文件和doma
 
 #### 2.2.1.1 自动生成代码
 
-![](./pic2/2-3.png)
+![](./pics/platform/mybatis-generator.png)
 
 如上图所示,双击`mybatis-generator:generate`,则mybatis generator插件会:
 

+ 12 - 12
doc/project.md

@@ -4,7 +4,7 @@
 
 litemall是一个简单的商场系统,基于现有的开源项目,重新实现一个完整的前后端项目,包含小程序客户端、移动客户端和网页管理端。
 
-![](./pic1/1-1.png)    
+![](./pics/project/project-structure.png)
 
 
 项目的架构是四个系统和九个模块:
@@ -236,7 +236,7 @@ Spring Boot技术栈参考以下文档或者项目:
 
 接下来,从项目的开发、部署(测试)和上线三个阶段介绍litemall。
 
-![](pic1/1-10.png)
+![](./pics/project/stage.png)
 
 首先需要明确的是三个不同阶段:
 
@@ -277,7 +277,7 @@ Spring Boot技术栈参考以下文档或者项目:
 
 ## 1.4 开发方案
 
-![](pic1/1-2.png)
+![](./pics/project/develop-stage.png)
 
 如图所示,当前开发阶段的方案:
 
@@ -336,7 +336,7 @@ flush privilege
    
    或者采用IDEA的Maven插件安装本项目依赖库,点击`install`
 
-    ![](pic1/1-8.png)
+    ![](./pics/project/idea-maven-insatll.png)
 
 7. 采用Maven命令编译本项目
 
@@ -363,7 +363,7 @@ flush privilege
    如果采用IDEA,则litemall-all模块的Application类
    右键` Run Application.main()`方式运行该模块,
    
-   ![](pic1/1-9.png)
+   ![](./pics/project/idea-run-all.png)
    
    打开浏览器,输入
     ```
@@ -826,7 +826,7 @@ litemall:
 
 主要流程是:创建云服务器,安装ubuntu操作系统,按照JDK和MySQL应用运行环境,部署单一Spring Boot服务。
 
-![](pic1/1-11.png)
+![](./pics/project/deploy-single.png)
 
 #### 1.5.1.1 云服务器
 
@@ -841,7 +841,7 @@ litemall:
 
 3. 创建安全组
 
-    ![](pic1/1-4.png)
+    ![](./pics/project/security-group.png)
 
     目前允许的端口:8080,80,443,22,3306
     
@@ -1037,7 +1037,7 @@ cd litemall
 * 提供管理后台前端所需要的数据;
 * 提供小商城前端所需要的数据。
 
-![](pic1/1-12.png)
+![](./pics/project/online-deploy.png)
 
 
 开发者可以基于自身业务采用其他上线方案。
@@ -1160,7 +1160,7 @@ http://www.example.com
 总结,经过以上不同方面的配置,nginx这里最终的配置是如下:
 1. 证书`1_www.example.com_bundle.crt`和`2_www.example.com.key`放置在
     `/etc/nginx/`文件夹内。
-2. 把`/etc/nginx/nginx.conf`文件进行修改,具体可以参考[本项目的nginx.conf](./pic/nginx.conf)
+2. 把`/etc/nginx/nginx.conf`文件进行修改,具体可以参考[本项目的nginx.conf](./conf/nginx.conf)
 3. 重启nginx
 
 注意:
@@ -1423,9 +1423,9 @@ application配置文件中,但是问题就是数据库信息一旦改变则其
 3. 上线阶段,同样地,在litemall.jar包同级目录创建上线配置文件。
 
 此外,这里还可以采用另外一种思路,如下图:
-![](pic1/1-13.png)
-![](pic1/1-14.png)
-![](pic1/1-15.png)
+![](./pics/project/maven-profile.png)
+![](./pics/project/spring-profile.png)
+![](./pics/project/yml-resource.png)
 
 其实原理也很简单,就是配置文件采用application-{module}-{profile}.yml来支持不同模块不同阶段的配置需求。
 

doc/pic/3.png → doc/unused/3.png


doc/pic/5.gif → doc/unused/5.gif


doc/pic/litemall.ico → doc/unused/litemall.ico


doc/pic/litemall.png → doc/unused/litemall.png


doc/pic/qq.png → doc/unused/qq.png