showDoc的基本使用方法

時間 2019-11-30

標籤 showdoc 基本使用方法简体版

原文原文鏈接

ShowDoc介紹

ShowDoc就是一個很是適合IT團隊的在線文檔分享工具，它能夠加快團隊之間溝通的效率。php

API文檔（查看Demo）

隨着移動互聯網的發展，BaaS（後端即服務）愈來愈流行。服務端提供API，APP端或者網頁前端即可方便調用數據。用ShowDoc能夠很是方便快速地編寫出美觀的API文檔。html
數據字典（查看Demo）

一份好的數據字典能夠很方便地向別人說明你的數據庫結構，如各個字段的釋義等。前端
說明文檔（查看Demo ）

你徹底可使用showdoc來編寫一些工具的說明書,也能夠編寫一些技術規範說明文檔以供團隊查閱。mysql

它都有些什麼功能

分享與導出
- 響應式網頁設計，可將項目文檔分享到電腦或移動設備查看。同時也能夠將項目導出成word文件，以便離線瀏覽。
權限管理
- 公開項目與私密項目linux
  
  ShowDoc上的項目有公開項目和私密項目兩種。公開項目可供任何登陸與非登陸的用戶訪問，而私密項目則須要輸入密碼驗證訪問。密碼由項目建立者設置。git
- 項目轉讓github
  
  項目建立者能夠自由地把項目轉讓給網站的其餘用戶。web
- 項目成員sql
  
  你能夠很方便地爲ShowDoc的項目添加、刪除項目成員。項目成員能夠對項目進行編輯，但不可轉讓或刪除項目（只有項目建立者纔有權限）數據庫
編輯功能
- markdown編輯
  
  ShowDoc採用markdown編輯器，不管是編輯仍是閱讀體驗都極佳很棒。若是你不瞭解Markdown，請在搜索引擎搜索」認識與入門 Markdown」
- 模板插入
  
  在ShowDoc的編輯頁面，點擊編輯器上方的按鈕可方便地插入API接口模板和數據字典模板。插入模板後，剩下的就是改動數據了，省去了不少編輯的力氣。
- 歷史版本
  
  ShowDoc爲頁面提供歷史版本功能，你能夠方便地把頁面恢復到以前的版本。

關於ShowDoc的介紹，請訪問：http://blog.star7th.com/2015/11/1816.html

環境依賴

一、必需環境

PHP5.3以上版本、php-gd庫

二、可選環境

php-mysql模塊、php-pdo模塊、mysql數據庫
ShowDoc默認使用Sqlite數據庫，數據庫文件在/Sqlite目錄下。PHP環境默認支持Sqlite，無需額外安裝其餘數據庫。若是想使用Mysql數據庫，則須要安裝環境並參考下文的數據庫配置說明作相應配置。

###安裝和配置

一、全新安裝

克隆或者下載代碼：
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服務器則不須要此操做。

二、升級安裝

下載新代碼後，除了/Sqlite目錄下的全部文件和/Public/Uploads裏的文件外（若存在的話），所有覆蓋原來的代碼。從新賦予相應文件夾權限，根據本身須要更改配置（如使用mysql的須要更改配置信息）。覆蓋代碼後，先不要直接訪問首頁。而是先備份數據庫，而後在瀏覽器訪問http://xxxx.com/index.php?s=/home/update/db 升級數據庫結構，以後就能夠正常訪問首頁了。

數據庫

一、Sqlite數據庫 or Mysql數據庫？

ShowDoc默認使用Sqlite數據庫，而且自動集成到/Sqlite目錄下。用戶下載代碼後便可使用，無需再安裝其餘數據庫環境（PHP環境已經內置支持Sqlite數據庫）。
使用Sqlite數據庫是爲了方便，尤爲對非web開發人員來講是個福音。但若是你須要使用Mysql數據庫,ShowDoc也提供支持。但值得注意的是，ShowDoc只能在初始時選擇一種數據庫。若是你在使用過程當中切換到了另外一種數據庫，則有丟失原來數據的風險。
ShowDoc早期默認使用Mysql數據庫，這部分老用戶升級時請繼續且只能使用Mysql數據庫。請參考下文的配置方式

二、Mysql數據庫的配置方式

打開Application\Common\Conf\config.php，將第五、6行注視掉，而後開啓第八、9行（把註釋去掉）。效果應該以下：

//使用sqlite數據庫（ShowDoc默認） //'DB_TYPE' => 'Sqlite', //'DB_NAME' => 'Sqlite/showdoc.db.php', //使用mysql數據庫 'DB_TYPE' => 'mysql', 'DB_NAME' => 'showdoc',

此時填寫上相應的數據庫配置信息，如數據庫密碼等。若是你已經在瀏覽器中訪問過ShowDoc，記得把生成的緩存刪除掉以讓新配置生效。緩存文件在目錄/Application/Runtime下。

三、導入數據庫

將根目錄的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