An open API service indexing awesome lists of open source software.

https://github.com/kamalyes/gdb-doc

一款生成在线数据库文档的小工具
https://github.com/kamalyes/gdb-doc

go mysql postgresql

Last synced: 2 months ago
JSON representation

一款生成在线数据库文档的小工具

Awesome Lists containing this project

README

        

## 💡 简介

gdb-doc 是一款生成在线数据库文档的小工具

## 📸 截图

### 在线文档

![image-16789538866578](https://raw.githubusercontent.com/kamalyes/image-bed/master/snap/16789538866578.png)
![image-16789539517269](https://raw.githubusercontent.com/kamalyes/image-bed/master/snap/16789539517269.png)

### 离线文档

#### Markdown

![image-16789551675877](https://raw.githubusercontent.com/kamalyes/image-bed/master/snap/16789551675877.png)

#### HTML

![image-16789550502087](https://raw.githubusercontent.com/kamalyes/image-bed/master/snap/16789552717700.png)

#### PDF
![PDF](https://raw.githubusercontent.com/kamalyes/image-bed/master/snap/16789553605350.png)

## ⚒️ 支持

* [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)