一、開源項目簡介
ShowDoc是一個非常适合IT團隊的線上API文檔、技術文檔工具。通過showdoc，你可以友善地使用markdown文法來書寫出美觀的API文檔、資料字典文檔、技術文檔、線上excel文檔等等。如果不想編輯markdown文檔，你還可以利用showdoc的自動化能力，從程式注釋中自動生成API文檔，或者從搭配的RunApi用戶端（類似postman的api調試工具）中一邊調試接口、一邊自動生成文檔。通過配置設定項目成員和團隊成員，你可以很友善地進行項目文檔的權限管理和團隊協作，也可以分享文檔出去給朋友檢視。ShowDoc還支援多平台用戶端，有win用戶端、mac用戶端、ios、android等，更友善跨平台使用。目前超過100000+的網際網路團隊正在使用showdoc，包括知名公司内部的一些團隊，比如騰訊、華為、百度、京東、位元組跳動等等。
二、開源協定
使用Apache-2.0開源協定
三、界面展示
四、功能概述
它可以用來做什麼
- API文檔 随着移動網際網路的發展，BaaS（後端即服務）越來越流行。服務端提供API，APP端或者網頁前端便可友善調用資料。用ShowDoc可以非常友善快速地編寫出美觀的API文檔。
- 資料字典 一份好的資料字典可以很友善地向别人說明你的資料庫結構，如各個字段的釋義等。
- 說明文檔 你完全可以使用showdoc來編寫一些工具的說明書,也可以編寫一些技術規範說明文檔以供團隊查閱
它都有些什麼功能
- 分享與導出響應式網頁設計，可将項目文檔分享到電腦或移動裝置檢視。同時也可以将項目導出成word檔案，以便離線浏覽。
- 權限管理公開項目與私密項目ShowDoc上的項目有公開項目和私密項目兩種。公開項目可供任何登入與非登入的使用者通路，而私密項目則需要輸入密碼驗證通路。密碼由項目建立者設定。項目轉讓項目建立者可以自由地把項目轉讓給網站的其他使用者。項目成員你可以很友善地為ShowDoc的項目添加、删除項目成員。項目成員可以對項目進行編輯，但不可轉讓或删除項目（隻有項目建立者才有權限）團隊管理利用showdoc的團隊功能你可以更好地進行團隊協作
- 編輯功能
- markdown編輯
- ShowDoc采用markdown編輯器，無論是編輯還是閱讀體驗都極佳很棒。如果你不了解Markdown，請在搜尋引擎搜尋”認識與入門 Markdown”
- 模闆插入
- 在ShowDoc的編輯頁面，點選編輯器上方的按鈕可友善地插入API接口模闆和資料字典模闆。插入模闆後，剩下的就是改動資料了，省去了很多編輯的力氣。
- 曆史版本ShowDoc為頁面提供曆史版本功能，你可以友善地把頁面恢複到之前的版本。
- 多平台
- showdoc支援網頁版、手機app版和電腦用戶端版。
- 自動化可從代碼注釋中自動生成文檔搭配的RunApi用戶端，可調試接口和自動生成文檔
五、技術選型
技術棧說明
前端：Vue + ElementUI
後端：為了相容低版本的php運作環境（相容至5.3），使用的是保守的ThinkPHP3.2.3架構
資料庫：showdoc自帶檔案型資料庫（/Sqlite/showdoc.db.php)，不需要使用者手動安裝資料庫
開發前準備
開發機器需要先安裝好PHP環境和NodeJS環境
下載下傳代碼并放置到PHP環境下的www目錄
先在浏覽器通過位址通路，以便完成showdoc的初始化安裝（如已安裝過則忽略）
在指令行裡進入showdoc的web_src目錄，執行npm install 以安裝依賴。（若無npm，你則先要安裝NodeJS環境）
前端開發
執行npm run dev 以啟用調式模式，通過通路 localhost:8080 便可以實時看到改動的效果。請使用代理以便請求後端API的時候代理到PHP服務端。設定代理可以用自己順手的代理工具，或者參考 這裡
需要執行npm run build 才會最終打包生效。打包後的靜态檔案會在/web目錄下
主要涉及到的目錄和檔案：
web_src/src/router #頁面路由。可以根據url定位到元件web_src/src/components #頁面元件基本都放在這裡web_src/static #靜态資源目錄web_src/static/lang #前端語言包 後端開發
主要涉及到的目錄和檔案
server/Application/Api/ #應用目錄，基本所有背景api都放在這裡server/Application/Runtime/Logs #如果有錯誤日志，會直接列印出浏覽器或者列印到這裡Public/Uploads #上傳的圖檔放置在此處server/Application/Api/Lang #後端語言包 其它說明
二次開發後請尊重開源項目，保留版權辨別和連結
如開發了好用的功能，不妨貢獻到官方github代碼倉庫以分享給大家用
showdoc往後更新可能會覆寫你原有的二次開發。如果想相容，最好送出到官方倉庫成為官方功能。
關注公衆号，發送如下消息擷取下載下傳連結：
"源代碼下載下傳:C1254"