Showdoc是一款非常實用的API技術(shù)文檔軟件。軟件可以用來編寫一些工具的說明書或數(shù)據(jù)字典,也可以編寫一些技術(shù)規(guī)范說明文檔以供團隊查閱，提高團隊的協(xié)作效率。并且軟件的操作十分簡單，即使是新手用戶也可以很快上手。如果您有需要可以在jz5u下載這款Showdoc。

軟件功能

分享與導(dǎo)出

響應(yīng)式網(wǎng)頁設(shè)計，可將項目文檔分享到電腦或移動設(shè)備查看。同時也可以將項目導(dǎo)出成word文件，以便離線瀏覽。

權(quán)限管理

公開項目與私密項目：ShowDoc上的項目有公開項目和私密項目兩種。公開項目可供任何登錄與非登錄的用戶訪問，而私密項目則需要輸入密碼驗證訪問。密碼由項目創(chuàng)建者設(shè)置。

項目轉(zhuǎn)讓：項目創(chuàng)建者可以自由地把項目轉(zhuǎn)讓給網(wǎng)站的其他用戶。

項目成員：你可以很方便地為ShowDoc的項目添加、刪除項目成員。項目成員可以對項目進行編輯，但不可轉(zhuǎn)讓或刪除項目（只有項目創(chuàng)建者才有權(quán)限）

團隊管理：你可以自行添加多個團隊，為團隊分配不同的項目，同時設(shè)置團隊里每個人的權(quán)限。

編輯功能

markdown編輯：ShowDoc采用markdown編輯器，無論是編輯還是閱讀體驗都極佳很棒。如果你不了解Markdown，請在搜索引擎搜索認識與入門 Markdown

模板插入：在ShowDoc的編輯頁面，點擊編輯器上方的按鈕可方便地插入API接口模板和數(shù)據(jù)字典模板。插入模板后，剩下的就是改動數(shù)據(jù)了，省去了很多編輯的力氣。

歷史版本：ShowDoc為頁面提供歷史版本功能，你可以方便地把頁面恢復(fù)到之前的版本。

軟件用途

API文檔

隨著移動互聯(lián)網(wǎng)的發(fā)展，BaaS（后端即服務(wù)）越來越流行。服務(wù)端提供API，APP端或者網(wǎng)頁前端便可方便調(diào)用數(shù)據(jù)。用ShowDoc可以非常方便快速地編寫出美觀的API文檔，同時還將支持從代碼文件中自動生成API文檔

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

一份好的數(shù)據(jù)字典可以很方便地向別人說明你的數(shù)據(jù)庫結(jié)構(gòu)，如各個字段的釋義等。

說明文檔

你完全可以使用showdoc來編寫一些工具的說明書,也可以編寫一些技術(shù)規(guī)范說明文檔以供團隊查閱。

使用方法

安裝：

#下載腳本并賦予權(quán)限
wget https://www.showdoc.cc/script/showdoc;chmod +x showdoc;
#默認安裝中文版。如果想安裝英文版，請加上en參數(shù)，如 ./showdoc en
./showdoc

其他命令：

#執(zhí)行上面命令便會自動安裝完成。下面附上腳本其他命令，以便管理showdoc時可以用得上。
#停止
./showdoc stop
#重啟
./showdoc restart
#升級showdoc到最新版
./showdoc update
#卸載showdoc
./showdoc uninstall