- 軟件介紹
- 軟件截圖
- 相關軟件
- 相關閱讀
- 下載地址
電腦軟件推薦: Xmind Zen 2020免激活版 (已驗證可用) vmPing v1.3.21 綠色中文版 同花順遠航版 v7.9.3.1 官方版本 Windows Firewall Control v6.0.2.0
ShowDoc是一款專注于API文檔編輯的工具,使用markdown編輯器讓用戶能夠通過markdown語法創(chuàng)建美觀的API文檔、數(shù)據(jù)字典、技術文檔以及在線Excel文檔等。此外,ShowDoc具備強大的自動化功能,可以從代碼注釋中自動生成文檔,顯著提升團隊之間的溝通效率。88apk提供ShowDoc的官方免費版下載,軟件使用完全免費,有需求的朋友趕緊下載吧!
ShowDoc使用說明
安裝:
#下載腳本并賦予權(quán)限
wget https://www.showdoc.cc/script/showdoc;ch mod +x showdoc;
#默認安裝中文版。如果需要安裝英文版,請加上en參數(shù),如 ./showdoc en
./showdoc
其他命令:
#執(zhí)行上述命令后,安裝將自動完成。以下是其他腳本命令,便于在管理showdoc時使用。
#停止
./showdoc stop
#重啟
./showdoc restart
#升級到最新版
./showdoc update
#卸載
./showdoc uninstall
ShowDoc功能介紹
1. 分享和導出
采用響應式網(wǎng)頁設計,您可以在計算機或移動設備上共享項目文檔。同時,項目文檔也可以導出為Word文件以供離線瀏覽。
2. 編輯功能
(1)markdown編輯
ShowDoc提供了高效的markdown編輯器,提升了編輯和閱讀體驗。如果您不熟悉Markdown,可以通過搜索引擎查找“認識與入門Markdown”以了解更多信息。
(2) 插入模板
在ShowDoc中,點擊編輯器上方的按鈕,您可以輕松插入API接口模板和數(shù)據(jù)字典模板。插入模板后,您只需更改數(shù)據(jù)即可,大大節(jié)省了編輯時間。
(3) 歷史版本
ShowDoc支持頁面的歷史版本功能,使您能夠輕松恢復到先前的版本。
3. 權(quán)限管理
(1) 公開與私人項目
ShowDoc支持公開和私人項目。公開項目對所有用戶(登錄與未登錄)開放,而私人項目則需要密碼驗證,密碼由項目創(chuàng)建者設置。
(2) 項目轉(zhuǎn)讓
項目創(chuàng)建者可以將項目轉(zhuǎn)移給其他網(wǎng)站用戶。
(3) 項目成員
可以方便地添加或刪除項目成員。項目成員可以編輯項目,但無法轉(zhuǎn)讓或刪除項目(僅項目創(chuàng)建者擁有該權(quán)限)。
(4) 團隊管理
用戶可以創(chuàng)建多個團隊,為不同團隊分配項目,并設置每個成員的權(quán)限。
ShowDoc軟件特色
1. API文檔
隨著移動互聯(lián)網(wǎng)的發(fā)展,BaaS(后端即服務)日益流行。服務器提供API,APP或網(wǎng)頁前端可以輕松調(diào)用數(shù)據(jù)。ShowDoc能快速生成API文檔,并支持從代碼文件自動生成文檔。
2. 數(shù)據(jù)字典
一個好的數(shù)據(jù)字典能夠清晰地解釋數(shù)據(jù)庫結(jié)構(gòu),包括每個字段的含義。
3. 說明文檔
您可以利用ShowDoc編寫工具說明書或技術規(guī)范文檔,供團隊參考。
-
ShowDoc v2.9.3 官方免費版下載下載地址
