showdoc手機版

showdoc手機版為用戶提供了（le）專業的api文檔編輯功能，大家下載軟件之後首先需（xū）要注冊賬號，按照要求（qiú）填寫完賬號、密碼、驗證碼即可，登錄之後就能體驗便捷的文檔在線編輯服務，支持團隊成員之間共享文（wén）檔，並且可以保留編輯曆史，有助於提升整體辦公效率。

showdoc官方介紹：

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

showdoc使用（yòng）手冊：

API文檔

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

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

數據字典

好的數據字（zì）典可以很方便（biàn）地向別人描述你的數（shù）據庫結構。

用ShowDoc可以編輯出美（měi）觀的數據字典。

說明（míng）文檔

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

也可以編寫一些技術規範說明文檔以供團隊查閱。

團隊協（xié）作

團隊權限（xiàn）管理機（jī）製讓團隊良好地（dì）協同編寫文檔。

文檔自動化（huà）

可從（cóng）代碼注釋中自（zì）動生成文檔。

搭配的RunApi客戶端，可調試接口和自（zì）動（dòng）生成文檔。

免費開源

ShowDoc提供免費開源的版本。

你可以選擇將ShowDoc部署到你的服務器。

在（zài）線托管

www.showdoc.com.cn 安全穩定的在（zài）線文（wén）檔托管服務。

你可以放心地選擇托管你的文檔數據（jù）在（zài）雲端。

軟件說明：

1、ShowDoc上的項目有（yǒu）公開項目和私密（mì）項目兩（liǎng）種。

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

3、私密項目則需要輸入密（mì）碼驗證訪問，密碼由項目創建者設置。

4、你可（kě）以很方便地為ShowDoc的項（xiàng）目添加、刪除項目成員。

5、項目成員可以對項目進行編（biān）輯，但不可轉讓或刪除項目。

6、點（diǎn）擊編（biān）輯器上方的按（àn）鈕可方便地插入（rù）API接口模板和數據字典模板。

7、插入模板後，剩下的就（jiù）是改動數（shù）據了，省去了很多編輯的力（lì）氣。

8、項目創建者可以自由地把項（xiàng）目轉讓（ràng）給網站（zhàn）的其他用戶。

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

常見問題：

忘記了密碼怎麽辦？

如果是自己部署的ShowDoc，則（zé）首先根據前麵安裝文檔進行升級，確保使（shǐ）用最新代碼(劃（huá）重點）。

然後，根據安裝方（fāng）式的不同有不同（tóng）的密碼（mǎ）重置方式。

如果是使用（yòng）官方腳（jiǎo）本或者docker方式安裝（zhuāng）的，請在命令行執行命令：

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

如果是手動安裝（zhuāng）php方式的，則在命（mìng）令行中切換到showdoc安裝（zhuāng）目錄然後執（zhí）行：

php index.php home/common/repasswd

以上命令會把管理員showdoc的密碼重置為123456 。用此密碼登錄管理後（hòu）台即（jí）可管理普通用（yòng）戶以及項目。建議登錄後修改密碼。

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

私有版showdoc如何連（lián）接數據（jù）庫？

showdoc使用sqlite數據庫，數據庫文件是安（ān）裝目錄下的Sqlite/showdoc.db.php。

你可（kě）以網絡搜索如何在（zài）命令行中使用 sqlite數據庫.或（huò）者使（shǐ）用SQLiteStudio等可視化工具。