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


 

ShowDoc使用說明

安裝：
#下載腳本并賦予權限

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

#默認安裝中文版。如果想安裝英文版，請加上en參數，如 ./showdoc en

./showdoc

其他命令：

#執行上面命令便會自動安裝完成。下面附上腳本其他命令，以便管理showdoc時可以用得上。

#停止

./showdoc stop

#重啟

./showdoc restart

#升級showdoc到最新版

./showdoc update

#卸載showdoc

./showdoc uninstall


 

ShowDoc功能介紹

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

ShowDoc軟件特色

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