showdoc手機版

showdoc手機版為用戶提供了專業(yè)的api文檔編輯功能，大家下載軟件之后首先需要注冊賬號，按照要求填寫完賬號、密碼、驗證碼即可，登錄之后就能體驗便捷的文檔在線編輯服務(wù)，支持團隊成員之間共享文檔，并且可以保留編輯歷史，有助于提升整體辦公效率。

showdoc官方介紹：

showdoc是一個非常適合IT團隊的在線API文檔、技術(shù)文檔工具。通過showdoc，你可以方便地使用markdown語法來書寫出美觀的API文檔、數(shù)據(jù)字典文檔、技術(shù)文檔、在線excel文檔等等。如果不想編輯markdown文檔，你還可以利用showdoc的自動化能力，從程序注釋中自動生成API文檔，或者從搭配的RunApi客戶端（類似postman的api調(diào)試工具）中一邊調(diào)試接口、一邊自動生成文檔。通過分配項目成員和團隊成員，你可以很方便地進行項目文檔的權(quán)限管理和團隊協(xié)作，也可以分享文檔出去給朋友查看。ShowDoc還支持多平臺客戶端，有win客戶端、mac客戶端、ios、android等，更方便跨平臺使用。目前超過100000+的互聯(lián)網(wǎng)團隊正在使用showdoc，包括知名公司內(nèi)部的一些團隊，比如騰訊、華為、百度、京東、字節(jié)跳動等等。

showdoc使用手冊：

API文檔

APP、web前端與服務(wù)器常用API來進行交互。

用ShowDoc可以方便快速編寫出美觀的API文檔。

數(shù)據(jù)字典

好的數(shù)據(jù)字典可以很方便地向別人描述你的數(shù)據(jù)庫結(jié)構(gòu)。

用ShowDoc可以編輯出美觀的數(shù)據(jù)字典。

說明文檔

你完全可以使用 ShowDoc來編寫一些工具的說明書。

也可以編寫一些技術(shù)規(guī)范說明文檔以供團隊查閱。

團隊協(xié)作

團隊權(quán)限管理機制讓團隊良好地協(xié)同編寫文檔。

文檔自動化

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

搭配的RunApi客戶端，可調(diào)試接口和自動生成文檔。

免費開源

ShowDoc提供免費開源的版本。

你可以選擇將ShowDoc部署到你的服務(wù)器。

在線托管

www.showdoc.com.cn 安全穩(wěn)定的在線文檔托管服務(wù)。

你可以放心地選擇托管你的文檔數(shù)據(jù)在云端。

軟件說明：

1、ShowDoc上的項目有公開項目和私密項目兩種。

2、公開項目可供任何登錄與非登錄的用戶訪問。

3、私密項目則需要輸入密碼驗證訪問，密碼由項目創(chuàng)建者設(shè)置。

4、你可以很方便地為ShowDoc的項目添加、刪除項目成員。

5、項目成員可以對項目進行編輯，但不可轉(zhuǎn)讓或刪除項目。

6、點擊編輯器上方的按鈕可方便地插入API接口模板和數(shù)據(jù)字典模板。

7、插入模板后，剩下的就是改動數(shù)據(jù)了，省去了很多編輯的力氣。

8、項目創(chuàng)建者可以自由地把項目轉(zhuǎn)讓給網(wǎng)站的其他用戶。

9、利用showdoc的團隊功能你可以更好地進行團隊協(xié)作。

常見問題：

忘記了密碼怎么辦？

如果是自己部署的ShowDoc，則首先根據(jù)前面安裝文檔進行升級，確保使用最新代碼(劃重點）。

然后，根據(jù)安裝方式的不同有不同的密碼重置方式。

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

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

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

php index.php home/common/repasswd

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

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

私有版showdoc如何連接數(shù)據(jù)庫？

showdoc使用sqlite數(shù)據(jù)庫，數(shù)據(jù)庫文件是安裝目錄下的Sqlite/showdoc.db.php。

你可以網(wǎng)絡(luò)搜索如何在命令行中使用 sqlite數(shù)據(jù)庫.或者使用SQLiteStudio等可視化工具。