Github標星5300+,專門為程序員開發文檔開源管理系統,我粉了
每當接手一個他人開發好的模塊或者項目,看著那些沒寫注釋的代碼,是不是很抓狂?
每次寫文檔都要花大量的時間處理格式排版等非技術問題,是不是崩潰?
有時候一份文檔,不止是一個人編寫,幾種不同風格摻雜在一起,閱讀起來吃不吃力?
今天,就和大家分享一個專門為程序員開發文檔開源管理系統——ShowDoc。

目前,它已經在Github上標星超5300,1.3K個Fork(Github地址:https://github.com/star7th/showdoc)
它可以用來做什么?
- API文檔( 查看Demo)
隨著移動互聯網的發展,BaaS(后端即服務)越來越流行。服務端提供API,APP端或者網頁前端便可方便調用數據。用ShowDoc可以非常方便快速地編寫出美觀的API文檔。
- 數據字典( 查看Demo)
一份好的數據字典可以很方便地向別人說明你的數據庫結構,如各個字段的釋義等。
- 說明文檔 ( 查看Demo)
你完全可以使用showdoc來編寫一些工具的說明書,也可以編寫一些技術規范說明文檔以供團隊查閱
它都有些什么功能?
- 分享與導出
響應式網頁設計,可將項目文檔分享到電腦或移動設備查看。同時也可以將項目導出成word文件,以便離線瀏覽。
- 權限管理
公開項目與私密項目:ShowDoc上的項目有公開項目和私密項目兩種。公開項目可供任何登錄與非登錄的用戶訪問,而私密項目則需要輸入密碼驗證訪問。密碼由項目創建者設置。
項目轉讓:項目創建者可以自由地把項目轉讓給網站的其他用戶。
項目成員:你可以很方便地為ShowDoc的項目添加、刪除項目成員。項目成員可以對項目進行編輯,但不可轉讓或刪除項目(只有項目創建者才有權限)
團隊管理:利用showdoc的團隊功能你可以更好地進行團隊協作
- 編輯功能
markdown編輯:ShowDoc采用markdown編輯器,無論是編輯還是閱讀體驗都極佳很棒。如果你不了解Markdown,請在搜索引擎搜索”認識與入門 Markdown”
模板插入:在ShowDoc的編輯頁面,點擊編輯器上方的按鈕可方便地插入API接口模板和數據字典模板。插入模板后,剩下的就是改動數據了,省去了很多編輯的力氣。
歷史版本:ShowDoc為頁面提供歷史版本功能,你可以方便地把頁面恢復到之前的版本。
如果你不想安裝,你還可以在線使用ShowDoc。在線地址:https://www.showdoc.cc/
創建項目也很簡單,你只需要按照步驟一步步創建就可以了:


如果你也對這個項目感興趣,可以下載下來嘗試一下。
























