7x31
/
databasir
mirror of https://github.com/vran-dev/databasir.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

feat:update docs

This commit is contained in:
vran 2022-05-04 13:56:01 +08:00
parent 76f53ee492
commit adb90cdf56
6 changed files with 35 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -8,22 +8,20 @@
问题反馈：https://github.com/vran-dev/databasir/issues
平台演示：[https://demo.databasir.com](http://121.4.67.27/)
平台演示：[https://demo.databasir.com](http://demo.databasir.com)
| 账号 | 密码 | 角色 |
| ---- | ------- | ---------- |
| demo | demo123 | 系统管理员 |
| dev | dev123 | 普通 |
## 社区
## 联系我
[点击加入 Databasir 交流群](https://doc.databasir.com/#/?id=联系)
微信扫码加入 Databasir 交流群，获取第一手版本内容。
## 特性
<img src="https://s2.loli.net/2022/05/04/c2b5O7yEgB6Yvpo.jpg" width="250px" />
1. 兼容市面多数数据库：支持所有拥有 JDBC 驱动的数据库，mysql、postgresql 开箱即用
2. 丰富的文档管理功能：支持文档自动同步，版本历史回溯，版本差异对比，文档讨论，UML 生成， 文档导出，数据 SQL 生成等，应有尽有
3. 面向团队的协作能力：扁平化的角色管理，支持 Github \ Github Enterprise \ Gitlab 的 OAuth2 登录，日志审计
[点击查看更多联系方式](https://doc.databasir.com/#/?id=联系)
## 多图展示
@ -31,10 +29,6 @@
![sync.gif](https://s2.loli.net/2022/04/22/aoiSR1V3MuN67m8.gif)
- 文档模板定义
![](docs/README/index/template.gif)
- 版本差异对比
![](docs/README/index/diff.gif)
@ -47,6 +41,10 @@
![](docs/README/index/markdown-exported.gif)
## 捐赠
<img src="docs/img/sponsor.jpg" width="280">
## License
Apache License 2.0

28
docs/README.md
View File

@ -1,4 +1,4 @@
## 简介
## 介绍
![](databasir.png) 是面向团队的**关系型数据库模型文档管理平台**，旨在通过自动化的方式解决模型文档管理过程中维护成本高、内容更新不及时以及团队协作复杂等问题。
@ -6,20 +6,24 @@
问题反馈：https://github.com/vran-dev/databasir/issues
平台演示：[https://demo.databasir.com](http://121.4.67.27/)
平台演示：[https://demo.databasir.com](http://demo.databasir.com)
| 账号 | 密码 | 角色 |
| ---- | ------- | ---------- |
| demo | demo123 | 系统管理员 |
| dev | dev123 | 普通 |
## 联系
<!-- tabs:start -->
#### **微信群**
<img src="https://s2.loli.net/2022/04/28/xibsMtIw4GeCVuU.jpg" width="250px" />
扫码加入微信群，随时获取第一手更新内容
<img src="https://s2.loli.net/2022/05/04/c2b5O7yEgB6Yvpo.jpg" width="250px" />
#### **公众号**
@ -31,11 +35,6 @@ vran_dev@foxmail.com
<!-- tabs:end -->
## 特性
1. 兼容市面多数数据库：支持所有拥有 JDBC 驱动的数据库，mysql、postgresql 开箱即用
2. 丰富的文档管理功能：支持文档自动同步，版本历史回溯，版本差异对比，文档讨论，UML 生成， 文档导出，数据 SQL 生成等，应有尽有
3. 面向团队的协作能力：扁平化的角色管理，支持 Github \ Github Enterprise \ Gitlab 的 OAuth2 登录，日志审计
@ -47,10 +46,6 @@ vran_dev@foxmail.com
![sync.gif](https://s2.loli.net/2022/04/22/aoiSR1V3MuN67m8.gif)
#### **自定义模板**
![](README/index/template.gif)
#### **版本对比**
![](README/index/diff.gif)
@ -66,3 +61,12 @@ vran_dev@foxmail.com
![](README/index/markdown-exported.gif)
<!-- tabs:end -->
## 捐赠
开源不易，扶我起来，再写两行！
<img src="img/sponsor.jpg" width="280">

7
docs/_coverpage.md Normal file
View File

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

2
docs/_sidebar.md
View File

@ -1,3 +1,5 @@
* 快速开始
* [项目特性](README.md)
* 系统部署
* [Jar 包部署](README/deploy/jar-deploy.md)
* [Docker 部署](README/deploy/docker-deploy.md)

BIN
docs/img/sponsor.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 65 KiB

1
docs/index.html
View File

@ -18,6 +18,7 @@
<div id="app"></div>
<script>
window.$docsify = {
coverpage: true,
loadSidebar: true,
maxLevel: 1,
subMaxLevel: 2,