ShowDoc介紹
ShowDoc就是一個非常適合IT團隊的在線文檔分享工具，它可以加快團隊之間溝通的效率。
-
API文檔（ 查看Demo）
隨着移動互聯網的發展，BaaS（后端即服務）越來越流行。服務端提供API，APP端或者網頁前端便可方便調用數據。用ShowDoc可以非常方便快速地編寫出美觀的API文檔。
-
數據字典（ 查看Demo）
一份好的數據字典可以很方便地向別人說明你的數據庫結構，如各個字段的釋義等。
-
說明文檔（查看Demo ）
你完全可以使用showdoc來編寫一些工具的說明書,也可以編寫一些技術規范說明文檔以供團隊查閱。
它都有些什么功能
-
分享與導出
- 響應式網頁設計，可將項目文檔分享到電腦或移動設備查看。同時也可以將項目導出成word文件，以便離線瀏覽。
-
權限管理
-
公開項目與私密項目
ShowDoc上的項目有公開項目和私密項目兩種。公開項目可供任何登錄與非登錄的用戶訪問，而私密項目則需要輸入密碼驗證訪問。密碼由項目創建者設置。
-
項目轉讓
項目創建者可以自由地把項目轉讓給網站的其他用戶。
-
項目成員
你可以很方便地為ShowDoc的項目添加、刪除項目成員。項目成員可以對項目進行編輯，但不可轉讓或刪除項目（只有項目創建者才有權限）
-
-
編輯功能
-
markdown編輯
ShowDoc采用markdown編輯器，無論是編輯還是閱讀體驗都極佳很棒。如果你不了解Markdown，請在搜索引擎搜索”認識與入門 Markdown”
-
模板插入
在ShowDoc的編輯頁面，點擊編輯器上方的按鈕可方便地插入API接口模板和數據字典模板。插入模板后，剩下的就是改動數據了，省去了很多編輯的力氣。
-
歷史版本
ShowDoc為頁面提供歷史版本功能，你可以方便地把頁面恢復到之前的版本。
-
關於ShowDoc的介紹，請訪問：http://blog.star7th.com/2015/11/1816.html
環境依賴
1、必需環境
- PHP5.3以上版本、php-gd庫
2、可選環境
- php-mysql模塊、php-pdo模塊、mysql數據庫
-
ShowDoc默認使用Sqlite數據庫，數據庫文件在/Sqlite目錄下。PHP環境默認支持Sqlite，無需額外安裝其他數據庫。如果想使用Mysql數據庫，則需要安裝環境並參考下文的數據庫配置說明做相應配置。
###安裝和配置
1、全新安裝
- 克隆或者下載代碼：
https://github.com/star7th/showdoc -
文件夾權限
請確保/Application/Runtime 、 /Public/Uploads 、 /Sqlite 、 /Sqlite/showdoc.db.php 有可寫權限 -
Windows服務器
在php.ini里面把”extension=php_sqlite.dll”啟用以便開啟對Sqlite的支持；也啟用php_mbstring.dll；Linux服務器則不需要此操作。
2、升級安裝
- 下載新代碼后，除了/Sqlite目錄下的所有文件和/Public/Uploads里的文件外（若存在的話），全部覆蓋原來的代碼。重新賦予相應文件夾權限，根據自己需要更改配置（如使用mysql的需要更改配置信息）。覆蓋代碼后，先不要直接訪問首頁。而是先備份數據庫，然后在瀏覽器訪問http://xxxx.com/index.php?s=/home/update/db 升級數據庫結構，之后就可以正常訪問首頁了。
數據庫
1、Sqlite數據庫 or Mysql數據庫？
ShowDoc默認使用Sqlite數據庫，並且自動集成到/Sqlite目錄下。用戶下載代碼后即可使用，無需再安裝其他數據庫環境（PHP環境已經內置支持Sqlite數據庫）。
使用Sqlite數據庫是為了方便，尤其對非web開發人員來說是個福音。但如果你需要使用Mysql數據庫,ShowDoc也提供支持。但值得注意的是，ShowDoc只能在初始時選擇一種數據庫。如果你在使用過程中切換到了另一種數據庫，則有丟失原來數據的風險。
ShowDoc早期默認使用Mysql數據庫，這部分老用戶升級時請繼續且只能使用Mysql數據庫。請參考下文的配置方式
2、Mysql數據庫的配置方式
打開Application\Common\Conf\config.php，將第5、6行注視掉，然后開啟第8、9行（把注釋去掉）。效果應該如下：
//使用sqlite數據庫（ShowDoc默認） //'DB_TYPE' => 'Sqlite', //'DB_NAME' => 'Sqlite/showdoc.db.php', //使用mysql數據庫 'DB_TYPE' => 'mysql', 'DB_NAME' => 'showdoc', 此時填寫上相應的數據庫配置信息，如數據庫密碼等。如果你已經在瀏覽器中訪問過ShowDoc，記得把生成的緩存刪除掉以讓新配置生效。緩存文件在目錄/Application/Runtime下。
3、導入數據庫
將根目錄的showdoc.sql文件導入Mysql數據庫
錯誤排查
部署時出錯，請先確認是否按照文檔步驟執行（例如說目錄權限有沒有）。然后進Application/Runtime/Log 看一下日志，或清除下Application/Runtime/目錄下所有文件和子目錄（這些都是緩存）試試。再遇到無法解決的問題可上github和博客搜索下有沒有已解決的的問題。也可以加qq交流群564671853。再不行還可以聯系我，聯系方式有博客、github、郵件等。
其他可選配置
- 驗證碼
\Application\Common\Conf/Config.php 配置項里面增加 ‘CloseVerify’ => true 即可關閉驗證碼
使用在線的ShowDoc
如果你沒有自己的服務器，但又想使用ShowDoc作為分檔分享工具，你可以使用在線的ShowDoc http://doc.star7th.com
http://doc.star7th.com 作為在線服務會長期維護，請放心托管你的文檔數據，不用擔心突然關站的問題。如對數據非常敏感的個人或企業，還是把ShowDoc部署到自己的服務器比較好。
1.安裝 Apache + PHP
yuminstall httpd
yuminstall php php-gd php-mcrypt php-mbstring php-mysql php-pdo
servicehttpd start
chkconfighttpd on
showdoc需要5.3以上的php,查看php版本，正確后繼續
2.准備showdoc安裝文件
有兩種方式：
a.上傳已有的showdoc到 /var/www/html
b.在/var/www/html使用命令下載，后解壓得到showdoc
備注（ 如果使用 wget -c https://codeload.github.com/star7th/showdoc/zip/master 在下載后得到一個master無文件類型，使用cp master master.zip,變為zip類型，然后unzip master.zip 即可得到showdoc-master）
3.統一showdoc主要安裝文件和httpd的用戶
這是個大坑，網上許多都說的是給文件賦可寫權限，其實文件默認是可寫的，不可寫是因為相關文件和httpd的用戶不一致。
a. ps -ef|grep httpd查看httpd用戶
本例為httpd用戶為apache：
b.改變用戶所屬組
在showdoc-master內執行
chown-Rapache:apache install/ Public/Uploads/ Application/Runtime/server/Application/Runtime/ Application/Common/Conf/config.phpApplication/Home/Conf/config.phpSqlite
4.訪問http://ip/showdoc-master/install/，進行安裝如果提示如下
請賦予 install 目錄以可寫權限！
請賦予 Public/Uploads/目錄以可寫權限！
請賦予Application/Runtime 目錄以可寫權限！
請賦予server/Application/Runtime 目錄以可寫權限！
請賦予Application/Common/Conf/config.php 文件以可寫權限！
請賦予Application/Home/Conf/config.php 文件以可寫權限！
(如果你確定賦予了文件權限但卻一直看到此信息，則可考慮關閉selinux試試)
a.查看selinux狀態
/usr/sbin/sestatus -v ##如果SELinux status參數為enabled即為開啟狀態
b.臨時關閉selinux
setenforce 0
c.再次訪問http://ip/showdoc-master/install/，到此安裝完成
備注：
開始安裝時訪問http://ip/showdoc-master/，直接會報目錄[./Application/Runtime]不可寫，這個只要執行第3、4步即可解決