https://github.com/kamalyes/gdb-doc
一款生成在线数据库文档的小工具
https://github.com/kamalyes/gdb-doc
go mysql postgresql
Last synced: 2 months ago
JSON representation
一款生成在线数据库文档的小工具
- Host: GitHub
- URL: https://github.com/kamalyes/gdb-doc
- Owner: kamalyes
- License: mit
- Created: 2023-03-16T05:49:57.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-16T05:50:12.000Z (about 2 years ago)
- Last Synced: 2025-02-07T06:13:22.330Z (4 months ago)
- Topics: go, mysql, postgresql
- Language: Go
- Homepage:
- Size: 15.6 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 💡 简介
gdb-doc 是一款生成在线数据库文档的小工具
## 📸 截图
### 在线文档

### 离线文档
#### Markdown

#### HTML

## ⚒️ 支持
* [x] Mysql
* [x] SQL Server
* [x] Postgre SQL## ⚗ 用法
### 下载
[点击下载](https://github.com/kamalyes/gdb-doc/releases)
解压后双击打开GDbDocs, 按照提示输入操作即可
```shell
? Database type:
1:MySQL or MariaDB
2:SQL Server
3:PostgreSQL
1
? Database host (127.0.0.1) :
127.0.0.1
? Database port (3306) :
3306
? Database username (root) :
root
? Database password (123456) :
123456
? Database name:
test
? Document type:
1:Online(在线文档)
2:Offline(离线文档)
1
Doc generate successfully!
Doc server is running : http://127.0.0.1:3000
```浏览器访问:
## 🙏 鸣谢
* [Docsify - A magical documentation site generator](https://docsify.js.org)
* [blackfriday - a markdown processor for Go](https://github.com/russross/blackfriday)
* [chromedp - A faster, simpler way to drive browsers supporting the Chrome DevTools Protocol.](https://github.com/chromedp/chromedp)
* [xbmlz](https://github.com/xbmlz/db-doc)