Showdoc官方版v2.4.0

Showdoc是一款非常適合IT團(tuán)隊(duì)的在線技術(shù)文檔、API文檔工具。非常實(shí)用，便于加快團(tuán)隊(duì)之間溝通的效率，用這款軟件可以非常方便快速地編寫出美觀的API文檔，同時(shí)還將支持從代碼文件中自動(dòng)生成API文檔?？梢杂糜诰帉懸恍┕ぞ叩恼f明書,也可以編寫一些技術(shù)規(guī)范說明文檔以供團(tuán)隊(duì)查閱。有需要的朋友可以前來本站下載體驗(yàn)！

軟件特色

1、支持markdown語法（所有的api接口寫作現(xiàn)在都支持這個(gè)吧，因?yàn)樗F(xiàn)在太方便了）
2、支持多用戶協(xié)作，你可以在項(xiàng)目下面隨意添加多個(gè)用戶一起完成api文檔的寫作。
3、支持項(xiàng)目轉(zhuǎn)讓
4、如果在線使用，可以設(shè)置自己的個(gè)性域名，也可以對(duì)文檔進(jìn)行加密，瀏覽者需要密碼才能訪問
5、可以通過一個(gè)在線測(cè)試api的工具，直接生成markdown，你幾乎不用寫代碼就能過所有的參數(shù)自動(dòng)生成
6、支持模版插入
7、支持歷史版本，你可以把操作恢復(fù)到以前的版本。
8、完全開源
9、可以部署到自己的服務(wù)器
10、可以分享并導(dǎo)出項(xiàng)目，生成需要的文檔格式如doc，可以離線瀏覽
11、支持響應(yīng)式，手機(jī)電腦同樣精彩

軟件功能

一、分享與導(dǎo)出
響應(yīng)式網(wǎng)頁設(shè)計(jì)，可將項(xiàng)目文檔分享到電腦或移動(dòng)設(shè)備查看。同時(shí)也可以將項(xiàng)目導(dǎo)出成word文件，以便離線瀏覽。
二、編輯功能
1、markdown編輯
采用markdown編輯器，無論是編輯還是閱讀體驗(yàn)都極佳很棒。如果你不了解Markdown，請(qǐng)?jiān)谒阉饕嫠阉鳌闭J(rèn)識(shí)與入門 Markdown”
2、模板插入
在軟件的編輯頁面，點(diǎn)擊編輯器上方的按鈕可方便地插入API接口模板和數(shù)據(jù)字典模板。插入模板后，剩下的就是改動(dòng)數(shù)據(jù)了，省去了很多編輯的力氣。
3、歷史版本
為頁面提供歷史版本功能，你可以方便地把頁面恢復(fù)到之前的版本。
三、權(quán)限管理
1、公開項(xiàng)目與私密項(xiàng)目
軟件上的項(xiàng)目有公開項(xiàng)目和私密項(xiàng)目?jī)煞N。公開項(xiàng)目可供任何登錄與非登錄的用戶訪問，而私密項(xiàng)目則需要輸入密碼驗(yàn)證訪問。密碼由項(xiàng)目創(chuàng)建者設(shè)置。
2、項(xiàng)目轉(zhuǎn)讓
項(xiàng)目創(chuàng)建者可以自由地把項(xiàng)目轉(zhuǎn)讓給網(wǎng)站的其他用戶。
3、項(xiàng)目成員
你可以很方便地為軟件的項(xiàng)目添加、刪除項(xiàng)目成員。項(xiàng)目成員可以對(duì)項(xiàng)目進(jìn)行編輯，但不可轉(zhuǎn)讓或刪除項(xiàng)目（只有項(xiàng)目創(chuàng)建者才有權(quán)限）
4、團(tuán)隊(duì)管理
你可以自行添加多個(gè)團(tuán)隊(duì)，為團(tuán)隊(duì)分配不同的項(xiàng)目，同時(shí)設(shè)置團(tuán)隊(duì)里每個(gè)人的權(quán)限。

軟件優(yōu)勢(shì)

1、API文檔
隨著移動(dòng)互聯(lián)網(wǎng)的發(fā)展，BaaS（后端即服務(wù)）越來越流行。服務(wù)端提供API，APP端或者網(wǎng)頁前端便可方便調(diào)用數(shù)據(jù)。用ShowDoc可以非常方便快速地編寫出美觀的API文檔，同時(shí)還將支持從代碼文件中自動(dòng)生成API文檔
2、說明文檔
你完全可以使用它來編寫一些工具的說明書,也可以編寫一些技術(shù)規(guī)范說明文檔以供團(tuán)隊(duì)查閱。
3、數(shù)據(jù)字典
一份好的數(shù)據(jù)字典可以很方便地向別人說明你的數(shù)據(jù)庫結(jié)構(gòu)，如各個(gè)字段的釋義等。

常見問題

1、提示驗(yàn)證碼驗(yàn)證失敗
先到php.ini文件下找找session的保存目錄，然后檢查安裝session目錄有沒有寫入權(quán)限，或者可不可能是磁盤空間滿了的問題
2、可以關(guān)閉注冊(cè)嗎？
編輯文件 server/Application/Api/Controller/UserController.class.php，
在register()里面，這個(gè)方法的開頭處加上兩行代碼：
$this->sendError(10101,'不開放注冊(cè)');
return ;
3、開源版如何連接數(shù)據(jù)庫
使用sqlite數(shù)據(jù)庫。數(shù)據(jù)庫文件是安裝目錄下的Sqlite/showdoc.db.php。你可以網(wǎng)絡(luò)搜索如何在命令行中使用 sqlite數(shù)據(jù)庫.或者使用SQLiteStudio等可視化工具
4、錯(cuò)誤提示”Could not find driver “
請(qǐng)安裝php-pdo 和 pdo_sqlite 。
對(duì)于Windowns服務(wù)器，在php.ini里面把”extension=php_sqlite.dll”和”extension=php_pdo_sqlite.dll”啟用以便開啟對(duì)SQlite的支持；
Linux服務(wù)器安裝php5.3以上版本時(shí)理論上默認(rèn)是開啟了php-pdo和pdo_sqlite的。如果你安裝的PHP依然沒有，則可搜索網(wǎng)絡(luò)教程安裝之。

更新日志

v2.4.0（2019-07-30）
1、可通過代碼注釋自動(dòng)生成API文檔。詳情請(qǐng)點(diǎn)擊任一個(gè)具體項(xiàng)目的項(xiàng)目設(shè)置頁面-開放API
2、頁面查看的時(shí)候增加歷史版本的入口
3、增加對(duì)IE11和edge瀏覽器的兼容支持
4、登錄/注冊(cè)頁面，項(xiàng)目密碼頁面增加回車快捷鍵支持
5、修改個(gè)人設(shè)置頁面在某些瀏覽器下不能點(diǎn)擊返回的bug
6、修復(fù)編輯器在某些情況下預(yù)覽為空白的bug
7、修復(fù)粘貼上傳圖片時(shí)會(huì)重復(fù)上傳的問題
8、修復(fù)保存文檔的快捷鍵(ctrl+s或command+s)
2018年2月
1、使用vue + element框架重構(gòu)了ShowDoc的前端頁面，優(yōu)化UI風(fēng)格
2、提高不同頁面之間切換速度
3、項(xiàng)目展示頁面，左側(cè)欄允許收縮
4、優(yōu)化目錄的添加和管理