ShowDoc是一款專業(yè)的API文檔編輯軟件，軟件采用markdown編輯器，用戶可以使用 markdown 語法來書寫出美觀的 API 文檔、數(shù)據(jù)字典文檔、技術(shù)文檔、在線 excel 文檔等等。此外ShowDoc還擁有強(qiáng)大的自動(dòng)化功能，可以從代碼注釋中自動(dòng)生成文檔，大大提高團(tuán)隊(duì)之間溝通的效率。KK下載站為您提供ShowDoc官方免費(fèi)版下載，軟件使用完全免費(fèi)，有需要的朋友趕緊下載吧！


 

ShowDoc使用說明

安裝：
#下載腳本并賦予權(quán)限

wget https://www.showdoc.cc/script/showdoc;ch  mod +x showdoc;

#默認(rèn)安裝中文版。如果想安裝英文版，請(qǐng)加上en參數(shù)，如 ./showdoc en

./showdoc

其他命令：

#執(zhí)行上面命令便會(huì)自動(dòng)安裝完成。下面附上腳本其他命令，以便管理showdoc時(shí)可以用得上。

#停止

./showdoc stop

#重啟

./showdoc restart

#升級(jí)showdoc到最新版

./showdoc update

#卸載showdoc

./showdoc uninstall


 

ShowDoc功能介紹

1.分享和導(dǎo)出
響應(yīng)式網(wǎng)頁設(shè)計(jì)設(shè)計(jì)，您可以與計(jì)算機(jī)或移動(dòng)設(shè)備共享項(xiàng)目文檔。同時(shí)，您還可以導(dǎo)出項(xiàng)目word離線瀏覽文件。
2.編輯功能
（1）markdown編輯
ShowDoc采用markdown編輯器在編輯和閱讀體驗(yàn)方面都很出色。如果你不知道Markdown，請(qǐng)搜索搜索引擎”認(rèn)識(shí)與入門Markdown”
(2)插入模板
在ShowDoc點(diǎn)擊編輯器上方的按鈕，輕松插入編輯器的編輯頁面API接口模板和數(shù)據(jù)字典模板。插入模板后，剩下的就是更改數(shù)據(jù)，節(jié)省了大量的編輯能力。
(3)歷史版本
ShowDoc為頁面提供歷史版本功能，您可以輕松地將頁面恢復(fù)到之前的版本。
3.權(quán)限管理
(1)公開項(xiàng)目和私人項(xiàng)目
ShowDoc上述項(xiàng)目包括公共項(xiàng)目和私人項(xiàng)目。任何登錄和非登錄用戶都可以訪問公共項(xiàng)目，而私人項(xiàng)目需要輸入密碼進(jìn)行驗(yàn)證。密碼由項(xiàng)目創(chuàng)建者設(shè)置。
(2)項(xiàng)目轉(zhuǎn)讓
項(xiàng)目創(chuàng)建者可以自由地將項(xiàng)目轉(zhuǎn)移到網(wǎng)站的其他用戶。
(3)項(xiàng)目成員
可以很方便的做ShowDoc的項(xiàng)目添加.刪除項(xiàng)目成員。項(xiàng)目成員可以編輯項(xiàng)目，但不能轉(zhuǎn)讓或刪除項(xiàng)目(只有項(xiàng)目創(chuàng)建者有權(quán)限)
(4)團(tuán)隊(duì)管理
您可以自行添加多個(gè)團(tuán)隊(duì)，為團(tuán)隊(duì)分配不同的項(xiàng)目，并在團(tuán)隊(duì)中設(shè)置每個(gè)人的權(quán)限。
 

ShowDoc軟件特色

1.API文檔
隨著移動(dòng)互聯(lián)網(wǎng)的發(fā)展，BaaS(后端即服務(wù))越來越受歡迎。服務(wù)器提供API，APP終端或網(wǎng)頁前端可以方便地調(diào)用數(shù)據(jù)。ShowDoc它可以非常方便和快速地快捷API同時(shí)，還將支持代碼文件的自動(dòng)生成API文檔
2.數(shù)據(jù)字典
一個(gè)好的數(shù)據(jù)字典可以很容易地向別人解釋你的數(shù)據(jù)庫(kù)結(jié)構(gòu)，比如每個(gè)字段的解釋。
3.說明文檔
你可以完全使用它showdoc為了編寫一些工具說明書，也可以編寫一些技術(shù)規(guī)范說明書供團(tuán)隊(duì)查閱。