showdoc最新版所包含的功能非常多，使用起來也是非常的輕松簡單，作為一個深受大家喜愛的api以及技術文檔工具，你可以用它來輕松編寫各種文檔內容等，操作葉寒容易！

showdoc官方版簡介

1.ShowDoc是一個非常適合IT團隊的在線API文檔、技術文檔工具。通過showdoc，你可以方便地使用markdown語法來書寫出美觀的API文檔、數據字典文檔、技術文檔、在線excel文檔等等。

2.如果不想編輯markdown文檔，你還可以利用showdoc的自動化能力，從程序注釋中自動生成API文檔，或者從搭配的RunApi客戶端（類似postman的api調試工具）中一邊調試接口、一邊自動生成文檔。通過分配項目成員和團隊成員，你可以很方便地進行項目文檔的權限管理和團隊協作，也可以分享文檔出去給朋友查看。

軟件特點

--數據字典（ 查看Demo）

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

--API文檔（ 查看Demo）

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

--說明文檔（查看Demo ）

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

軟件功能簡介

--編輯功能

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

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

歷史版本：ShowDoc為頁面提供歷史版本功能，你可以方便地把頁面恢復到之前的版本。

--分享與導出

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

--權限管理

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

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

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

團隊管理：利用showdoc的團隊功能你可以更好地進行團隊協作

--多平臺

showdoc支持網頁版、手機app版和電腦客戶端版。客戶端地址可見：https://www.showdoc.com.cn/clients

--自動化

可從代碼注釋中自動生成文檔

搭配的RunApi客戶端，可調試接口和自動生成文檔

常見問題說明

忘記了密碼怎么辦？

如果是使用在線ShowDoc，忘記密碼的話可聯系xing7th@gmail.com，郵件中說明你的用戶名和旗下項目名字（至少提供兩個項目）。

如果是自己部署的ShowDoc，則首先根據前面安裝文檔進行升級，確保使用最新代碼(劃重點）。然后，根據安裝方式的不同有不同的密碼重置方式。

如果是使用官方腳本或者docker方式安裝的，請在命令行執行命令：

docker exec showdoc bash -c  &cd /var/www/html/ && php ./index.php home/common/repasswd&

如果是手動安裝php方式的，則在命令行中切換到showdoc安裝目錄然后執行：

php index.php home/common/repasswd

以上命令會把管理員showdoc的密碼重置為123456 。用此密碼登錄管理后臺即可管理普通用戶以及項目。建議登錄后修改密碼。

若修改密碼出錯，請確保自己采用最新版代碼。

錯誤提示”General error: 11 database disk image is malformed”

請確保服務器安裝好了php環境和php-sqlite擴展；

如果你以FTP方式上傳代碼到服務器，那么請使用二進制模式上傳，否則會損害數據庫文件，導致此錯誤提示

錯誤提示 “Could not find driver”

請安裝php-pdo 和 pdo_sqlite 。

對于Windowns服務器，在php.ini里面把”extension=php_sqlite.dll”和”extension=php_pdo_sqlite.dll”啟用以便開啟對SQlite的支持；

Linux服務器安裝php5.3以上版本時理論上默認是開啟了php-pdo和pdo_sqlite的。如果你安裝的PHP依然沒有，則可搜索網絡教程安裝之。

私有版showdoc如何連接數據庫

showdoc使用sqlite數據庫。數據庫文件是安裝目錄下的Sqlite/showdoc.db.php。你可以網絡搜索如何在命令行中使用 sqlite數據庫.或者使用SQLiteStudio等可視化工具

怎么進入管理后臺

新安裝完成后，默認管理員賬號是showdoc/123456 。使用管理員帳戶登錄后，在項目列表頁面的右上角便能看到管理后臺入口。如果不能，請重新登錄或者刷新瀏覽器緩存試試

驗證碼不顯示

請檢查是否安裝了php-gd庫