精华内容
下载资源
问答
  • swagger-showdoc 项目介绍 很多在使用swagger的公司都有一个问题,文档真的可读性不高,在有些情况下,甚至只是开发人员自己能玩,完全不能作为开放文档使用。本项目旨在帮助使用swagger项目的团队,利用现有的...
  • ShowDoc本地安装.zip

    2020-06-08 13:58:38
    每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !...ShowDoc就是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率。
  • ShowDoc

    千次阅读 2020-02-08 21:51:37
    ShowDoc 官网 https://www.showdoc.cc/ GitHub https://github.com/star7th/showdoc 帮助说明 https://www.showdoc.cc/help?page_id=1385767280275683 ShowDoc 是什么? 每当接手一个他人开发好的模块或者...

    ShowDoc


    官网

    https://www.showdoc.cc/

    GitHub

    https://github.com/star7th/showdoc

    帮助说明

    https://www.showdoc.cc/help?page_id=1385767280275683


    ShowDoc 是什么?

    每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !!
    
    程序员都很希望别人能写技术文档,而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版,想着新建的word文档放在哪个目录等各种非技术细节。
    
    word文档零零散散地放在团队不同人那里,需要文档的人基本靠吼,吼一声然后上qq或者邮箱接收对方丢过来的文档。这种沟通方式当然可以,只是效率不高。
    
    ShowDoc就是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率。

    它都有些什么功能?

    分享与导出
    响应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件,以便离线浏览。
    
    
    权限管理
    
    公开项目与私密项目
    ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。
    项目转让
    项目创建者可以自由地把项目转让给网站的其他用户。
    
    项目成员
    你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)
    
    团队管理
    利用showdoc的团队功能你可以更好地进行团队协作
    
    
    编辑功能
    
    markdown编辑
    ShowDoc采用markdown编辑器,无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown,请在搜索引擎搜索”认识与入门 Markdown”
    
    模板插入
    在ShowDoc的编辑页面,点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后,剩下的就是改动数据了,省去了很多编辑的力气。
    
    历史版本
    ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。

    部署到自己的服务器

    ShowDoc部署手册请参考:https://www.showdoc.cc/help?page_id=13732
    
    开源地址:https://github.com/star7th/showdoc 。若觉得showdoc好用,不妨点个star。良好的关注度和参与度有助于开源项目的长远发展。
    
    二次开发指引
    
    https://www.showdoc.cc/help?page_id=1385576954326448

    自动脚本安装

    #下载
    sudo wget https://www.showdoc.cc/script/showdoc
    
    # 增加执行权限
    sudo chmod +x showdoc
    
    # 安装软件
    sudo apt install curl
    
    
    #默认安装中文版。如果想安装英文版,请加上 en 参数,如 ./showdoc en
    ./showdoc
    # showdoc 脚本
    
    #!/bin/bash
    if [[  -n "$1" ]] ; then 
    	action=$1
    else
    	action='install'
    fi
    if [ "$action" == "start" ] ;then
    	sudo -s  service docker start
    	sudo -s docker start showdoc
    	exit 1 
    fi
    if [ "$action" == "restart" ] ;then
    	sudo -s docker restart showdoc 
    	exit 1
    fi
    if [ "$action" == "stop" ] ;then
    	sudo -s docker stop showdoc 
    	exit 1
    fi
    if [ "$action" == "update" ] ;then
    	DATE=$(date +%Y%m%d_%H%M%S_%N) 
    	if [ ! -d "/showdoc_data/html" ]; then 
    		echo  "Directory /showdoc_data/html does not exist"
    		echo "/showdoc_data/html 目录不存在"
    		exit 1 ;
    	fi
    	rm -f master.tar.gz
    	wget https://github.com/star7th/showdoc/archive/master.tar.gz
    	if [ ! -f "master.tar.gz" ]; then 
    		echo "Download file fail" 
    		echo "文件下载失败" 
    		exit 1 
    	fi
    	sudo -s docker stop showdoc 
    	sudo -s chmod  -R 777 /showdoc_data/
    	sudo -s mv /showdoc_data/html /showdoc_data/html_bak_${DATE}
    	tar -zxvf master.tar.gz -C /showdoc_data/ 
    	sudo -s mv /showdoc_data/showdoc-master /showdoc_data/html  ##// */
    	if  [ ! -d "/showdoc_data/html" ]; then 
    		echo  "Directory /showdoc_data/html does not exist"
    		echo "/showdoc_data/html 目录不存在"
    		exit 1 ;
    	fi
    	sudo -s chmod  -R 777 /showdoc_data/html
    	sudo -s docker start showdoc
    	sleep 10
    
    	result=$(tail /showdoc_data/html_bak_${DATE}/web/index.html | grep zh)
    	if [ ! -z "$result" ] ; then 
    		curl http://localhost:4999/install/non_interactive.php?lang=zh
    	else
    		curl http://localhost:4999/install/non_interactive.php?lang=en
    	fi
    
    	\cp  -f  /showdoc_data/html_bak_${DATE}/Sqlite/showdoc.db.php /showdoc_data/html/Sqlite/showdoc.db.php
    	\cp -r -f /showdoc_data/html_bak_${DATE}/Public/Uploads /showdoc_data/html/Public/
    	sudo -s curl http://localhost:4999?s=/home/update/db
    	rm -f master.tar.gz
    
    	exit 1
    fi
    if [ "$action" == "uninstall" ] ;then
    	echo -e " Showdoc is about to be uninstalled. Are you sure to delete all showdoc data? [Y/n] \n 即将卸载showdoc,你是否确认删除showdoc所有数据? [Y/n]  "
    	read -r -p '' input
    	case $input in
    	    [yY][eE][sS]|[yY])
    				sudo -s docker stop showdoc
    				sudo -s docker rm showdoc
    				echo "uninstalling..."
    				echo "正在卸载..."
    				sudo -s docker rmi xd2idwf5.mirror.aliyuncs.com/star7th/showdoc
    				sudo -s docker rmi registry.docker-cn.com/star7th/showdoc
    				sudo -s docker rmi registry.cn-shenzhen.aliyuncs.com/star7th/showdoc
    				sudo -s docker rmi star7th/showdoc
    				sudo -s rm -rf /showdoc_data
    				echo "Done"
    				echo "完成"
    
    			;;
    
    	    [nN][oO]|[nN])
    	       		;;
    	    *)
    		exit 1
    		;;
    	esac
    	exit 1
    fi
    if ! [ -x "$(command -v docker)" ]; then
      echo 'It was detected that Docker was not installed. Attempting to install from the network... The time required is related to your network environment.'
      echo '检测到Docker尚未安装。正在试图从网络安装...所需时间与你的网络环境有关'
      sudo -s curl -sSL https://get.daocloud.io/docker | sh
      sudo -s  chkconfig docker on 
    fi
    if ! [ -x "$(command -v docker)" ]; then
      echo 'It was detected that Docker was not installed. Attempting to install from the network... The time required is related to your network environment.' 
      echo '检测到Docker尚未安装。正在试图从网络安装...所需时间与你的网络环境有关'
      sudo -s curl -sSL http://acs-public-mirror.oss-cn-hangzhou.aliyuncs.com/docker-engine/internet | sh -
      sudo -s  chkconfig docker on 
    fi
    if ! [ -x "$(command -v docker)" ]; then
      echo 'Docker failed to install automatically. It is recommended that you install the docker environment manually before starting this script.' 
      echo 'Docker自动安装失败,建议你手动安装好docker环境后再启动本脚本' 
      exit 1 
    fi
    
    if  [  "$(docker images  |grep showdoc)" ]; then
      echo ""
      echo "You have installed showdoc image"
      echo "If you want to update showdoc, please execute  ./showdoc update "
      echo "If you want to restart showdoc, please execute    ./showdoc restart "
      echo "If you want to uninstall showdoc, please execute    ./showdoc uninstall "
      echo ""
      echo "你已经安装过showdoc镜像"
      echo "如果你想更新showdoc,请执行  ./showdoc update "
      echo "如果你想重启showdoc,请执行  ./showdoc restart "
      echo "如果你想卸载showdoc,请执行  ./showdoc uninstall "
      exit 1 
    fi
    sudo -s  service docker start
    echo 'The showdoc image is being retrieved, please wait a moment... The time required is related to your network environment.'
    echo '正在拉取showdoc镜像,请稍后...所需时间与你的网络环境有关'
    
    if [ "$action" == "en" ] ;then
     	sudo -s docker pull star7th/showdoc
    else
    	sudo -s docker pull registry.cn-shenzhen.aliyuncs.com/star7th/showdoc
    	sudo -s docker tag registry.cn-shenzhen.aliyuncs.com/star7th/showdoc:latest star7th/showdoc:latest 
    fi
    
    
    
    sudo -s mkdir /showdoc_data
    if  [ ! -d "/showdoc_data" ]; then 
    	echo "/showdoc_data directory does not exist. Make sure you have create permissions"
    	echo "/showdoc_data 目录不存在,请确保有创建权限"
    	exit 1 ;
    fi
    sudo -s mkdir /showdoc_data/html
    sudo -s chmod  -R 777 /showdoc_data
    sudo -s docker run -d --name showdoc -p 4999:80 -v /showdoc_data/html:/var/www/html/ star7th/showdoc
    sleep 10
    if [ "$action" == "en" ] ;then
     	sudo -s curl http://localhost:4999/install/non_interactive.php?lang=en
    else
    	sudo -s curl http://localhost:4999/install/non_interactive.php?lang=zh
    fi
    sudo -s wget http://localhost:4999/install/install.lock
    if [  -f "install.lock" ]; then 
    	rm -rf install.lock 
    	if [ "$action" == "en" ] ;then
    		echo -e "\n \033[32m Successful installation , The address is:http://localhost:4999 (You can also use LAN or public IP / domain name access)  \033[0m \n"
    		echo -e " \033[32m The account password is showdoc/123456 , After you log in, you can see the admin buttun at the top right.Suggested password modification after login   \033[0m \n"
    		echo -e " \033[32m For questions or suggestions on showdoc, please go to  https://github.com/star7th/showdoc   \033[0m \n"
    
    	else
    		echo -e "\n \033[32m 安装成功,访问地址:http://localhost:4999 (你也可以用局域网或者公网IP/域名访问)  \033[0m \n"
    		echo -e " \033[32m 账户密码是showdoc/123456,登录后你便可以看到右上方的管理后台入口。建议登录后修改密码。   \033[0m \n"
    		echo -e " \033[32m 对showdoc的问题或建议请至https://github.com/star7th/showdoc 提issue   \033[0m \n"
    		echo -e " \033[32m 若觉得showdoc好用,不妨到github点个star。良好的关注度和参与度有助于开源项目的长远发展   \033[0m \n"
    	fi
    
    
    
    fi

     

    # Ubuntu-18 未成功

     

    # CentOS-7.4
    
    It was detected that Docker was not installed. Attempting to install from the network... The time required is related to your network environment.
    检测到Docker尚未安装。正在试图从网络安装...所需时间与你的网络环境有关
    # Executing docker install script, commit: f45d7c11389849ff46a6b4d94e0dd1ffebca32c1
    + sh -c 'yum install -y -q yum-utils'
    软件包 yum-utils-1.1.31-52.el7.noarch 已安装并且是最新版本
    + sh -c 'yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo'
    已加载插件:fastestmirror
    adding repo from: https://download.docker.com/linux/centos/docker-ce.repo
    grabbing file https://download.docker.com/linux/centos/docker-ce.repo to /etc/yum.repos.d/docker-ce.repo
    repo saved to /etc/yum.repos.d/docker-ce.repo
    + '[' stable '!=' stable ']'
    + sh -c 'yum makecache'
    已加载插件:fastestmirror
    Loading mirror speeds from cached hostfile
    base                                                              | 3.6 kB  00:00:00     
    docker-ce-stable                                                  | 3.5 kB  00:00:00     
    epel                                                              | 5.4 kB  00:00:00     
    extras                                                            | 2.9 kB  00:00:00     
    gitlab-ce                                                         | 2.9 kB  00:00:00     
    gitlab_gitlab-ce/x86_64/signature                                 |  836 B  00:00:00     
    gitlab_gitlab-ce/x86_64/signature                                 | 1.0 kB  00:00:00 !!! 
    gitlab_gitlab-ce-source/signature                                 |  836 B  00:00:00     
    gitlab_gitlab-ce-source/signature                                 |  951 B  00:00:00 !!! 
    mysql-connectors-community                                        | 2.5 kB  00:00:00     
    mysql-tools-community                                             | 2.5 kB  00:00:00     
    mysql57-community                                                 | 2.5 kB  00:00:00     
    nginx-stable                                                      | 2.9 kB  00:00:00     
    updates                                                           | 2.9 kB  00:00:00     
    (1/11): docker-ce-stable/x86_64/updateinfo                        |   55 B  00:00:00     
    (2/11): docker-ce-stable/x86_64/primary_db                        |  37 kB  00:00:00     
    (3/11): epel/x86_64/prestodelta                                   | 2.6 kB  00:00:00     
    (4/11): epel/x86_64/other_db                                      | 3.3 MB  00:00:00     
    (5/11): epel/x86_64/updateinfo_zck                                | 1.5 MB  00:00:00     
    (6/11): epel/x86_64/filelists_db                                  |  12 MB  00:00:00     
    (7/11): updates/7/x86_64/filelists_db                             | 4.0 MB  00:00:00     
    (8/11): docker-ce-stable/x86_64/other_db                          | 111 kB  00:00:00     
    (9/11): updates/7/x86_64/other_db                                 | 481 kB  00:00:00     
    (10/11): docker-ce-stable/x86_64/filelists_db                     |  18 kB  00:00:04     
    (11/11): gitlab-ce/7/filelists_db                                 | 281 MB  00:00:26     
    元数据缓存已建立
    + '[' -n '' ']'
    + sh -c 'yum install -y -q docker-ce'
    warning: /var/cache/yum/x86_64/7/docker-ce-stable/packages/docker-ce-19.03.5-3.el7.x86_64.rpm: Header V4 RSA/SHA512 Signature, key ID 621e9f35: NOKEY
    docker-ce-19.03.5-3.el7.x86_64.rpm 的公钥尚未安装
    导入 GPG key 0x621E9F35:
     用户ID     : "Docker Release (CE rpm) <docker@docker.com>"
     指纹       : 060a 61c5 1b55 8a7f 742b 77aa c52f eb6b 621e 9f35
     来自       : https://download.docker.com/linux/centos/gpg
    setsebool:  SELinux is disabled.
    If you would like to use Docker as a non-root user, you should now consider
    adding your user to the "docker" group with something like:
    
      sudo usermod -aG docker your-user
    
    Remember that you will have to log out and back in for this to take effect!
    
    WARNING: Adding a user to the "docker" group will grant the ability to run
             containers which can be used to obtain root privileges on the
             docker host.
             Refer to https://docs.docker.com/engine/security/security/#docker-daemon-attack-surface
             for more information.
    注意:正在将请求转发到“systemctl enable docker.service”。
    Created symlink from /etc/systemd/system/multi-user.target.wants/docker.service to /usr/lib/systemd/system/docker.service.
    Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
    Redirecting to /bin/systemctl start docker.service
    The showdoc image is being retrieved, please wait a moment... The time required is related to your network environment.
    正在拉取showdoc镜像,请稍后...所需时间与你的网络环境有关
    Using default tag: latest
    latest: Pulling from star7th/showdoc
    ff3a5c916c92: Pulling fs layer 
    2ca736d3a2d3: Pulling fs layer 
    ed01bffbd8ba: Pulling fs layer 
    86a241b7142f: Pulling fs layer 
    2ffa2200859b: Pulling fs layer 
    bba89656402e: Pulling fs layer 
    3f9869615113: Pulling fs layer 
    ca6f4c22bb7e: Pulling fs layer 
    c6e670a03139: Pulling fs layer 
    d68194d4a919: Pulling fs layer 
    3886fecfffe3: Pull complete 
    72d73c916ca2: Pull complete 
    66c290981af1: Pull complete 
    ae984e1cd476: Pull complete 
    4f5c98e97881: Pull complete 
    7a5c8005874f: Pull complete 
    d0e5afcf9ed6: Pull complete 
    a77fddbcccce: Pull complete 
    29fbff2beeff: Pull complete 
    6acbe516593c: Pull complete 
    b2e0f8f06f86: Pull complete 
    a3982ad6ae6d: Pull complete 
    53fe85e64f8b: Pull complete 
    401d987fb2cd: Pull complete 
    955b2c3c2280: Pull complete 
    b7957d06df75: Pull complete 
    fce749939a8f: Pull complete 
    747e227b8897: Pull complete 
    8eea7612ac50: Pull complete 
    fc16400d9d1c: Pull complete 
    3e0ee360fd75: Pull complete 
    825d163187d4: Pull complete 
    998e867b72f9: Pull complete 
    ee3cf456b599: Pull complete 
    575d41d3ddbb: Pull complete 
    36d46827cd08: Pull complete 
    283a81555d5d: Pull complete 
    a9f839ce9b50: Pull complete 
    Digest: sha256:7bed49190407043d99cce85e34c655fc3ca133d8f66dcdc40f75b30ba1528d47
    Status: Downloaded newer image for registry.cn-shenzhen.aliyuncs.com/star7th/showdoc:latest
    registry.cn-shenzhen.aliyuncs.com/star7th/showdoc:latest
    2b072edda2bb1ef5fc3cd2d0709cfb2a0f2a232213b944f6e10a85bed2085bf1
    install success !!!
    --2020-02-08 22:13:54--  http://localhost:4999/install/install.lock
    正在解析主机 localhost (localhost)... 127.0.0.1, ::1
    正在连接 localhost (localhost)|127.0.0.1|:4999... 已连接。
    已发出 HTTP 请求,正在等待回应... 200 OK
    长度:23 [application/octet-stream]
    正在保存至: “install.lock”
    
    100%[===============================================>] 23          --.-K/s 用时 0s      
    
    2020-02-08 22:13:54 (1.80 MB/s) - 已保存 “install.lock” [23/23])
    
    
      安装成功,访问地址:http://localhost:4999 (你也可以用局域网或者公网IP/域名访问)   
    
      账户密码是showdoc/123456,登录后你便可以看到右上方的管理后台入口。建议登录后修改密码。    
    
      对showdoc的问题或建议请至https://github.com/star7th/showdoc 提issue    
    
      若觉得showdoc好用,不妨到github点个star。良好的关注度和参与度有助于开源项目的长远发展
    #下面附上脚本其他命令,以便管理 showdoc 时可以用得上。
    
     #停止
     ./showdoc stop 
    
     #重启
     ./showdoc restart
    
     #升级showdoc到最新版
     ./showdoc update
    
     #卸载showdoc
     ./showdoc uninstall

     

    展开全文
  • showdoc安装搭建手册

    2018-03-09 13:17:14
    ShowDoc是什么 每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !! 程序员都很希望别人能写技术文档,而自己却很不希望要写文档。因为写...
  • showDoc安装包

    2018-06-23 15:16:36
    showDoc安装包,点击exe即可安装该软件,前提是要有php环境,内含官网下载链接
  • ShowDoc是什么 每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !! 程序员都很希望别人能写技术文档,而自己却很不希望要写文档。因为写...
  • 内容包括: 1、PHP运行环境(WAMP)wamp-server-wamp5-2-5-multi-win.zip 2、vcredist_x86(环境文件) 3、showdoc部署代码 以上资源仅为学习使用,如有问题欢迎联系进行修改
  • showdoc, ShowDoc是一个非常适用于it团队在网上共享文档的工具 中文版教程:https://www.showdoc.cc/help什么是 ShowDoc?每当我们接受一个由它的他人开发的模块或者项目时,我们总是觉得那些没有注释的代码。 文档...
  • showdoc安装

    2017-08-03 15:52:37
    showdoc showdoc 环境安装
  • showdoc
  • showdoc文档工具

    2018-07-16 22:16:20
    开发过程中文档显示,一个非常适合IT团队的在线API文档、技术文档工具。你可以使用Showdoc来编写在线API文档、技术文档、数据字典、在线手册
  • showdoc.db.php

    2020-05-17 19:09:50
    数据库备份资料 sqlite
  • showdoc完整包.zip

    2019-05-09 09:41:45
    1.先安装c环境,已安装的就不需要安装了,vcredist 2.安装wamp 3.将showdoc-master解压后丢到:\wamp\www下面
  • showdoc源代码

    2018-10-16 08:05:17
    showdoc源代码
  • showDoc部署资源

    热门讨论 2017-04-25 18:04:04
    showDoc部署的资源都在这里,里面也注明了官网下载地址
  • 什么是ShowDoc? 每当我们接管其他人开发的模块或项目时,我们总是会疯狂地看着那些没有注释的代码。 文件在哪里? 文件在哪里? 给我看文档! 程序员经常希望其他人写技术文档,而不希望自己写技术文档。 因为...
  • Java多多种种方方式式动动态态生生成成doc文文档档 这篇文章主要为大家详细介绍了Java动态生成doc文档的多种方式,具有一定的参考价值感兴趣的小伙伴们可 参 考一下 本来是要在Android端生成doc的 这需求....
  • showdoc.zip

    2020-07-28 17:26:08
    linux下以docker方式离线安装部署showdoc,内附安装部署教程。
  • showdoc接口文档平台客户端
  • showdoc-master.zip

    2021-07-28 10:37:35
    showdoc-master
  • showdoc.md

    2020-03-30 15:47:01
    showdoc的接口md模板
  • showdoc-master

    2018-11-09 14:00:36
    showdoc用以接口文档管理,方便开发人员在开发过程中记录接口信息,测试人员测试及文档最终归档
  • Showdoc

    2017-02-20 21:28:00
    ShowDoc介绍 关于ShowDoc的介绍,请访问:http://blog.star7th.com/2015/11/1816.html 环境依赖 1、必需环境 PHP5.3及以上版本、php-gd库、php-pdo模块 2、可选环境 • php-mysql模块、php-pdo模块、mysql5.5及以下...

    ShowDoc介绍
    关于ShowDoc的介绍,请访问:http://blog.star7th.com/2015/11/1816.html
    环境依赖
    1、必需环境

    PHP5.3及以上版本、php-gd库、php-pdo模块

    2、可选环境

    • php-mysql模块、php-pdo模块、mysql5.5及以下版本
    • ShowDoc默认使用Sqlite数据库,数据库文件在/Sqlite目录下。PHP环境默认支持Sqlite,无需额外安装其他数据库。如果想使用Mysql数据库,则请在安装的时候选择Mysql数据库

    安装和配置
    1、PHP环境的安装

     请先安装好PHP运行环境。可参考:http://www.showdoc.cc/php 。如已经安装好,则请忽略此步骤。

    2、全新安装

    • 克隆或者下载代码:
    https://github.com/star7th/showdoc
    • 文件夹权限
    请确保/Application/Runtime 、 /Public/Uploads 、 /Sqlite 、 /Sqlite/showdoc.db.php 有可写权限
    • Windows服务器
    在php.ini里面把”extension=php_sqlite.dll”和”extension=php_pdo_sqlite.dll”启用以便开启对SQlite的支持;也启用php_mbstring.dll;Linux服务器则不需要此操作。
    • 运行安装
    http://xxxx.com/install/

    3、升级安装

    • 备份旧代码目录/备份数据库
    • 下载新代码。解压到某目录。复制旧代码目录的/Sqlite目录下的所有文件、/Public/Uploads目录下的所有文件、到新目录的相应地方替换。
    • 如果你是使用Sqlite数据库,则直接复制 新/Application/Common/Conf/Config.php来覆盖旧的
    • 如果你是使用Mysql数据库,则打开新的/Application/Common/Conf/Config.php,看看有没有新增什么键值。如果有,则自己编辑旧config.php把这些键值加上去。保留旧的config文件,不要用新的覆盖。大部分情况下,很少会有键值更新。
    • 在浏览器访问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数据库。
    错误排查
    • 常见问题:http://www.showdoc.cc/3&page_id=16118
    • 部署时出错,请先确认是否按照文档步骤执行(例如说目录权限有没有)。然后进Application/Runtime/Log 看一下日志,并试图在互联网上搜索下该错误提示看有没有人遇到类似的问题。或清除下Application/Runtime/目录下所有文件和子目录(这些都是缓存)试试。再遇到无法解决的问题可上github和博客搜索下有没有已解决的的问题。也可以加qq交流群564671853。再不行还可以联系我,联系方式有博客、github、邮件等。
    其他可选配置
    • 验证码
    /Application/Common/Conf/Config.php 配置项里面增加 ‘CloseVerify’ => true 即可关闭验证码
    使用在线的ShowDoc
    • 如果你没有自己的服务器,但又想使用ShowDoc作为分档分享工具,你可以使用在线的ShowDochttp://www.showdoc.cc
    http://www.showdoc.cc 作为在线服务会长期维护,请放心托管你的文档数据,不用担心突然关站的问题。如对数据非常敏感的个人或企业,还是把ShowDoc部署到自己的服务器比较好。

    php环境安装:
    Centos
     以Centos6.6、通过yum安装为例子。需要编译安装的请暂先搜索网络教程,这里尚未来得及整理。
     首先你需要安装web服务器,apache或者nginx中的一个(如果已安装了请忽略),然后再安装PHP环境配合使用

    安装 Apache + PHP
    yum install httpd
    yum install php php-gd php-mcrypt php-mbstring php-mysql php-pdo
    service httpd start
    chkconfig httpd on

     安装完毕后,默认的Apache Web目录是/var/www/html,将ShowDoc上传并安装部署手册安装即可

    安装Nginx + PHP
    yum install nginx
    yum install php php-gd php-fpm php-mcrypt php-mbstring php-mysql php-pdo
    安装完后,在/etc/nginx/conf.d新建文件127.0.0.1.conf
    server {
            listen       8081;
            server_name  123.56.2.32;
            root         /home/web/showdoc;
            index index.php index.html;
    
            error_page  404              /404.html;
            location = /40x.html {
            }
    
            error_page   500 502 503 504  /50x.html;
            location = /50x.html {
            }
    
            location ~ \.php$ {
                root           /home/web/showdoc;
                fastcgi_pass   unix:/dev/shm/php-cgi.sock;
                fastcgi_index  index.php;
                fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;
                include        fastcgi_params;
            }
    
            location ~ /\.ht {
                deny  all;
            }
    }
    保存。然后执行命令:
    service nginx start
    service php-fpm start
    chkconfig php-fpm on
    chkconfig nginx on

    然后进入目录/var/www/html(不存在则新建),将ShowDoc上传并按照部署手册(http://blog.star7th.com/2016/05/2007.html )安装即可。安装后便可通过浏览器访问123.56.2.32:8081

    学习教程:
    http://www.showdoc.cc/php?page_id=14595 php环境安装
    http://www.showdoc.cc/help?page_id=14 showdoc软件教程
    http://blog.star7th.com/2016/05/2007.html showdoc部署手册!

    转载于:https://www.cnblogs.com/liangml/p/6421600.html

    展开全文
  • ShowDoc是什么每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !!程序员都很希望别人能写技术文档,而自己却很不希望要写文档。因为写...
  • ShowDoc搭建

    2020-12-20 19:54:24
    ShowDoc是什么 每当接手一个他人的模块或者项目,看着那些没有解释说明的资料,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !! IT人员都很希望别人能写文档,而自己却很不希望要写文档。因为写文档需要...

    ShowDoc是什么

    • 每当接手一个他人的模块或者项目,看着那些没有解释说明的资料,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !!
    • IT人员都很希望别人能写文档,而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版,想着新建的word文档放在哪个目录等各种非重点细节。
    • word格式等文档零零散散地放在团队不同人那里,需要文档的人基本靠吼,吼一声然后上qq或者邮箱接收对方丢过来的文档。这种沟通方式当然可以,只是效率不高。
    • ShowDoc就是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率。

    它可以用来做什么

    • API文档( 查看Demo)

    随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。

    • 数据字典( 查看Demo)

    一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。

    • 说明文档 ( 查看Demo)

    你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅
    它都有些什么功能

    • 分享与导出

    响应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件,以便离线浏览。

    • 权限管理
    • 公开项目与私密项目

    ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。

    • 项目转让

    项目创建者可以自由地把项目转让给网站的其他用户。

    • 项目成员

    你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)

    • 团队管理

    利用showdoc的团队功能你可以更好地进行团队协作

    • 编辑功能

    markdown编辑

    ShowDoc采用markdown编辑器,无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown,请在搜索引擎搜索”认识与入门 Markdown”

    • 模板插入

    在ShowDoc的编辑页面,点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后,剩下的就是改动数据了,省去了很多编辑的力气。

    • 历史版本

    ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。

    • 多平台

    showdoc支持网页版、手机app版和电脑客户端版。

    搭建

    环境:nginx和php
    存储:Sqlite
    在根目录下面会生成一个showdoc.db.php数据文件

    代码下载
    https://github.com/star7th/showdoc

    帮助手册
    https://www.showdoc.com.cn/help?page_id=13732

    安装nginx

    #!/bin/bash
    #for one install nginx
    #for wangjiadongge
     
    #Add users running the nginx service process
    useradd -s /sbin/nologin nginx 
    #Installation dependence
    yum groupinstall -y "Development tools"
    yum install -y  gcc wget gcc-c++ automake autoconf libtool libxml2-devel libxslt-devel perl-devel perl-ExtUtils-Embed pcre-devel openssl-devel
     
    #Download source
    wget http://nginx.org/download/nginx-1.12.2.tar.gz
    tar -xvf nginx-1.12.2.tar.gz 
    #Compile and install
    cd nginx-1.12.2/
    ./configure \
     --prefix=/usr/local/nginx/ \
    --user=nginx \
    --group=nginx \
    --with-pcre \
    --with-http_v2_module \
    --with-http_ssl_module \
    --with-http_realip_module \
    --with-http_addition_module \
    --with-http_sub_module \
    --with-http_dav_module \
    --with-http_flv_module \
    --with-http_mp4_module \
    --with-http_gunzip_module \
    --with-http_gzip_static_module \
    --with-http_random_index_module \
    --with-http_secure_link_module \
    --with-http_stub_status_module \
    --with-http_auth_request_module \
    --with-mail \
    --with-mail_ssl_module \
    --with-file-aio \
    --with-http_v2_module \
    --with-threads \
    --with-stream \
    --with-stream_ssl_module \
    
    make && make install
    mkdir -p  /usr/local/nginx/tmp/client
    ln -s /usr/local/nginx/sbin/nginx   /usr/bin/nginx
    
    #Start nginx
     cd /usr/local/src/nginx-1.12.2/
     nginx
    #View port
    ps -aux|grep nginx
    

    修改配置文件

    user  nginx nginx;
    worker_processes  1;
    
    #error_log  logs/error.log;
    #error_log  logs/error.log  notice;
    #error_log  logs/error.log  info;
    
    #pid        logs/nginx.pid;
    
    
    events {
        worker_connections  1024;
    }
    
    
    http {
        include       mime.types;
        default_type  application/octet-stream;
    
        log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                          '$status $body_bytes_sent "$http_referer" '
                          '"$http_user_agent" "$http_x_forwarded_for"';
    
        access_log  logs/access.log  main;
    
        sendfile        on;
        #tcp_nopush     on;
    
        #keepalive_timeout  0;
        keepalive_timeout  65;
    
        #gzip  on;
    
        server {
            listen       80;
            server_name  localhost;
            client_max_body_size 900m;
            proxy_buffer_size 512k;
            proxy_buffers 4 512k;
            proxy_busy_buffers_size 512k;
            proxy_temp_file_write_size 512k;
    
            #charset koi8-r;
    
            #access_log  logs/host.access.log  main;
    
            location / {
                root   html;
                index index.php  index.html index.htm;
            }
    
            error_page  404              /404.html;
             location = /40x.html {
             }
           
            error_page   500 502 503 504  /50x.html;
            location = /50x.html {
                root   html;
            }
    
            location ~ \.php$ {
                root           html;
                fastcgi_pass   127.0.0.1:9000;
                fastcgi_index  index.php;
                fastcgi_param  SCRIPT_FILENAME  /usr/local/nginx/html$fastcgi_script_name;
                include        fastcgi_params;
            }
    
            # deny access to .htaccess files, if Apache's document root
            # concurs with nginx's one
            #
            location ~ /\.ht {
                deny  all;
            }
        }
    
    }
    

    安装php

    1. 下载PHP源码包
    [root@localhost ~]#wget http://am1.php.net/distributions/php-7.2.2.tar.gz
    

    2.解压php7

    [root@localhost ~]#tar -zxvf php-7.2.2.tar.gz
    
    1. 进入php目录
    [root@localhost ~]#cd php-7.2.2
    
    1. 安装依赖包
    [root@localhost php-7.2.2]#yum install libxml2 libxml2-devel openssl openssl-devel bzip2 bzip2-devel libcurl libcurl-devel libjpeg libjpeg-devel libpng libpng-devel freetype freetype-devel gmp gmp-devel libmcrypt libmcrypt-devel readline readline-devel libxslt libxslt-devel -y
    [root@localhost php-7.2.2]#yum install -y bzip2 bzip2-devel  openldap openldap-de
    

    5.编译

    [root@localhost php-7.2.2]#./configure \
    --prefix=/usr/local/php \
    --with-config-file-path=/usr/local/php/etc \
    --enable-fpm  \
    --with-fpm-user=nginx  \
    --with-fpm-group=nginx \
    --enable-inline-optimization  \
    --disable-rpath \
    --enable-shared  \
    --enable-soap \
    --with-libxml-dir \
    --with-xmlrpc \
    --with-openssl \
    --with-mhash \
    --with-pcre-regex \
    --with-sqlite3 \
    --with-zlib \
    --enable-bcmath \
    --with-iconv \
    --with-bz2 \
    --enable-calendar \
    --with-curl \
    --with-cdb \
    --enable-dom \
    --enable-exif \
    --enable-fileinfo \
    --enable-filter \
    --with-pcre-dir \
    --enable-ftp \
    --with-gd \
    --with-openssl-dir \
    --with-jpeg-dir \
    --with-png-dir \
    --with-zlib-dir  \
    --with-freetype-dir  \
    --enable-gd-jis-conv \
    --with-gettext \
    --with-gmp \
    --with-mhash \
    --enable-json \
    --enable-mbstring \
    --enable-mbregex \
    --enable-mbregex-backtrack \
    --with-libmbfl \
    --with-onig \
    --enable-pdo  \
    --with-zlib-dir \
    --with-pdo-sqlite \
    --with-readline \
    --enable-session \
    --enable-shmop \
    --enable-simplexml \
    --enable-sockets  \
    --enable-sysvmsg \
    --enable-sysvsem \
    --enable-sysvshm \
    --enable-wddx \
    --with-libxml-dir \
    --with-xsl \
    --enable-zip \
    --enable-mysqlnd-compression-support \
    --with-pear --enable-opcache 
    

    6.安装

    [root@localhost php-7.2.2]# make && make install
    
    [root@localhost php-7.2.2]# cp php.ini-production /usr/local/php/etc/php.ini
    [root@localhost php-7.2.2]# vim /usr/local/php/etc/php.ini 
    include_path = /usr/local/php/lib/php.ini
    [root@localhost php-7.2.2]# /root/php-7.2.2/build/shtool install -c ext/phar/phar.phar /usr/local/php/bin
    [root@localhost php-7.2.2]# ln -s -f phar.phar /usr/local/php/bin/phar
    [root@localhost php-7.2.2]# cp /usr/local/php/etc/php-fpm.conf.default /usr/local/php/etc/php-fpm.conf
    

    7.修改环境变量

    [root@localhost php-7.2.2]# vim /etc/profile
    export PHP_HOME=/usr/local/php
    export PATH=$PATH:$PHP_HOME/bin
    [root@localhost php-7.2.2]# source /etc/profile
    

    8.修改配置启动服务

    [root@localhost php-7.2.2]# cp php.ini-production /etc/php.ini
    [root@localhost php-7.2.2]# cp /usr/local/php/etc/php-fpm.d/www.conf.default /usr/local/php/etc/php-fpm.d/www.conf
    [root@localhost php-7.2.2]# cp sapi/fpm/init.d.php-fpm /etc/init.d/php-fpm
    [root@localhost php-7.2.2]# chmod +x /etc/init.d/php-fpm 
    [root@localhost php-7.2.2]# /etc/init.d/php-fpm start
    [root@localhost php-7.2.2]# php -v
    PHP 7.2.2 (cli) (built: Dec  3 2020 12:24:50) ( NTS )
    Copyright (c) 1997-2018 The PHP Group
    Zend Engine v3.2.0, Copyright (c) 1998-2018 Zend Technologiesopenldap openldap-devel
    

    在根目录写一个php测试页面

    <?php
        phpinfo();
    ?>
    

    把工程文件上传至网页根目录

    解压

    [root@localhost html]# unzip showdoc-master.zip
    [root@localhost html]# mv showdoc-master/* ./
    

    修改当前目录的属主

    [root@localhost html]# chown -R nginx.nginx ./*
    

    在浏览器上访问输入IP

    在这里插入图片描述
    在这里插入图片描述
    安装时可以选择中文,英文。这就安装好了
    默认用户showdoc 密码123456

    在这里插入图片描述
    登录进去的页面是这样。完成

    自动脚本安装

    #下载脚本并赋予权限

      wget https://www.showdoc.com.cn/script/showdoc;chmod +x showdoc;
    

    #默认安装中文版。如果想安装英文版,请加上en参数,如 ./showdoc en

    ./showdoc
    

    从手动方式升级到自动脚本方式
    如果你之前是手动安装showdoc,可考虑升级到现在这种自动脚本方式。升级到脚本方式后,就可以使用上脚本的自动化功能 ,比如说升级到最新版,重启,卸载等。
    升级方法:
    1,首先参考前文部分,在服务器全新安装一个showdoc
    2,把原来showdoc目录的Sqlite/showdoc.db.php覆盖/showdoc_data/html/Sqlite/showdoc.db.php ,Public/Uploads覆盖 /showdoc_data/html/Public/Uploads
    3,执行命令

     chmod 777 -R /showdoc_data/html
     ./showdoc update
    

    其他命令

    下面附上脚本其他命令,以便管理showdoc时可以用得上。
    #停止

     ./showdoc stop 
    

    #重启

     ./showdoc restart
    

    #升级showdoc到最新版

     ./showdoc update
    

    #卸载showdoc

    ./showdoc uninstall
    
    展开全文
  • showdoc下载

    2017-11-24 16:17:57
    showdoc项目是一个开源的接口管理工具,需要php环境进行部署
  • showdoc完整部署包

    2019-04-11 09:16:27
    showdoc完整部署包,里面有最新的运行环境的软件,有最新的showdoc本地部署的最新代码包,还有完美的安装图文指导, 由于上传大小限制,我给出网盘连接: 链接:https://pan.baidu.com/s/1MXHuGA0bmCXGXztafk_XiA ...
  • showdoc安装包

    2018-02-13 09:17:15
    ShowDoc就是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 2,021
精华内容 808
关键字:

showdoc