ShowDoc是什麼
每當接手一個他人開發好的模塊或者項目，看着那些沒有寫註釋的代碼，咱們都無比抓狂。文檔呢？！文檔呢？！Show me the doc ！！php
ShowDoc就是一個很是適合IT團隊的在線文檔分享工具，它能夠加快團隊之間溝通的效率。html
它能夠用來作什麼
它能夠用來很是方便快速地編寫出美觀的API文檔。nginx
它能夠用來記錄數據表結構，一份好的數據字典能夠很方便地向別人說明你的數據庫結構，如各個字段的釋義等。web
它還能夠用來編寫一些工具的說明書,也能夠編寫一些技術規範說明文檔以供團隊查閱。數據庫
另外它還支持文檔的分享與導出，默認使用markdown編輯以及模板插入，極大的提升工做效率。apache
安裝
先cd進入運行web的目錄，如/var/www/html/。執行如下命令：瀏覽器
composer create-project showdoc/showdoc
隨後web目錄下會出現一個showdoc文件夾。服務器
經過瀏覽器訪問http://xxx.com/showdoc/install （請將網址更改成你服務器域名或ip） 即可執行ShowDoc的初始化。markdown
（請確保install 目錄、server/Application/Runtime、Application/Common/Conf/config.php、Application/Home/Conf/config.php、/Application/Runtime 、 /Public/Uploads 、 /Sqlite 、 /Sqlite/showdoc.db.php 有可寫權限）composer
若是你想安裝到域名的根目錄，請自行移動文件夾，或者設置apache/nginx綁定域名到showdoc目錄。
安裝成功以後就能夠在線管理API文檔了
API實例：
數據庫結構實例：
更多查看文檔請查看ShowDoc官網