diff --git a/.gitignore b/.gitignore index 1d77872..376ce4e 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,6 @@ .idea/** **/.DS_Store drivers/** -temp/** \ No newline at end of file +temp/** +node_modules/ +.cache/ diff --git a/docs/_coverpage.md b/docs/_coverpage.md index 70dc47d..514f97d 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -3,5 +3,5 @@ > "致力于提供一个简单易用的数据库文档管理平台！" [GitHub](https://github.com/vran-dev/databasir) -[快速开始](README.md) +[快速开始](/guid/index.md) diff --git a/docs/_navbar.md b/docs/_navbar.md new file mode 100644 index 0000000..3f749cf --- /dev/null +++ b/docs/_navbar.md @@ -0,0 +1,7 @@ +* 入门指南 + * [快速开始](/guid/index.md) + * [常见问题](/faq/index.md) + * [更新日志](/changelog/index.md) +* [参与开发](/develop/index.md) + +* [捐赠](/donate/index.md) \ No newline at end of file diff --git a/docs/_sidebar.md b/docs/_sidebar.md deleted file mode 100644 index c770080..0000000 --- a/docs/_sidebar.md +++ /dev/null @@ -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) - -* 捐赠 - diff --git a/docs/changelog/_sidebar.md b/docs/changelog/_sidebar.md new file mode 100644 index 0000000..e0767dd --- /dev/null +++ b/docs/changelog/_sidebar.md @@ -0,0 +1 @@ +* [变更记录](/changelog/index.md) \ No newline at end of file diff --git a/docs/changelog/index.md b/docs/changelog/index.md new file mode 100644 index 0000000..2005261 --- /dev/null +++ b/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) \ No newline at end of file diff --git a/docs/develop/_sidebar.md b/docs/develop/_sidebar.md new file mode 100644 index 0000000..f856971 --- /dev/null +++ b/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) diff --git a/docs/develop/index.md b/docs/develop/index.md new file mode 100644 index 0000000..fb07519 --- /dev/null +++ b/docs/develop/index.md @@ -0,0 +1,3 @@ +# 参与开发 + +// TODO 系统设计文档正在逐步完善中... diff --git a/docs/README/develop/login-and-auth/index.md b/docs/develop/login-and-auth/index.md similarity index 100% rename from docs/README/develop/login-and-auth/index.md rename to docs/develop/login-and-auth/index.md diff --git a/docs/README/develop/login-and-auth/username-and-password/img/1-filter.png b/docs/develop/login-and-auth/username-and-password/img/1-filter.png similarity index 100% rename from docs/README/develop/login-and-auth/username-and-password/img/1-filter.png rename to docs/develop/login-and-auth/username-and-password/img/1-filter.png diff --git a/docs/README/develop/login-and-auth/username-and-password/img/2-username-and-password-filter.png b/docs/develop/login-and-auth/username-and-password/img/2-username-and-password-filter.png similarity index 100% rename from docs/README/develop/login-and-auth/username-and-password/img/2-username-and-password-filter.png rename to docs/develop/login-and-auth/username-and-password/img/2-username-and-password-filter.png diff --git a/docs/README/develop/login-and-auth/username-and-password/img/3-token.png b/docs/develop/login-and-auth/username-and-password/img/3-token.png similarity index 100% rename from docs/README/develop/login-and-auth/username-and-password/img/3-token.png rename to docs/develop/login-and-auth/username-and-password/img/3-token.png diff --git a/docs/README/develop/login-and-auth/username-and-password/index.md b/docs/develop/login-and-auth/username-and-password/index.md similarity index 100% rename from docs/README/develop/login-and-auth/username-and-password/index.md rename to docs/develop/login-and-auth/username-and-password/index.md diff --git a/docs/README/develop/module-and-package/img/module-relation.png b/docs/develop/module-and-package/img/module-relation.png similarity index 100% rename from docs/README/develop/module-and-package/img/module-relation.png rename to docs/develop/module-and-package/img/module-relation.png diff --git a/docs/README/develop/module-and-package/index.md b/docs/develop/module-and-package/index.md similarity index 99% rename from docs/README/develop/module-and-package/index.md rename to docs/develop/module-and-package/index.md index ab3c161..52d7eaa 100644 --- a/docs/README/develop/module-and-package/index.md +++ b/docs/develop/module-and-package/index.md @@ -1,4 +1,4 @@ -# 项目模块 +## 后端模块概览 Databasir 基于 Gradle 进行模块管理，当前共有 5 个模块 diff --git a/docs/donate/_sidebar.md b/docs/donate/_sidebar.md new file mode 100644 index 0000000..645927c --- /dev/null +++ b/docs/donate/_sidebar.md @@ -0,0 +1 @@ +* [捐赠](/donate/index.md) \ No newline at end of file diff --git a/docs/donate/index.md b/docs/donate/index.md new file mode 100644 index 0000000..296cf2f --- /dev/null +++ b/docs/donate/index.md @@ -0,0 +1,9 @@ +## 捐赠方式 + +开源不易，扶我起来吧！再写两行 + + + +## 扫码加群 + + \ No newline at end of file diff --git a/docs/faq/_sidebar.md b/docs/faq/_sidebar.md new file mode 100644 index 0000000..c17cb17 --- /dev/null +++ b/docs/faq/_sidebar.md @@ -0,0 +1 @@ +* [常见问题](/faq/index.md) \ No newline at end of file diff --git a/docs/faq/index.md b/docs/faq/index.md new file mode 100644 index 0000000..181847c --- /dev/null +++ b/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` diff --git a/docs/guid/_sidebar.md b/docs/guid/_sidebar.md new file mode 100644 index 0000000..838953d --- /dev/null +++ b/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) diff --git a/docs/README/database-extension/database-extension.md b/docs/guid/advance-database-extension/database-extension.md similarity index 74% rename from docs/README/database-extension/database-extension.md rename to docs/guid/advance-database-extension/database-extension.md index afc747c..886788d 100644 --- a/docs/README/database-extension/database-extension.md +++ b/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 技术背景，则可以通过填写表单的形式进行扩展。 + +数据库类型是全平台可用的，所以限制了只有【系统管理员】权限才能新增数据库类型。 通过菜单我们进入【数据库类型】配置页面 diff --git a/docs/README/database-extension/img/1-menu.png b/docs/guid/advance-database-extension/img/1-menu.png similarity index 100% rename from docs/README/database-extension/img/1-menu.png rename to docs/guid/advance-database-extension/img/1-menu.png diff --git a/docs/README/database-extension/img/2-database-types.png b/docs/guid/advance-database-extension/img/2-database-types.png similarity index 100% rename from docs/README/database-extension/img/2-database-types.png rename to docs/guid/advance-database-extension/img/2-database-types.png diff --git a/docs/README/database-extension/img/3-add.png b/docs/guid/advance-database-extension/img/3-add.png similarity index 100% rename from docs/README/database-extension/img/3-add.png rename to docs/guid/advance-database-extension/img/3-add.png diff --git a/docs/README/database-extension/img/4-result.png b/docs/guid/advance-database-extension/img/4-result.png similarity index 100% rename from docs/README/database-extension/img/4-result.png rename to docs/guid/advance-database-extension/img/4-result.png diff --git a/docs/guid/advance-database-extension/img/inner-template.png b/docs/guid/advance-database-extension/img/inner-template.png new file mode 100644 index 0000000..ebba7a8 Binary files /dev/null and b/docs/guid/advance-database-extension/img/inner-template.png differ diff --git a/docs/guid/advance-database-extension/img/json-import.png b/docs/guid/advance-database-extension/img/json-import.png new file mode 100644 index 0000000..0a1289c Binary files /dev/null and b/docs/guid/advance-database-extension/img/json-import.png differ diff --git a/docs/README/database-type-list/index.md b/docs/guid/advance-database-type-list/index.md similarity index 100% rename from docs/README/database-type-list/index.md rename to docs/guid/advance-database-type-list/index.md diff --git a/docs/README/github-oauth2/github-oauth2.md b/docs/guid/advance-github-oauth2/github-oauth2.md similarity index 100% rename from docs/README/github-oauth2/github-oauth2.md rename to docs/guid/advance-github-oauth2/github-oauth2.md diff --git a/docs/README/github-oauth2/img/1-github-oauth2-app-create.png b/docs/guid/advance-github-oauth2/img/1-github-oauth2-app-create.png similarity index 100% rename from docs/README/github-oauth2/img/1-github-oauth2-app-create.png rename to docs/guid/advance-github-oauth2/img/1-github-oauth2-app-create.png diff --git a/docs/README/github-oauth2/img/2-github-oauth2-create.png b/docs/guid/advance-github-oauth2/img/2-github-oauth2-create.png similarity index 100% rename from docs/README/github-oauth2/img/2-github-oauth2-create.png rename to docs/guid/advance-github-oauth2/img/2-github-oauth2-create.png diff --git a/docs/README/github-oauth2/img/3-github-oauth2-create.png b/docs/guid/advance-github-oauth2/img/3-github-oauth2-create.png similarity index 100% rename from docs/README/github-oauth2/img/3-github-oauth2-create.png rename to docs/guid/advance-github-oauth2/img/3-github-oauth2-create.png diff --git a/docs/README/github-oauth2/img/4-github-oauth2-create.png b/docs/guid/advance-github-oauth2/img/4-github-oauth2-create.png similarity index 100% rename from docs/README/github-oauth2/img/4-github-oauth2-create.png rename to docs/guid/advance-github-oauth2/img/4-github-oauth2-create.png diff --git a/docs/README/github-oauth2/img/5-github-oauth-create.png b/docs/guid/advance-github-oauth2/img/5-github-oauth-create.png similarity index 100% rename from docs/README/github-oauth2/img/5-github-oauth-create.png rename to docs/guid/advance-github-oauth2/img/5-github-oauth-create.png diff --git a/docs/README/github-oauth2/img/6-github-oauth-create.png b/docs/guid/advance-github-oauth2/img/6-github-oauth-create.png similarity index 100% rename from docs/README/github-oauth2/img/6-github-oauth-create.png rename to docs/guid/advance-github-oauth2/img/6-github-oauth-create.png diff --git a/docs/README/github-oauth2/img/7-github-oauth-create.png b/docs/guid/advance-github-oauth2/img/7-github-oauth-create.png similarity index 100% rename from docs/README/github-oauth2/img/7-github-oauth-create.png rename to docs/guid/advance-github-oauth2/img/7-github-oauth-create.png diff --git a/docs/README/github-oauth2/img/8-github-oauth-create.png b/docs/guid/advance-github-oauth2/img/8-github-oauth-create.png similarity index 100% rename from docs/README/github-oauth2/img/8-github-oauth-create.png rename to docs/guid/advance-github-oauth2/img/8-github-oauth-create.png diff --git a/docs/README/gitlab-oauth2/gitlab-oauth2.md b/docs/guid/advance-gitlab-oauth2/gitlab-oauth2.md similarity index 100% rename from docs/README/gitlab-oauth2/gitlab-oauth2.md rename to docs/guid/advance-gitlab-oauth2/gitlab-oauth2.md diff --git a/docs/README/gitlab-oauth2/img/1-gitlab-oauth2.png b/docs/guid/advance-gitlab-oauth2/img/1-gitlab-oauth2.png similarity index 100% rename from docs/README/gitlab-oauth2/img/1-gitlab-oauth2.png rename to docs/guid/advance-gitlab-oauth2/img/1-gitlab-oauth2.png diff --git a/docs/README/gitlab-oauth2/img/2-gitlab-oauth2.png b/docs/guid/advance-gitlab-oauth2/img/2-gitlab-oauth2.png similarity index 100% rename from docs/README/gitlab-oauth2/img/2-gitlab-oauth2.png rename to docs/guid/advance-gitlab-oauth2/img/2-gitlab-oauth2.png diff --git a/docs/README/gitlab-oauth2/img/3-gitlab-oauth2.png b/docs/guid/advance-gitlab-oauth2/img/3-gitlab-oauth2.png similarity index 100% rename from docs/README/gitlab-oauth2/img/3-gitlab-oauth2.png rename to docs/guid/advance-gitlab-oauth2/img/3-gitlab-oauth2.png diff --git a/docs/README/gitlab-oauth2/img/4-gitlab-oauth2.png b/docs/guid/advance-gitlab-oauth2/img/4-gitlab-oauth2.png similarity index 100% rename from docs/README/gitlab-oauth2/img/4-gitlab-oauth2.png rename to docs/guid/advance-gitlab-oauth2/img/4-gitlab-oauth2.png diff --git a/docs/README/gitlab-oauth2/img/5-gitlab-oauth2.png b/docs/guid/advance-gitlab-oauth2/img/5-gitlab-oauth2.png similarity index 100% rename from docs/README/gitlab-oauth2/img/5-gitlab-oauth2.png rename to docs/guid/advance-gitlab-oauth2/img/5-gitlab-oauth2.png diff --git a/docs/README/gitlab-oauth2/img/6-gitlab-oauth2.png b/docs/guid/advance-gitlab-oauth2/img/6-gitlab-oauth2.png similarity index 100% rename from docs/README/gitlab-oauth2/img/6-gitlab-oauth2.png rename to docs/guid/advance-gitlab-oauth2/img/6-gitlab-oauth2.png diff --git a/docs/README/mock-sql/img/a.png b/docs/guid/advance-mock-sql/img/a.png similarity index 100% rename from docs/README/mock-sql/img/a.png rename to docs/guid/advance-mock-sql/img/a.png diff --git a/docs/README/mock-sql/img/b.png b/docs/guid/advance-mock-sql/img/b.png similarity index 100% rename from docs/README/mock-sql/img/b.png rename to docs/guid/advance-mock-sql/img/b.png diff --git a/docs/README/mock-sql/img/c.png b/docs/guid/advance-mock-sql/img/c.png similarity index 100% rename from docs/README/mock-sql/img/c.png rename to docs/guid/advance-mock-sql/img/c.png diff --git a/docs/README/mock-sql/index.md b/docs/guid/advance-mock-sql/index.md similarity index 100% rename from docs/README/mock-sql/index.md rename to docs/guid/advance-mock-sql/index.md diff --git a/docs/README/group-and-project/img/group-sample.png b/docs/guid/concept-group-project/img/group-sample.png similarity index 100% rename from docs/README/group-and-project/img/group-sample.png rename to docs/guid/concept-group-project/img/group-sample.png diff --git a/docs/README/group-and-project/img/group.png b/docs/guid/concept-group-project/img/group.png similarity index 100% rename from docs/README/group-and-project/img/group.png rename to docs/guid/concept-group-project/img/group.png diff --git a/docs/README/group-and-project/img/project-sample.png b/docs/guid/concept-group-project/img/project-sample.png similarity index 100% rename from docs/README/group-and-project/img/project-sample.png rename to docs/guid/concept-group-project/img/project-sample.png diff --git a/docs/README/group-and-project/index.md b/docs/guid/concept-group-project/index.md similarity index 100% rename from docs/README/group-and-project/index.md rename to docs/guid/concept-group-project/index.md diff --git a/docs/README/user-role/user-role.md b/docs/guid/concept-user-role/user-role.md similarity index 100% rename from docs/README/user-role/user-role.md rename to docs/guid/concept-user-role/user-role.md diff --git a/docs/README/deploy/docker-deploy.md b/docs/guid/deploy/docker-deploy.md similarity index 90% rename from docs/README/deploy/docker-deploy.md rename to docs/guid/deploy/docker-deploy.md index 49a66cf..457081b 100644 --- a/docs/README/deploy/docker-deploy.md +++ b/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 diff --git a/docs/README/deploy/jar-deploy.md b/docs/guid/deploy/jar-deploy.md similarity index 98% rename from docs/README/deploy/jar-deploy.md rename to docs/guid/deploy/jar-deploy.md index 8db86de..9337fbe 100644 --- a/docs/README/deploy/jar-deploy.md +++ b/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 -## 通过配置文件指定参数 +## 配置文件 除了在命令行指定参数启动外，还可以通过配置文件来保存 diff --git a/docs/guid/index.md b/docs/guid/index.md new file mode 100644 index 0000000..0319420 --- /dev/null +++ b/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 | 普通 | + + + + +#### **微信群** + +扫码加入微信群，随时获取第一手更新内容 + + + +#### **公众号** + +![qrcode.jpg](https://s2.loli.net/2022/04/22/mZjlG5u4vrXW1SL.jpg) + +#### **邮箱** + +vran_dev@foxmail.com + + + +## 多图展示 + + + +#### **文档同步** + +![sync.gif](https://s2.loli.net/2022/04/22/aoiSR1V3MuN67m8.gif) + +#### **版本对比** + +![](index/diff.gif) + +#### **文档导出** + +- UML 图片导出 + +![](index/uml-export.gif) + +- 导出 Markdown 格式展示 + +![](index/markdown-exported.gif) + + + +## 捐赠 + +开源不易，扶我起来，再写两行！ + + + diff --git a/docs/README/index/diff.gif b/docs/guid/index/diff.gif similarity index 100% rename from docs/README/index/diff.gif rename to docs/guid/index/diff.gif diff --git a/docs/README/index/markdown-exported.gif b/docs/guid/index/markdown-exported.gif similarity index 100% rename from docs/README/index/markdown-exported.gif rename to docs/guid/index/markdown-exported.gif diff --git a/docs/README/index/sync.gif b/docs/guid/index/sync.gif similarity index 100% rename from docs/README/index/sync.gif rename to docs/guid/index/sync.gif diff --git a/docs/README/index/template.gif b/docs/guid/index/template.gif similarity index 100% rename from docs/README/index/template.gif rename to docs/guid/index/template.gif diff --git a/docs/README/index/uml-export.gif b/docs/guid/index/uml-export.gif similarity index 100% rename from docs/README/index/uml-export.gif rename to docs/guid/index/uml-export.gif diff --git a/docs/README/management-document/img/doc-diff1.png b/docs/guid/management-document/img/doc-diff1.png similarity index 100% rename from docs/README/management-document/img/doc-diff1.png rename to docs/guid/management-document/img/doc-diff1.png diff --git a/docs/README/management-document/img/doc-diff2.png b/docs/guid/management-document/img/doc-diff2.png similarity index 100% rename from docs/README/management-document/img/doc-diff2.png rename to docs/guid/management-document/img/doc-diff2.png diff --git a/docs/README/management-document/img/doc-diff3.png b/docs/guid/management-document/img/doc-diff3.png similarity index 100% rename from docs/README/management-document/img/doc-diff3.png rename to docs/guid/management-document/img/doc-diff3.png diff --git a/docs/README/management-document/img/doc-diff4.png b/docs/guid/management-document/img/doc-diff4.png similarity index 100% rename from docs/README/management-document/img/doc-diff4.png rename to docs/guid/management-document/img/doc-diff4.png diff --git a/docs/README/management-document/img/doc-diff5.png b/docs/guid/management-document/img/doc-diff5.png similarity index 100% rename from docs/README/management-document/img/doc-diff5.png rename to docs/guid/management-document/img/doc-diff5.png diff --git a/docs/README/management-document/img/project-export1.png b/docs/guid/management-document/img/project-export1.png similarity index 100% rename from docs/README/management-document/img/project-export1.png rename to docs/guid/management-document/img/project-export1.png diff --git a/docs/README/management-document/img/project-export2.png b/docs/guid/management-document/img/project-export2.png similarity index 100% rename from docs/README/management-document/img/project-export2.png rename to docs/guid/management-document/img/project-export2.png diff --git a/docs/README/management-document/img/template-edit1.png b/docs/guid/management-document/img/template-edit1.png similarity index 100% rename from docs/README/management-document/img/template-edit1.png rename to docs/guid/management-document/img/template-edit1.png diff --git a/docs/README/management-document/img/template-edit2.png b/docs/guid/management-document/img/template-edit2.png similarity index 100% rename from docs/README/management-document/img/template-edit2.png rename to docs/guid/management-document/img/template-edit2.png diff --git a/docs/README/management-document/img/template-edit3.png b/docs/guid/management-document/img/template-edit3.png similarity index 100% rename from docs/README/management-document/img/template-edit3.png rename to docs/guid/management-document/img/template-edit3.png diff --git a/docs/README/management-document/img/template-edit4.png b/docs/guid/management-document/img/template-edit4.png similarity index 100% rename from docs/README/management-document/img/template-edit4.png rename to docs/guid/management-document/img/template-edit4.png diff --git a/docs/README/management-document/index.md b/docs/guid/management-document/index.md similarity index 93% rename from docs/README/management-document/index.md rename to docs/guid/management-document/index.md index 100c448..75490ba 100644 --- a/docs/README/management-document/index.md +++ b/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) - - 点击就会跳转编辑页面，就能跳转入模板的编辑页。 注意我用红框框起来的表头，这些都是可以编辑的 diff --git a/docs/README/management-email/img/email-menu.png b/docs/guid/management-email/img/email-menu.png similarity index 100% rename from docs/README/management-email/img/email-menu.png rename to docs/guid/management-email/img/email-menu.png diff --git a/docs/README/management-email/img/email-setting.png b/docs/guid/management-email/img/email-setting.png similarity index 100% rename from docs/README/management-email/img/email-setting.png rename to docs/guid/management-email/img/email-setting.png diff --git a/docs/README/management-email/index.md b/docs/guid/management-email/index.md similarity index 100% rename from docs/README/management-email/index.md rename to docs/guid/management-email/index.md diff --git a/docs/README/management-group/img/group-add1.png b/docs/guid/management-group/img/group-add1.png similarity index 100% rename from docs/README/management-group/img/group-add1.png rename to docs/guid/management-group/img/group-add1.png diff --git a/docs/README/management-group/img/group-add2.png b/docs/guid/management-group/img/group-add2.png similarity index 100% rename from docs/README/management-group/img/group-add2.png rename to docs/guid/management-group/img/group-add2.png diff --git a/docs/README/management-group/img/group-add3.png b/docs/guid/management-group/img/group-add3.png similarity index 100% rename from docs/README/management-group/img/group-add3.png rename to docs/guid/management-group/img/group-add3.png diff --git a/docs/README/management-group/img/group-delete1.png b/docs/guid/management-group/img/group-delete1.png similarity index 100% rename from docs/README/management-group/img/group-delete1.png rename to docs/guid/management-group/img/group-delete1.png diff --git a/docs/README/management-group/img/group-delete2.png b/docs/guid/management-group/img/group-delete2.png similarity index 100% rename from docs/README/management-group/img/group-delete2.png rename to docs/guid/management-group/img/group-delete2.png diff --git a/docs/README/management-group/img/group-delete3.png b/docs/guid/management-group/img/group-delete3.png similarity index 100% rename from docs/README/management-group/img/group-delete3.png rename to docs/guid/management-group/img/group-delete3.png diff --git a/docs/README/management-group/img/group-member1.png b/docs/guid/management-group/img/group-member1.png similarity index 100% rename from docs/README/management-group/img/group-member1.png rename to docs/guid/management-group/img/group-member1.png diff --git a/docs/README/management-group/img/group-member2.png b/docs/guid/management-group/img/group-member2.png similarity index 100% rename from docs/README/management-group/img/group-member2.png rename to docs/guid/management-group/img/group-member2.png diff --git a/docs/README/management-group/img/group-member3.png b/docs/guid/management-group/img/group-member3.png similarity index 100% rename from docs/README/management-group/img/group-member3.png rename to docs/guid/management-group/img/group-member3.png diff --git a/docs/README/management-group/img/group-member4.png b/docs/guid/management-group/img/group-member4.png similarity index 100% rename from docs/README/management-group/img/group-member4.png rename to docs/guid/management-group/img/group-member4.png diff --git a/docs/README/management-group/img/group-role1.png b/docs/guid/management-group/img/group-role1.png similarity index 100% rename from docs/README/management-group/img/group-role1.png rename to docs/guid/management-group/img/group-role1.png diff --git a/docs/README/management-group/index.md b/docs/guid/management-group/index.md similarity index 100% rename from docs/README/management-group/index.md rename to docs/guid/management-group/index.md diff --git a/docs/README/management-project/img/project-create1.png b/docs/guid/management-project/img/project-create1.png similarity index 100% rename from docs/README/management-project/img/project-create1.png rename to docs/guid/management-project/img/project-create1.png diff --git a/docs/README/management-project/img/project-create2.png b/docs/guid/management-project/img/project-create2.png similarity index 100% rename from docs/README/management-project/img/project-create2.png rename to docs/guid/management-project/img/project-create2.png diff --git a/docs/README/management-project/img/project-create3.png b/docs/guid/management-project/img/project-create3.png similarity index 100% rename from docs/README/management-project/img/project-create3.png rename to docs/guid/management-project/img/project-create3.png diff --git a/docs/README/management-project/img/project-create4.png b/docs/guid/management-project/img/project-create4.png similarity index 100% rename from docs/README/management-project/img/project-create4.png rename to docs/guid/management-project/img/project-create4.png diff --git a/docs/README/management-project/img/project-delete1.png b/docs/guid/management-project/img/project-delete1.png similarity index 100% rename from docs/README/management-project/img/project-delete1.png rename to docs/guid/management-project/img/project-delete1.png diff --git a/docs/README/management-project/img/project-delete2.png b/docs/guid/management-project/img/project-delete2.png similarity index 100% rename from docs/README/management-project/img/project-delete2.png rename to docs/guid/management-project/img/project-delete2.png diff --git a/docs/README/management-project/img/project-fav1.png b/docs/guid/management-project/img/project-fav1.png similarity index 100% rename from docs/README/management-project/img/project-fav1.png rename to docs/guid/management-project/img/project-fav1.png diff --git a/docs/README/management-project/img/project-fav2.png b/docs/guid/management-project/img/project-fav2.png similarity index 100% rename from docs/README/management-project/img/project-fav2.png rename to docs/guid/management-project/img/project-fav2.png diff --git a/docs/README/management-project/img/project-fav3.png b/docs/guid/management-project/img/project-fav3.png similarity index 100% rename from docs/README/management-project/img/project-fav3.png rename to docs/guid/management-project/img/project-fav3.png diff --git a/docs/README/management-project/img/project-fav4.png b/docs/guid/management-project/img/project-fav4.png similarity index 100% rename from docs/README/management-project/img/project-fav4.png rename to docs/guid/management-project/img/project-fav4.png diff --git a/docs/README/management-project/img/project-ignore1.png b/docs/guid/management-project/img/project-ignore1.png similarity index 100% rename from docs/README/management-project/img/project-ignore1.png rename to docs/guid/management-project/img/project-ignore1.png diff --git a/docs/README/management-project/img/project-ignore2.png b/docs/guid/management-project/img/project-ignore2.png similarity index 100% rename from docs/README/management-project/img/project-ignore2.png rename to docs/guid/management-project/img/project-ignore2.png diff --git a/docs/README/management-project/img/project-schedule1.png b/docs/guid/management-project/img/project-schedule1.png similarity index 100% rename from docs/README/management-project/img/project-schedule1.png rename to docs/guid/management-project/img/project-schedule1.png diff --git a/docs/README/management-project/img/project-schedule2.png b/docs/guid/management-project/img/project-schedule2.png similarity index 100% rename from docs/README/management-project/img/project-schedule2.png rename to docs/guid/management-project/img/project-schedule2.png diff --git a/docs/README/management-project/img/project-schedule3.png b/docs/guid/management-project/img/project-schedule3.png similarity index 100% rename from docs/README/management-project/img/project-schedule3.png rename to docs/guid/management-project/img/project-schedule3.png diff --git a/docs/README/management-project/img/project-sync1.png b/docs/guid/management-project/img/project-sync1.png similarity index 100% rename from docs/README/management-project/img/project-sync1.png rename to docs/guid/management-project/img/project-sync1.png diff --git a/docs/README/management-project/img/project-sync2.png b/docs/guid/management-project/img/project-sync2.png similarity index 100% rename from docs/README/management-project/img/project-sync2.png rename to docs/guid/management-project/img/project-sync2.png diff --git a/docs/README/management-project/img/project-sync3.png b/docs/guid/management-project/img/project-sync3.png similarity index 100% rename from docs/README/management-project/img/project-sync3.png rename to docs/guid/management-project/img/project-sync3.png diff --git a/docs/README/management-project/img/project-sync4.png b/docs/guid/management-project/img/project-sync4.png similarity index 100% rename from docs/README/management-project/img/project-sync4.png rename to docs/guid/management-project/img/project-sync4.png diff --git a/docs/README/management-project/index.md b/docs/guid/management-project/index.md similarity index 100% rename from docs/README/management-project/index.md rename to docs/guid/management-project/index.md diff --git a/docs/README/management-user/img/user-create1.png b/docs/guid/management-user/img/user-create1.png similarity index 100% rename from docs/README/management-user/img/user-create1.png rename to docs/guid/management-user/img/user-create1.png diff --git a/docs/README/management-user/img/user-create2.png b/docs/guid/management-user/img/user-create2.png similarity index 100% rename from docs/README/management-user/img/user-create2.png rename to docs/guid/management-user/img/user-create2.png diff --git a/docs/README/management-user/img/user-create3.png b/docs/guid/management-user/img/user-create3.png similarity index 100% rename from docs/README/management-user/img/user-create3.png rename to docs/guid/management-user/img/user-create3.png diff --git a/docs/README/management-user/img/user-create4.png b/docs/guid/management-user/img/user-create4.png similarity index 100% rename from docs/README/management-user/img/user-create4.png rename to docs/guid/management-user/img/user-create4.png diff --git a/docs/README/management-user/img/user-detail1.png b/docs/guid/management-user/img/user-detail1.png similarity index 100% rename from docs/README/management-user/img/user-detail1.png rename to docs/guid/management-user/img/user-detail1.png diff --git a/docs/README/management-user/img/user-detail2.png b/docs/guid/management-user/img/user-detail2.png similarity index 100% rename from docs/README/management-user/img/user-detail2.png rename to docs/guid/management-user/img/user-detail2.png diff --git a/docs/README/management-user/img/user-management.png b/docs/guid/management-user/img/user-management.png similarity index 100% rename from docs/README/management-user/img/user-management.png rename to docs/guid/management-user/img/user-management.png diff --git a/docs/README/management-user/img/user-pwd1.png b/docs/guid/management-user/img/user-pwd1.png similarity index 100% rename from docs/README/management-user/img/user-pwd1.png rename to docs/guid/management-user/img/user-pwd1.png diff --git a/docs/README/management-user/img/user-pwd2.png b/docs/guid/management-user/img/user-pwd2.png similarity index 100% rename from docs/README/management-user/img/user-pwd2.png rename to docs/guid/management-user/img/user-pwd2.png diff --git a/docs/README/management-user/img/user-pwd3.png b/docs/guid/management-user/img/user-pwd3.png similarity index 100% rename from docs/README/management-user/img/user-pwd3.png rename to docs/guid/management-user/img/user-pwd3.png diff --git a/docs/README/management-user/index.md b/docs/guid/management-user/index.md similarity index 100% rename from docs/README/management-user/index.md rename to docs/guid/management-user/index.md diff --git a/docs/index.html b/docs/index.html index 428d215..5509a2c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -20,15 +20,13 @@ window.$docsify = { coverpage: true, loadSidebar: true, + loadNavbar: true, maxLevel: 1, subMaxLevel: 2, auto2top: true, logo: 'databasir.png', name: 'Databasir', repo: 'https://github.com/vran-dev/databasir', - alias: { - '/.*/_sidebar.md': '/_sidebar.md'//防止意外回退 - }, copyCode: { buttonText : '复制代码', errorText : '复制失败！请手动复制。',