一、showdoc系统介绍
1.1 showdoc简介
Showdoc是一款在线文档工具;支持Markdown语法;可以用于快速记录、分享和协作文档。它拥有简洁的界面和丰富的功能;包括在线编辑、多人协作、讨论评论、版本管理、权限管理等特性。
1.2 showdoc功能
分享与导出：响应式网页设计;可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件;以便离线浏览。
权限管理：公开项目与私密项目、项目转让、项目成员、团队管理。
编辑功能：markdown编辑、模板插入、历史版本。
多平台：showdoc支持网页版、手机app版和电脑客户端版。
自动化：可从代码注释中自动生成文档、搭配的RunApi
客户端：可调试接口和自动生成文档。
快速部署：可使用使用开源版本showdoc;快速在本地服务器部署showdoc。
二、本地环境介绍
2.1本地环境规划
本系统搭建安装在虚拟测试环境;服务器操作系统版本为centos7.9。
Hostname | ip地址 | 操作系统版本 | 内核版本 | 虚拟机所在服务器地址 |
Localhost | 192.168.5.201 | CentOS 7.9 | 3.10.0-1160.71.1.el7.x86_64 | 192.168.5.10 |
三、检查本地环境
3.1检查本地操作系统版本
3.2检查系统内核版本
四、安装httpd服务
4.1安装httpd
使用使用yum安装httpd
[root@localhost ~]# yum install httpd
4.2启动httpd服务
启动httpd服务并使开机自启
[root@localhost ~]# systemctl enable --now httpd
检查httpd服务状态
[root@localhost ~]# systemctl status httpd
4.3 设置防火墙和selinux
防火墙设置;关闭防火墙。
[root@localhost ~]# systemctl stop firewalld
[root@localhost ~]# systemctl disable firewalld
关闭selinux
[root@localhost ~]# setenforce 0
[root@localhost ~]# sed -i "s/SELINUX=enforcing/SELINUX=disabled/g" /etc/selinux/config
[root@localhost ~]# getenforce
4.4 测试httpd服务
在本地浏览器访问http://192.168.5.201/。
网站内容可以正常打开;表示httpd服务是正常的。
五、安装php服务
5.1 安装php工具
使用yum安装php及其相关模块。弹出确认界面，输入y即可。
[root@localhost ~]# yum install php php-mbstring php-gd php-pdo
5.2 编辑info.php测试文件
5.3 重启hhtpd服务
重启hhtpd服务：
[root@localhost html]# systemctl restart httpd
5.4 查看php安装状态
在浏览器http://192.168.5.201/info.php 出现以下页面表示php安装正常。
六、部署ShowDoc应用
6.1下载ShowDoc软件包
下载ShowDoc软件包
[root@localhost html]# git clone https://github.com/star7th/showdoc.git
6.2目录权限设置
将网站根目录/var/www/html的所属用户改为apache
[root@localhost www]# chown -R apache.apache html/
6.3重启httpd服务
重启httpd服务
[root@localhost html]# systemctl restart httpd
七、showdoc的初始化设置
7.1 设置系统中文语言
访问http://192.168.5.201/showdoc/install/index.php;进入showdoc的初始配置页面;选择系统中文语言。
7.2 访问ShowDoc首页
访问地址http://192.168.5.201/showdoc/web/#/进入ShowDoc首页
八、ShowDoc的基本使用
8.1 登录showdoc文档系统
http://192.168.5.201/showdoc/web/#/user/login，默认账号密码showdoc/123456
8.2 查看示例文档效果
打开首页的API等示例文档;可以看到展现效果;可以自己单独创建项目;管理各种文档;非常方便。
8.3 创建新项目
创建一个新项目;填写项目信息。
8.4 添加文档
添加文档。编辑文本内容。
输入文档标题、内容，输入完成点击保存文档内容。
8.5 分享文档
选择分享文档;复制文档链接。
8.6 查看分享文档
打开分享文档链接;查看分享文档内容。
九、showdoc的后台管理
9.1 登录后台管理
访问地址：http://192.168.5.201/showdoc/web/#/admin/index
也可以在前端登陆管理员账号（http://192.168.5.201/showdoc/web/#/user/login）后点击以下图示所示按钮
9.2 用户管理
用户管理页面;新增用户;填写用户信息。
创建后设置普通成员查看编辑管理员所建项目权限：前端首页---选择项目---选项选择添加成员，选择成员名称即可
9.3 项目管理
在项目管理页面;可以查看所有的项目。
9.4 附件管理
可以对文档中的附件进行管理。
9.5 站点设置
可以对本地站点进行基本设置。
