Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/xbmlz/db-doc

📝一款生成在线/离线数据库文档的小工具
https://github.com/xbmlz/db-doc

database docs docsify html mariadb mysql pdf postgresql sqlserver

Last synced: 3 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/xbmlz/db-doc
Owner: xbmlz
License: mit
Created: 2020-04-25T14:58:31.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2022-07-28T09:04:09.000Z (over 2 years ago)
Last Synced: 2024-05-19T00:38:02.090Z (7 months ago)
Topics: database, docs, docsify, html, mariadb, mysql, pdf, postgresql, sqlserver
Language: Go
Homepage:
Size: 1.97 MB
Stars: 117
Watchers: 5
Forks: 28
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-seeds - db-doc

README

        ## 💡 简介

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

## 📸 截图

### 在线文档

![image-20210707130615707](https://gitee.com/viodo/note-pic-repo/raw/master//note/image-20210707130615707.png)

### 离线文档

#### Markdown

![image-20210707130825880](https://gitee.com/viodo/note-pic-repo/raw/master//note/image-20210707130825880.png)

#### HTML

![image-20210707130851820](https://gitee.com/viodo/note-pic-repo/raw/master//note/image-20210707130851820.png)

#### PDF

![PDF](https://gitee.com/viodo/note-pic-repo/raw/master//note/20210324091920.png)

## ⚒️ 支持

* [x] Mysql  

* [x] SQL Server

* [x] Postgre SQL    

## ⚗ 用法

### 下载

[点击下载](https://github.com/viodo/db-doc/releases) 

解压后双击打开DbDoc, 按照提示输入操作即可

```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

```

浏览器访问: 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)