Browse Source

feat: update docs (#107)

master
vran 3 years ago
committed by GitHub
parent
commit
a0d46120bf
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 48
      docs/README.md
  2. BIN
      docs/README/document-diff.gif
  3. BIN
      docs/README/document-discussion.gif
  4. BIN
      docs/README/document-uml.gif
  5. BIN
      docs/README/group-create.gif
  6. BIN
      docs/README/group-member.gif
  7. BIN
      docs/README/index/diff.gif
  8. BIN
      docs/README/index/markdown-exported.gif
  9. BIN
      docs/README/index/sync.gif
  10. BIN
      docs/README/index/template.gif
  11. BIN
      docs/README/index/uml-export.gif
  12. BIN
      docs/README/log-list.gif
  13. BIN
      docs/README/project-create.gif
  14. BIN
      docs/README/project-sync.gif
  15. BIN
      docs/README/user-create.gif
  16. BIN
      docs/README/user-detail.gif
  17. 0
      docs/img/qrcode-group.jpg
  18. 0
      docs/img/qrcode.jpg

48
docs/README.md

@ -13,37 +13,47 @@
| demo | demo123 | 系统管理员 |
| dev | dev123 | 普通 |
如果您有任何的问题、建议,欢迎进群讨论
<img src="img/qrcode-group.jpg" width="250px"/>
当然您也可以通过公众号给我留言
![](img/qrcode.jpg)
实在不行,给我发邮件也行:vran_dev@foxmail.com
## 特性
1. 兼容市面多数数据库:支持所有拥有 JDBC 驱动的数据库,mysql、postgresql 开箱即用
2. 丰富的文档管理功能:支持文档自动同步,版本历史回溯,版本差异对比,文档讨论,UML 生成, 文档导出,数据 SQL 生成等,应有尽有
3. 面向团队的专业能力:扁平化的角色管理,支持 Github \ Github Enterprise \ Gitlab 的 OAuth2 登录,日志审计
3. 面向团队的协作能力:扁平化的角色管理,支持 Github \ Github Enterprise \ Gitlab 的 OAuth2 登录,日志审计
## 多图展示
- 文档同步
![](README/index/sync.gif)
- 图片展示
- 文档模板定义
<img src="README/document-diff.gif" height="500px" width="800px">
![](README/index/template.gif)
## 规划
- 版本差异对比
1. 文档导出格式
- [x] UML 图片
- [x] Markdown
- [ ] Excel
- [ ] Word
2. 邮件通知
- [ ] 文档新增讨论
- [x] 文档版本变更
![](README/index/diff.gif)
## 更多
- UML 图片导出
交流群:暂无
![](README/index/uml-export.gif)
邮箱:vran_dev@foxmail.com
- 导出 Markdown 格式展示
公众号
![](README/index/markdown-exported.gif)
![](qrcode.jpg)
讨论群
![](qrcode-group.jpg)

BIN
docs/README/document-diff.gif

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.4 MiB

BIN
docs/README/document-discussion.gif

Binary file not shown.

Before

Width:  |  Height:  |  Size: 534 KiB

BIN
docs/README/document-uml.gif

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.1 MiB

BIN
docs/README/group-create.gif

Binary file not shown.

Before

Width:  |  Height:  |  Size: 564 KiB

BIN
docs/README/group-member.gif

Binary file not shown.

Before

Width:  |  Height:  |  Size: 958 KiB

BIN
docs/README/index/diff.gif

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 MiB

BIN
docs/README/index/markdown-exported.gif

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 MiB

BIN
docs/README/index/sync.gif

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

BIN
docs/README/index/template.gif

Binary file not shown.

After

Width:  |  Height:  |  Size: 846 KiB

BIN
docs/README/index/uml-export.gif

Binary file not shown.

After

Width:  |  Height:  |  Size: 446 KiB

BIN
docs/README/log-list.gif

Binary file not shown.

Before

Width:  |  Height:  |  Size: 380 KiB

BIN
docs/README/project-create.gif

Binary file not shown.

Before

Width:  |  Height:  |  Size: 893 KiB

BIN
docs/README/project-sync.gif

Binary file not shown.

Before

Width:  |  Height:  |  Size: 402 KiB

BIN
docs/README/user-create.gif

Binary file not shown.

Before

Width:  |  Height:  |  Size: 806 KiB

BIN
docs/README/user-detail.gif

Binary file not shown.

Before

Width:  |  Height:  |  Size: 535 KiB

0
docs/qrcode-group.jpg → docs/img/qrcode-group.jpg

Before

Width:  |  Height:  |  Size: 132 KiB

After

Width:  |  Height:  |  Size: 132 KiB

0
docs/qrcode.jpg → docs/img/qrcode.jpg

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 27 KiB

Loading…
Cancel
Save