feat: redesign doc pages (#153)

.gitignore

@@ -3,4 +3,6 @@
 .idea/**
 **/.DS_Store
 drivers/**
-temp/**
+temp/**
+node_modules/
+.cache/

docs/_coverpage.md

@@ -3,5 +3,5 @@
 > "致力于提供一个简单易用的数据库文档管理平台！" 
 
 [GitHub](https://github.com/vran-dev/databasir)
-[快速开始](README.md)
+[快速开始](/guid/index.md)
 

docs/_navbar.md

@@ -0,0 +1,7 @@
+* 入门指南
+    * [快速开始](/guid/index.md)
+    * [常见问题](/faq/index.md)
+    * [更新日志](/changelog/index.md)
+* [参与开发](/develop/index.md)
+
+* [捐赠](/donate/index.md)

docs/_sidebar.md

@@ -1,32 +0,0 @@
-* 快速开始
-  * [项目特性](README.md)
-* 系统部署
-    * [Jar 包部署](README/deploy/jar-deploy.md)
-    * [Docker 部署](README/deploy/docker-deploy.md)
-
-* 基本概念
-    * [角色与权限](README/user-role/user-role.md)
-    * [分组与项目](README/group-and-project/index.md)
-
-* 基础操作
-    * [分组管理](README/management-group/index.md)
-    * [项目管理](README/management-project/index.md)
-    * [文档管理](README/management-document/index.md)
-    * [用户管理](README/management-user/index.md)
-    * [邮箱设置](README/management-email/index.md)
-    
-* 进阶操作
-    * [启用 Github 第三方认证登录](README/github-oauth2/github-oauth2.md)
-    * [启用 Gitlab 第三方认证登录](README/gitlab-oauth2/gitlab-oauth2.md)
-    * [零代码扩展受支持的数据库类型](README/database-extension/database-extension.md)
-    * [数据库模板列表](README/database-type-list/index.md)
-    * [Mock Insert SQL 生成](README/mock-sql/index.md)
-    
-* 参与开发
-    * [构建指南](README/develop/build/index.md)
-    * [模块和包](README/develop/module-and-package/index.md)
-    * 登录授权流程
-      * [用户名密码登录流程](README/develop/login-and-auth/username-and-password/index.md)
-    
-* 捐赠
-

docs/changelog/_sidebar.md

@@ -0,0 +1 @@
+* [变更记录](/changelog/index.md)

docs/changelog/index.md

@@ -0,0 +1,77 @@
+# changelog
+
+## v1.0.4
+feature
+
+- feature：表文档中”可空”采用 YES/NO 展示
+- feature：表文档中”默认值”为 null 时采用红色 tag 展示
+- feature：支持上传本地驱动
+- feature：文档侧边栏支持按颜色显示版本差异
+- feature：点击分组卡片即可跳转到项目列表页
+- feature：登录应用采用卡片替代表格展示
+- feature：UI 细节优化，采用响应式布局
+
+bug fix
+
+- bug-fix：hive 同步表结构时出现异常导致失败
+- bug-fix：oracle 同步表时数据为空
+- bug-fix：自定义驱动配置连接属性未生效
+
+ref
+
+- refactor：重构版本差异接口逻辑
+
+Full Changelog: [v1.0.3...v1.0.4](https://github.com/vran-dev/databasir/compare/v1.0.3...v1.0.4)
+
+## v1.0.3
+feature
+
+- feature：重新设计同步任务列表
+- feature：支持取消同步中的任务
+- feature：文档页面添加【回到顶部】按钮
+- feature：内置 mysql、oracle、sqlserver、postgresql、mariaDB 数据库模板
+- feature：支持通过 JSON 导入数据库模板
+- feature：创建分组、项目时的【描述】字段由必填改为可选
+- feature：优化页面 UI 多个细节
+
+bug fix
+
+- bug-fix：并发同步任务时概率出现版本冲突
+- bug-fix：markdown 文档导出时出现 NPE
+- bug-fix：部分数据库（oracle、达梦）同步文档失败
+- bug-fix：同步表超过 1000+ 时出现 cursor limit
+
+Full Changelog: [v1.0.2...v1.0.3](https://github.com/vran-dev/databasir/compare/v1.0.2...v1.0.3)
+
+## v1.0.2
+
+feature
+
+- feature；UML 图片导出支持 svg 格式
+- feature；表目录列表支持按表名、注释名搜索
+- feature；表文档页面新增注释展示
+- feature；数据库扩展支持自动获取驱动类名
+- feature：数据库元数据同步采用异步任务设计，解决大数据量同步超时问题
+- feature：文档内容采用分组加载，解决大数据量加载超时问题
+- feature：文档默认模板统一改为中文
+
+security
+
+- security：对上传的驱动 jar 包新增规则校验
+- security：采用可配置（默认随机）的 jwt token secret
+
+Full Changelog: [v1.0.1...v1.0.2](https://github.com/vran-dev/databasir/compare/v1.0.1...v1.0.2)
+
+## v1.0.1
+feature
+
+- feature：重新设计文档模板编辑功能
+- feature：优化文档页面样式
+
+bug fix
+
+- bug fix：邮件线程池配置导致系统启动失败
+- bug fix：Diff 引擎异常导致文档同步失败
+- bug fix：部分浏览器复制 Insert SQL 会出现不兼容情况
+
+Full Changelog: [v1.0.0...v1.0.1](https://github.com/vran-dev/databasir/compare/v1.0.0...v1.0.1)

docs/develop/_sidebar.md

@@ -0,0 +1,8 @@
+* 构建指南
+    * [后端构建](/develop/build/index.md)
+
+* 系统架构
+    * [模块和包](/develop/module-and-package/index.md)
+
+* 系统原理
+    * [用户名密码登录流程](/develop/login-and-auth/username-and-password/index.md)

docs/develop/index.md

@@ -0,0 +1,3 @@
+# 参与开发
+
+// TODO 系统设计文档正在逐步完善中...

docs/develop/module-and-package/index.md

@@ -1,4 +1,4 @@
-# 项目模块
+## 后端模块概览
 
 Databasir 基于 Gradle 进行模块管理，当前共有 5 个模块
 

docs/donate/_sidebar.md

@@ -0,0 +1 @@
+* [捐赠](/donate/index.md)

docs/donate/index.md

@@ -0,0 +1,9 @@
+## 捐赠方式
+
+开源不易，扶我起来吧！再写两行
+
+<img src="../img/sponsor.jpg" width="280">
+
+## 扫码加群
+
+<img src="../img/qrcode-group.jpg" width="280">

docs/faq/_sidebar.md

@@ -0,0 +1 @@
+* [常见问题](/faq/index.md)

docs/faq/index.md

@@ -0,0 +1,25 @@
+## Mysql
+
+- 如何填写 database 和 schema ？
+
+在 Mysql 中两者概念其实是一样的，都是数据库名称，填一样的就可以了
+
+- 文档同步完成以后没有注释信息
+
+这是 MYSQL 官方 JDBC 驱动的限制，需要在项目编辑页面的连接属性中添加 `useInformationSchema=true`
+
+## Oracle
+- 文档同步完成以后没有注释信息
+
+这是 Oracle 官方 JDBC 驱动的限制，需要在项目编辑页面的连接属性中添加 `remarksReporting = true`
+
+
+## Postgresql
+- Postgresql 的 schema 该怎么填写？
+
+如果项目没有做特殊的设置，那么 postgresql 的默认 schema 名称是 `public`
+
+## SQL Server
+- Sql Server 的 database 该怎么填写？
+
+如果项目没有做特殊的设置，那么 Sql Server 的默认 database 名称是 `master`

docs/guid/_sidebar.md

@@ -0,0 +1,24 @@
+* 项目说明
+    * [](/guid/index.md)
+
+* 系统部署
+    * [Jar 包部署](/guid/deploy/jar-deploy.md)
+    * [Docker 部署](/guid/deploy/docker-deploy.md)
+
+* 基本概念
+    * [角色与权限](/guid/concept-user-role/user-role.md)
+    * [分组与项目](/guid/concept-group-project/index.md)
+
+* 基础操作
+    * [分组管理](/guid/management-group/index.md)
+    * [项目管理](/guid/management-project/index.md)
+    * [文档管理](/guid/management-document/index.md)
+    * [用户管理](/guid/management-user/index.md)
+    * [邮箱设置](/guid/management-email/index.md)
+
+* 进阶操作
+    * [启用 Github 第三方认证登录](/guid/advance-github-oauth2/github-oauth2.md)
+    * [启用 Gitlab 第三方认证登录](/guid/advance-gitlab-oauth2/gitlab-oauth2.md)
+    * [扩展更多数据库类型](/guid/advance-database-extension/database-extension.md)
+    * [数据库模板列表](/guid/advance-database-type-list/index.md)
+    * [Mock Insert SQL 生成](/guid/advance-mock-sql/index.md)

docs/guid/advance-database-extension/database-extension.md

@@ -1,4 +1,4 @@
-# 零代码扩展受支持的数据库类型
+# 扩展更多数据库类型
 
 ## 说明
 
@@ -11,11 +11,36 @@
 | mysql      | 8.0.27   | com.mysql.cj.jdbc.Driver |
 | postgresql | 42.3.1   | org.postgresql.Driver    |
 
-对于其它数据库（有 JDBC 驱动）或者你想切换不同版本的内置数据库驱动，只需要简单的配置就可以实现
+对于其它数据库（有 JDBC 驱动），用户可以通过导入的方式实现扩展。
 
-## 配置
+## 内置模板导入
 
-由于数据库类型是全平台可用的，所以限制了只有【系统管理员】权限才能新增数据库类型。
+在数据库的扩展中已将以下数据库模板实行了内置，用户可以按需添加
+
+- mysql
+- postgresql
+- sqlserver
+- oracle
+- mariaDB
+
+![img.png](img/inner-template.png)
+
+当然这并不是说 Databasir 只支持这几款数据库，而是这些数据库经过了测试是可以使用的。
+随着测试的扩展，内置模板的数量将会越来越多。
+
+## 第三方模板 JSON 导入
+
+有很多社区的模板没有被内置到 Databasir 中，用户可以通过分享 JSON 的形式进行导入
+
+[点击查看](/guid/advance-database-type-list/index) JSON 模板示例 
+
+![img.png](img/json-import.png)
+
+## 自定义配置
+
+如果用户有一定的 Java 技术背景，则可以通过填写表单的形式进行扩展。
+
+数据库类型是全平台可用的，所以限制了只有【系统管理员】权限才能新增数据库类型。
 
 通过菜单我们进入【数据库类型】配置页面
 

docs/guid/deploy/docker-deploy.md

@@ -16,7 +16,7 @@ GET /live
 
 ## 部署流程
 
-1.  拉取最新版镜像，当然你也可以将 latest 替换成你想要得版本号，具体有哪些镜像版本可以拉取可以在[这里](https://registry.hub.docker.com/r/vrantt/databasir)查看
+1.  拉取镜像（更多版本[点击这里](https://registry.hub.docker.com/r/vrantt/databasir)查看）
 
 ```shell
 docker pull vrantt/databasir:latest

docs/guid/deploy/jar-deploy.md

@@ -45,7 +45,7 @@ java -jar databasir.jar --databasir.db.url=127.0.0.1:3306 --databasir.db.usernam
 
 
 
-## 通过配置文件指定参数
+## 配置文件
 
 除了在命令行指定参数启动外，还可以通过配置文件来保存
 

docs/guid/index.md

@@ -0,0 +1,64 @@
+## 项目概览
+
+![](../../databasir.png) 是面向团队的**关系型数据库模型文档管理平台**，旨在通过自动化的方式解决模型文档管理过程中维护成本高、内容更新不及时以及团队协作复杂等问题。
+
+问题反馈：https://github.com/vran-dev/databasir/issues
+
+## 在线演示
+
+在线演示：[http://demo.databasir.com](http://demo.databasir.com)
+
+| 账号 | 密码    | 角色       |
+| ---- | ------- | ---------- |
+| demo | demo123 | 系统管理员 |
+| dev  | dev123  | 普通       |
+
+
+<!-- tabs:start -->
+
+#### **微信群**
+
+扫码加入微信群，随时获取第一手更新内容
+
+<img src="https://s2.loli.net/2022/05/04/c2b5O7yEgB6Yvpo.jpg" width="250px" />
+
+#### **公众号**
+
+![qrcode.jpg](https://s2.loli.net/2022/04/22/mZjlG5u4vrXW1SL.jpg)
+
+#### **邮箱**
+
+vran_dev@foxmail.com
+
+<!-- tabs:end -->
+
+## 多图展示
+
+<!-- tabs:start -->
+
+#### **文档同步**
+
+![sync.gif](https://s2.loli.net/2022/04/22/aoiSR1V3MuN67m8.gif)
+
+#### **版本对比**
+
+![](index/diff.gif)
+
+#### **文档导出**
+
+- UML 图片导出
+
+![](index/uml-export.gif)
+
+- 导出 Markdown 格式展示
+
+![](index/markdown-exported.gif)
+
+<!-- tabs:end -->
+
+## 捐赠
+
+开源不易，扶我起来，再写两行！
+
+<img src="img/sponsor.jpg" width="280">
+

docs/guid/management-document/index.md

@@ -4,15 +4,11 @@ Databasir 支持多种类型的文档格式导出，该功能位于文档详情
 
 ![](img/project-export1.png)
 
-
-
 进入文档页面以后，鼠标指向**导出**按钮即可显示出目前支持的文档导出格式
 
 ![](img/project-export2.png)
 
-
-
-## 版本差异对比 
+## 版本差异对比
 
 如果成功同步了多个版本的文档，你可以随意的选择版本进行差异对比。
 
@@ -43,14 +39,12 @@ Databasir 支持多种类型的文档格式导出，该功能位于文档详情
 
 切换到修改表的地方，可以查看具体的修改内容，比如下图就展示了
 
-- type 字段的类型由  text 改为了 varchar
+- type 字段的类型由 text 改为了 varchar
 - comment 字段的类型由 text 改为了 varchar
 
 ![](img/doc-diff5.png)
 
-
-
-## 自定义文档模板
+## 自定义文档模板（即将废弃）
 
 目前 Databasir 的文档主要是以表格形式进行内容展示，包括了以下内容
 
@@ -68,8 +62,6 @@ Databasir 支持多种类型的文档格式导出，该功能位于文档详情
 
 ![](img/template-edit1.png)
 
-
-
 点击就会跳转编辑页面，就能跳转入模板的编辑页。
 
 注意我用红框框起来的表头，这些都是可以编辑的