一、showdoc介绍1.1 showdoc简介Showdoc是一款在线文档工具,支持Markdown语法,可以用于快速记录、分享和协作文档。...三、检查本地环境3.1 检查本地操作系统版本检查本地操作系统版本[root@jeven ~]# cat /etc/redhat-release CentOS Linux release 7.6.1810...图片六、部署ShowDoc应用6.1 创建下载目录创建ShowDoc软件包的下载目录[root@jeven ~]# mkdir -p /data/showdoc[root@jeven ~]# cd /data.../showdoc/6.2 下载ShowDoc软件包下载ShowDoc软件包[root@jeven showdoc]# git clone https://github.com/star7th/showdoc.gitCloning...图片图片7.2 访问ShowDoc首页访问地址:http://192.168.3.166/web/#/进入ShowDoc首页图片八、ShowDoc的基本使用8.1 登录showdoc文档系统http:/
@TOC 一、showdoc介绍 1.1 showdoc简介 Showdoc是一款在线文档工具,支持Markdown语法,可以用于快速记录、分享和协作文档。...三、检查本地环境 3.1 检查本地操作系统版本 检查本地操作系统版本 [root@jeven ~]# cat /etc/redhat-release CentOS Linux release 7.6.1810...图片 六、部署ShowDoc应用 6.1 创建下载目录 创建ShowDoc软件包的下载目录 [root@jeven ~]# mkdir -p /data/showdoc [root@jeven ~]#...cd /data/showdoc/ 6.2 下载ShowDoc软件包 下载ShowDoc软件包 [root@jeven showdoc]# git clone https://github.com...图片 图片 7.2 访问ShowDoc首页 访问地址:http://192.168.3.166/web/#/ 进入ShowDoc首页 图片 八、ShowDoc的基本使用 8.1 登录showdoc文档系统
一、简介 ShowDoc是什么 每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !!...ip地址:192.168.31.150 下载镜像 docker pull star7th/showdoc 创建目录 mkdir -p /data/showdoc_data/html chmod -R... 777 /data/showdoc_data 启动showdoc容器 docker run -d --restart=always --name showdoc -p 4999:80 -v /data.../showdoc_data/html:/var/www/html/ star7th/showdoc 直接使用ip地址+4999就可以访问了,但是在公司里面,一般使用域名访问。...用户名:showdoc 密码:123456 ? 点击管理后台,修改密码 ? 本文参考链接: https://www.showdoc.cc/help?page_id=65610
p /showdoc_data/html chmod -R 777 /showdoc_data #启动showdoc容器 docker run -d --name showdoc --user=root...lang=zh #转移旧数据库 \cp -f /showdoc_data/html_bak/Sqlite/showdoc.db.php /showdoc_data/html/Sqlite/showdoc.db.php...接下来,假设你原来安装的旧showdoc已上传到服务器的 /tmp/showdoc 目录,那么 #转移旧数据库 \cp -r -f /tmp/showdoc/Sqlite/showdoc.db.php...比如执行下面命令压缩存放 zip -r /showdoc_data/showdoc_bak.zip /showdoc_data/html # 其中showdoc_bak.zip可以用日期后缀命名,以便多个备份...其他参考命令 docker stop showdoc # 停止容器 docker restart showdoc #重启showdoc容器 docker rm showdoc #删除showdoc
Showdoc一个非常适合IT团队的API文档、技术文档工具。...详情: https://github.com/star7th/showdoc/pull/1059
我用命令脚本上传后测试了下,同样的key和存储桶,但却是成功的,所以我也很郁闷,这到底是不是配置的方式不对。
官网地址:https://www.showdoc.com.cn/ 具备以下特点: 1、可以方便快速编写出美观的API文档 2、用ShowDoc可以编辑出美观的数据字典 3、可以团队协作编写项目文档...目前暂时只支持linux下mysql数据库 # 从官网下载脚本 wget https://www.showdoc.cc/script/showdoc_db.sh vi showdoc_db.sh #...如果是使用www.showdoc.cc ,则不需要再改此项。如果是部署开源版showdoc,请改此项为http://xx.com/server/index.php?...# 修改好脚本后,执行脚本,登录showdoc网站就可看到效果 sh showdoc_db.sh # 可在linux系统上添加定时任务,定时自动的同表结构 vim task.crontab # 在文件中写下如下内容...task.crontab 开启定时任务 定时任务使用上有问题,可以参考菜鸟教程的文章: https://www.runoob.com/linux/linux-comm-crontab.html 接下来给你们看下我配置的同步之前部署的
ShowDoc:https://www.showdoc.cc/
php-mbstring php-mysql php-pdo service httpd start chkconfig httpd on 安装完毕后,默认的Apache Web目录是/var/www/html,将ShowDoc...nginx start service php-fpm start chkconfig php-fpm on chkconfig nginx on 然后进入目录/var/www/html(不存在则新建),将ShowDoc...安装后便可通过浏览器访问127.0.0.1 https://www.showdoc.cc/help?page_id=14
ShowDoc作为一款卓越的开源文档管理工具,不仅提供强大的文档管理功能,还具备简单易用的协作和部署特性。我们的项目团队最初选择了ShowDoc作为文档管理工具,用以促进前后端协作。...在本文中,我们将深入探讨ShowDoc,并为您演示如何轻松部署和充分利用这一卓越工具。 ShowDoc简介 ShowDoc 是一款用于创建和管理文档的工具,旨在帮助团队更好地记录、分享和协作。...image: star7th/showdoc container_name: showdoc hostname: showdoc restart: always logging...它和showdoc( https://www.showdoc.com.cn/help )相辅相成:showdoc以文档为核心,侧重文档编写和知识资料沉淀。...同时它将自动生成文档到showdoc,无须再手动编写文档,释放生产力;共用showdoc的团队管理机制,很好地实现接口的自动化和多人协作。
@TOC一、ShowDoc介绍1.ShowDoc简介ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。...go1.18.6 Git commit: b40c2f6 Built: Thu Sep 8 23:14:08 2022 OS/Arch: linux...go1.18.6 Git commit: e42327a Built: Thu Sep 8 23:12:21 2022 OS/Arch: linux...showdoc]# chmod -R 777 /data/showdoc/[root@docker showdoc]# 3.运行ShowDoc容器[root@docker showdoc]# docker...初始化1.选择语言图片2.查看初始化结果图片七、登录署ShowDoc1.进入ShowDoc登录页图片2.登录ShowDoc首页图片八、ShowDoc的基本使用1.进入后台管理界面图片2.新建项目图片3.
,例如: www.showdoc.com.cn/程序员内点事 ?...目前客户端支持win、mac、linux平台和在线版 ,包含接口测试、自动流程测试、Mock数据、项目协作等功能。...单纯的Runapi和Postman相比优势并不大,而与showdoc配合使用效率比较显著,用runapi测试接口的同时它将自动生成API文档到showdoc,也可共用showdoc的团队管理机制实现多人协作...官方提供的脚本 https://www.showdoc.cc/script/showdoc_api.sh 修改showdoc_api.sh,替换我们api_key和api_token变量值,URL如果没搭建自己的文档服务不用改...生成数据字典 如果我们想直接从数据库字典表生成数据字典文档,showdoc也是支持的,先下载官方提供的脚本 wget https://www.showdoc.cc/script/showdoc_db.sh
[主页] 初识 ShowDoc ShowDoc新建项目可选常规的API文档、在线表格、或者单页文档(不支持目录分层),允许对项目文档设置访问密码,自定义域名,这里并不是真正意义上的“域名”,只是在文档服务域名后加了一级目录...目前客户端支持win、mac、linux平台和在线版 ,包含接口测试、自动流程测试、Mock数据、项目协作等功能。...单纯的Runapi和Postman相比优势并不大,而与showdoc配合使用效率比较显著,用runapi测试接口的同时它将自动生成API文档到showdoc,也可共用showdoc的团队管理机制实现多人协作...官方提供的脚本 https://www.showdoc.cc/script/showdoc_api.sh 修改showdoc_api.sh,替换我们api_key和api_token变量值,URL如果没搭建自己的文档服务不用改...://www.showdoc.cc/script/showdoc_db.sh 修改脚本里的配置,数据库、api_key、api_token等信息,直接执行后数据库表结构信息同步到showdoc。
apidoc 拥有以下特点: 跨平台,linux、windows、macOS 等都支持; 支持语言广泛,即使是不支持,也很方便扩展; 支持多个不同语言的多个项目生成一份文档; 输出模板可自定义; 根据文档生成...showdoc github地址:https://github.com/star7th/showdoc 开源协议:Apache Licence Star: 8.1k 开发语言:javascript、php...用户:超过10000+互联网团队正在使用 推荐指数:★★★★☆ 示例地址:https://www.showdoc.com.cn/demo?...ShowDoc采用markdown编辑器,点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。 ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。...支持文件导入,文件可以是postman的json文件、swagger的json文件、showdoc的markdown压缩包,系统会自动识别文件类型。
二、ShowDoc ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。你可以使用Showdoc来编写在线API文档、技术文档、数据字典、在线手册。...数据的目录 mkdir /showdoc_datamkdir /showdoc_data/htmlchmod 777 -R /showdoc_data 启动showdoc容器。.../showdoc 转移数据 docker exec showdoc \cp -fr /showdoc_data/html/ /var/www/ 设置权限 chmod 777 -R /showdoc_data...根据以上命令操作的话,往后showdoc的数据都会存放在 /showdoc_data/html 目录下。...关于showdoc其他操作,请参考链接: https://www.showdoc.cc/help?page_id=65610 是不是很Nice!那么问题来了,开发要测试这个接口怎么办?
apidoc 拥有以下特点: 跨平台,linux、windows、macOS 等都支持; 支持语言广泛,即使是不支持,也很方便扩展; 支持多个不同语言的多个项目生成一份文档; 输出模板可自定义; 根据文档生成...7 showdoc github地址:https://github.com/star7th/showdoc 开源协议:Apache Licence Star: 8.1k 开发语言:javascript、...php 用户:超过10000+互联网团队正在使用 推荐指数:★★★★☆ 示例地址:https://www.showdoc.com.cn/demo?...ShowDoc采用markdown编辑器,点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。 ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。...支持文件导入,文件可以是postman的json文件、swagger的json文件、showdoc的markdown压缩包,系统会自动识别文件类型。
今天,就和大家分享一个专门为程序员开发文档开源管理系统——ShowDoc。...目前,它已经在Github上标星超5300,1.3K个Fork,Github地址: https://github.com/star7th/showdoc 01 它可以用来做什么?...用ShowDoc可以非常方便快速地编写出美观的API文档。 数据字典 一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。...权限管理 ShowDoc上的项目有公开项目和私密项目两种。 公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。 项目转让、项目成员、团队管理等。...历史版本:ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。 如果不想安装,还可以在线使用ShowDoc。在线地址:https://www.showdoc.cc/
ShowDoc 是一个非常适合 IT 团队的在线 API 文档、技术文档工具。...主页:https://www.showdoc.cc/[4] GitHub:https://github.com/star7th/showdoc[5] 我们可以用 ShowDoc 来做 API 文档,数据字典...ShowDoc 支持权限管理,支持 markdown 编辑,支持导出,支持分享等功能。 API 文档 ? ? 数据字典 ?...github.com/YMFE/yapi [3] https://github.com/swagger-api: https://github.com/swagger-api [4] https://www.showdoc.cc.../: https://www.showdoc.cc/ [5] https://github.com/star7th/showdoc: https://github.com/star7th/showdoc
领取专属 10元无门槛券
手把手带您无忧上云