当前位置: 首页 > 软件库 > 企业应用 > 文档管理 >

ShowDoc

在线文档分享工具
授权协议 Apache
开发语言 PHP
所属分类 企业应用、 文档管理
软件类型 开源软件
地区 国产
投 递 者 汪翰墨
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

ShowDoc 是一个非常适合 IT 团队的在线文档分享工具,它可以加快团队之间沟通的效率。通过 showdoc,你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档,你还可以利用showdoc的自动化能力,从程序注释中自动生成API文档,或者从搭配的RunApi客户端(类似postman的api调试工具)中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端,有win客户端、mac客户端、ios、android等,更方便跨平台使用。

目前超过100000+的互联网团队正在使用showdoc,包括知名公司内部的一些团队,比如腾讯、华为、百度、京东、字节跳动等等。

它可以用来做什么

  • API文档( 查看Demo

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

  • 数据字典( 查看Demo

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

  • 说明文档(查看Demo )

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

它都有些什么功能

  • 分享与导出

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

    • 公开项目与私密项目

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

    • 项目转让

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

    • 项目成员

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

  • 编辑功能

    • markdown编辑

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

    • 模板插入

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

    • 历史版本

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

  • ShowDoc介绍 ShowDoc就是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率。 API文档( 查看Demo) 随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。 数据字典( 查看Demo) 一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个

  • ShowDoc提供免费开源的版本,你可以选择将ShowDoc部署到你的服务器。 ShowDoc的安装 使用自动脚本安装: #下载脚本并赋予权限 wget https://www.showdoc.cc/script/showdoc;chmod +x showdoc; #默认安装中文版。如果想安装英文版,请加上en参数,如 ./showdoc en ./showdoc 你可以打开 http://x

  • ShowDoc 官网 https://www.showdoc.cc/ GitHub https://github.com/star7th/showdoc 帮助说明 https://www.showdoc.cc/help?page_id=1385767280275683 ShowDoc 是什么? 每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Sh

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

  • 安装showdoc 1. 自动脚本安装 下载脚本并赋予权限 wget https://www.showdoc.com.cn/script/showdoc;chmod +x showdoc; 默认安装中文版。如果想安装英文版,请加上en参数,如 ./showdoc en 自动安装 ./showdoc 2. 安装依赖Docker Engine 2.1 卸载旧版本 sudo apt-get remove

  • 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环

  •  https://www.showdoc.com.cn/help/65610 #官网地址 Docker方式安装 基础安装 安装前请确保你的环境已经装好了docker服务 。docker的安装教程在网上比较多,可以搜索了解下。这里重点介绍showdoc. # 原版官方镜像安装命令(中国大陆用户不建议直接使用原版镜像,可以用后面的加速镜像) docker pull star7th/showdoc

  • 安装第三方yum源 wget http://www.atomicorp.com/installers/atomic sh ./atomic PHP安装及插件 yum install php php-gd php-fpm php-mcrypt php-mbstring php-mysql php-pdo -y 编辑配置文件 修改cgi.fix_pathinfo vim /usr/local/ph

  • 1.0showDoc项目网站 http://www.escook.cn:8088/ 1.1配置跨域 运行如下的命令,安装 cors 中间件: npm i cors@2.8.5 2.在 app.js 中导入并配置 cors 中间件: // 导入 cors 中间件 const cors = require('cors') // 将 cors 注册为全局中间件 app.use(cors()) 1.2

 相关资料
  • 你可以将你的文档以链接的形式分享给你的好友,他们可以浏览你的文档,也可以保存到自己的幕布中。 分享 在文档内点击右上角「┊」按钮,选择「分享文档」。 复制链接发送给你的好友,或者分享到微信好友、朋友圈、QQ等。 分享支持加密、开启打赏。 注:关闭或开启分享操作不会影响文档的分享地址,即链接地址不会变。如有需要可点击「换一换」重新生成,则原链接失效。 保存 打开好友分享的链接之后,可以这样点击右上角

  • 你可以将你的文档以链接的形式分享给你的好友,他们可以浏览你的文档,也可以保存到自己的幕布中。 分享 点击右上角分享按钮,选择开启分享。 复制链接或将二维码发送给你的好友, 对方即可访问这篇文档。 同时你也可以给分享的文档加密,对方需要密码才能查看。点击「复制」按钮可以很方便地将链接和密码分享给好友,复制到剪切板的内容为:「文档链接:https://mubu.com/doc/9O4bGcQZs 密码

  • 发送协作邀请 发送协作卡片链接到会话,轻松邀请相关负责人参与文档编辑。 在线协同编辑 支持多人同时编辑一份文档,实现内容自动云端保存,无需另存多版本。 查看最新改动 支持文档历史版本与协作记录便捷查看,让所有编辑过程一目了然。

  • FAQs in section [2]: [2.1] 访问这份文档最近的镜像在那儿? [2.2] 如何得到 C++ FAQ Lite 的所有HTML文档的拷贝以便我离线阅读? [2.3] 如何得到 C++ FAQ Lite 的所有纯文本文档的拷贝以便我离线阅读? [2.4] 为什么通过email下载?而不是通过ftp? [2.5] 何处可以下载到该在线文档的繁体中文版? [2.6] 何处可以下载到

  • 超图在线GIS平台SuperMap Online,助力GIS数据上云。您可以使用丰富、专业的GIS分析工具和更直观的空间展示,体验云端大数据分析。

  • 本文向大家介绍java文件读写工具类分享,包括了java文件读写工具类分享的使用技巧和注意事项,需要的朋友参考一下 本文实例为大家分享了java文件读写工具类的具体代码,供大家参考,具体内容如下 以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持呐喊教程。