使用ShowDoc線上管理API接口文檔

每當接手一個他人開發好的子產品或者項目，看着那些沒有寫注釋的代碼，我們都無比抓狂。文檔呢？！文檔呢？！Show me the doc ！！

ShowDoc就是一個非常适合IT團隊的線上文檔分享工具，它可以加快團隊之間溝通的效率。

它可以用來非常友善快速地編寫出美觀的API文檔。

它可以用來記錄資料表結構，一份好的資料字典可以很友善地向别人說明你的資料庫結構，如各個字段的釋義等。

它還可以用來編寫一些工具的說明書,也可以編寫一些技術規範說明文檔以供團隊查閱。

另外它還支援文檔的分享與導出，預設使用markdown編輯以及模闆插入，極大的提高工作效率。

先cd進入運作web的目錄，如/var/www/html/。執行以下指令：

随後web目錄下會出現一個showdoc檔案夾。

通過浏覽器通路http://xxx.com/showdoc/install （請将網址更改為你伺服器域名或ip） 便可執行ShowDoc的初始化。

（請確定install 目錄、server/Application/Runtime、Application/Common/Conf/config.php、Application/Home/Conf/config.php、/Application/Runtime 、 /Public/Uploads 、 /Sqlite 、 /Sqlite/showdoc.db.php 有可寫權限）

如果你想安裝到域名的根目錄，請自行移動檔案夾，或者設定apache/nginx綁定域名到showdoc目錄。

安裝成功之後就可以線上管理API文檔了

更多檢視文檔請檢視ShowDoc官網