Code Monkey home page Code Monkey logo

database-doc-generator's Introduction

database-doc-generator

数据库文档生成器

  • 该工具根据给定的链接生成数据库文档,如果你嫌powerdesigner太重,那么可以试试该工具。

  • 支持的数据库类型:

    • MySQL
    • Oracle
    • SQLServer
    • MongoDB
    • PostgreSQL
  • 你可以下载release包来或者下载源代码来使用。

  • 如果使用源代码,需要先克隆该项目后运行mvn package打包,然后运行发布报中bin/start.bat

  • 运行程序后按照下面提示输入对应数据库参数:

choose database:
1:mysql
2:oracle
3:PostgreSQL
Select the appropriate numbers choose database type
(Enter 'c' to cancel): 3
input database name:
gunslite
input host:
localhost
input port:
5432
input username:
enilu
input password:
123456
  • 输入完成后回车,即可生成数据库文档目录${dbname}-doc,目录中文档有三种形式:单文件html,word,markdown

其中markdown可以用来生成html用于在线查看数据库文档:

doc

  • 确保安装了gitbook后,进入上述文件目录的命令行窗口运行:gitbook serve
E:\\database-doc-generator-20181006100721\guns-lite-doc>gitbook serve
openssl config failed: error:02001003:system library:fopen:No such process
Live reload server started on port: 35729
Press CTRL+C to quit ...

info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 15 pages
info: found 0 asset files
info: >> generation finished with success in 1.6s !

Starting server ...
Serving book on http://localhost:4000

summary

table

database-doc-generator's People

Contributors

enilu avatar itas109 avatar zsgsdesign avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.