Showdocv2.4.0 官方版

Showdoc一個非常適合IT團隊的在線API文檔、技術文檔工具。這款工具采用markdown編輯器，無論是編輯還是閱讀體驗都極佳很棒。通過它你可以非常方便快速地編寫出美觀的API文檔，支持從代碼文件中自動生成API文檔，同時你可以自行添加多個團隊，為團隊分配不同的項目，同時設置團隊裏每個人的權限，簡單實用，功能全麵有喜歡的朋友歡迎來下載Showdoc使用！

【軟件介紹】

每當接手一個他人開發好的模塊或者項目，看著那些沒有寫注釋的代碼，我們都無比抓狂。文檔呢？！文檔呢？！Show me the doc ！！

程序員都很希望別人能寫技術文檔，而自己卻很不希望要寫文檔。因為寫文檔需要花大量的時間去處理格式排版，想著新建的word文檔放在哪個目錄等各種非技術細節。

word文檔零零散散地放在團隊不同人那裏，需要文檔的人基本靠吼，吼一聲然後上qq或者郵箱接收對方丟過來的文檔。這種溝通方式當然可以，隻是效率不高。

ShowDoc就是一個非常適合IT團隊的在線文檔分享工具，它可以加快團隊之間溝通的效率。

【軟件用途】

　　1、API文檔

　　隨著移動互聯網的發展，BaaS（後端即服務）越來越流行。服務端提供API，APP端或者網頁前端便可方便調用數據。用ShowDoc可以非常方便快速地編寫出美觀的API文檔，同時還將支持從代碼文件中自動生成API文檔

　　2、數據字典

　　一份好的數據字典可以很方便地向別人說明你的數據庫結構，如各個字段的釋義等。

　　3、說明文檔

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

【使用方法】

      安裝：

      #下載腳本並賦予權限

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

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

      ./showdoc

      其他命令：

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

      #停止

      ./showdoc stop

      #重啟

      ./showdoc restart

      #升級showdoc到最新版

      ./showdoc update

      #卸載showdoc

      ./showdoc uninstall

【功能介紹】

分享與導出

響應式網頁設計，可將項目文檔分享到電腦或移動設備查看。同時也可以將項目導出成word文件，以便離線瀏覽。

權限管理

公開項目與項目

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

項目轉讓

項目創建者可以自由地把項目轉讓給網站的其他用戶。

項目成員

你可以很方便地為ShowDoc的項目添加、刪除項目成員。項目成員可以對項目進行編輯，但不可轉讓或刪除項目（隻有項目創建者才有權限）

團隊管理

你可以自行添加多個團隊，為團隊分配不同的項目，同時設置團隊裏每個人的權限。

編輯功能

markdown編輯

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

模板插入

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

曆史版本

ShowDoc為頁麵提供曆史版本功能，你可以方便地把頁麵恢複到之前的版本。

【軟件功能】

      1、編輯功能

      (1)markdown編輯

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

      (2)模板插入

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

      (3)曆史版本

      ShowDoc為頁麵提供曆史版本功能，你可以方便地把頁麵恢複到之前的版本。

      2、分享與導出響應式網頁設計，可將項目文檔分享到電腦或移動設備查看。同時也可以將項目導出成word文件，以便離線瀏覽。

      3、權限管理

      (1)公開項目與私密項目

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

      (2)項目轉讓

      項目創建者可以自由地把項目轉讓給網站的其他用戶。

      (3)項目成員

      你可以很方便地為ShowDoc的項目添加、刪除項目成員。項目成員可以對項目進行編輯，但不可轉讓或刪除項目(隻有項目創建者才有權限)

      (4)團隊管理

      你可以自行添加多個團隊，為團隊分配不同的項目，同時設置團隊裏每個人的權限。

【更新日誌】

      1、界麵簡潔友好

      2、性能體驗優化提升

      3、修複了已知bug