ShowDoc是一款特別適合IT團(tuán)隊(duì)的API文檔、技術(shù)性文檔專用工具，應(yīng)用showdoc能夠 用于撰寫一些專用工具的使用說明或數(shù)據(jù)字典,還可以撰寫一些技術(shù)標(biāo)準(zhǔn)說明文檔以供團(tuán)隊(duì)查看，提升團(tuán)隊(duì)的合作高效率。新云網(wǎng)為大伙兒分享Showdoc下載，附Showdoc教程安裝。

Showdoc 2.4.0Showdoc主要用途

API文檔

伴隨著挪動(dòng)互聯(lián)網(wǎng)發(fā)展，BaaS（后端開發(fā)即服務(wù)項(xiàng)目）愈來愈時(shí)興。服務(wù)器端出示API，APP端或是web前端便可便捷啟用數(shù)據(jù)信息。用ShowDoc能夠 十分便捷迅速地編寫出美觀大方的API文檔，另外還將適用從編碼文檔中全自動(dòng)轉(zhuǎn)化成API文檔

數(shù)據(jù)字典

一份好的數(shù)據(jù)字典能夠 很便捷地為他人說明你的數(shù)據(jù)庫(kù)查詢構(gòu)造，如每個(gè)字段名的釋意等。

說明文檔

你徹底能夠 應(yīng)用showdoc來撰寫一些專用工具的使用說明,還可以撰寫一些技術(shù)標(biāo)準(zhǔn)說明文檔以供團(tuán)隊(duì)查看。

Showdoc 2.4.0Showdoc作用

分享與導(dǎo)出來

響應(yīng)式網(wǎng)站網(wǎng)頁(yè)制作，可將項(xiàng)目文檔發(fā)送到電腦上或移動(dòng)終端查詢。另外還可以將項(xiàng)目導(dǎo)出來成word文檔，便于離線瀏覽。

管理權(quán)限

公布項(xiàng)目與私秘項(xiàng)目：ShowDoc上的項(xiàng)目有公布項(xiàng)目和私秘項(xiàng)目二種。公布項(xiàng)目能夠一切登陸和非登陸的客戶瀏覽，而私秘項(xiàng)目則需要輸入支付密碼認(rèn)證瀏覽。登陸密碼由項(xiàng)目創(chuàng)建者設(shè)定。

項(xiàng)目出讓：項(xiàng)目創(chuàng)建者能夠 隨意地把項(xiàng)目出讓給平臺(tái)網(wǎng)站的普通用戶。

項(xiàng)目組員：你能很便捷地為ShowDoc的項(xiàng)目加上、刪掉項(xiàng)目組員。項(xiàng)目組員能夠 對(duì)項(xiàng)目進(jìn)行編寫，但不能出讓或刪掉項(xiàng)目（只能項(xiàng)目創(chuàng)建者才有管理權(quán)限）

團(tuán)隊(duì)管理方法：你能自行添加好幾個(gè)團(tuán)隊(duì)，為團(tuán)隊(duì)分派不一樣的項(xiàng)目，另外設(shè)定團(tuán)隊(duì)里所有人的管理權(quán)限。

編寫作用

markdown編寫：ShowDoc選用markdown編輯器，不論是編寫還是閱讀文章感受都極好非常好。假如我不掌握Markdown，請(qǐng)?jiān)诎俣人阉饕鏅z索”了解與新手入門 Markdown”

模板插進(jìn)：在ShowDoc的編寫網(wǎng)頁(yè)頁(yè)面，點(diǎn)一下編輯器上邊的按鍵可便捷地插進(jìn)API插口模板和數(shù)據(jù)字典模板。插進(jìn)模板后，剩余的就是說修改數(shù)據(jù)信息了，省掉了許多編寫的氣力。

歷史時(shí)間版本：ShowDoc為網(wǎng)頁(yè)頁(yè)面出示歷史時(shí)間版本作用，你能便捷地把網(wǎng)頁(yè)頁(yè)面修復(fù)到以前的版本。

Showdoc 2.4.0Showdoc 操作方法

安裝：

#下載腳本制作并授予管理權(quán)限
wget https://www.showdoc.cc/script/showdoc;chmod +x showdoc;
#默認(rèn)設(shè)置安裝漢化版。假如想安裝英文版，請(qǐng)?jiān)偌觘n主要參數(shù)，如 ./showdoc en
./showdoc

別的指令：

#實(shí)行上邊指令便會(huì)全自動(dòng)安裝進(jìn)行。下邊另附腳本制作別的指令，便于管理方法showdoc時(shí)能夠 用得著。
#終止
./showdoc stop
#重新啟動(dòng)
./showdoc restart
#更新showdoc到最新版本
./showdoc update
#卸載掉showdoc
./showdoc uninstall