ShowDoc

介绍ShowDoc的各种功能


更新日志

<h3>v3.2.5</h3> <ul> <li>修复了一些安全问题</li> </ul> <h3>v3.2.3</h3> <ul> <li>常规更新,修复一些已知的bug</li> </ul> <h3>版本v3.2.0 、 v3.2.1 和 v3.2.2</h3> <p>此版本主要是优化视觉UI和交互体验。</p> <ul> <li>文档目录数支持拖曳排序和右键菜单操作,可以快速添加页面以及子文件等</li> <li>优化移动端访问项目的效果</li> <li>更换了更好看的产品图标</li> <li>优化小屏设备的访问效果</li> <li>将大多有跟 页面 有关的操作移动到文档目录树底部操作栏</li> <li>其它小细节</li> </ul> <h3>版本v3.1.0</h3> <p>增加AI助手功能,辅助生成文档。showdoc官网默认开启,私有版showdoc则需要管理员在后台开启。</p> <h3>版本v3.0.0 、 v3.0.1 和 v3.0.3</h3> <p>重写了UI和交互逻辑,大大提升了视觉效果和操作体验,包括但不限于以下内容:</p> <ul> <li>展示多个项目时候采用列表结构,同时完善项目分组功能,适合更多项目的场景</li> <li>大部分打开新页面的操作,如用户中心、目录管理、团队管理等等,都改为当前页面弹窗的形式,方便关闭弹窗后无感回到之前的操作,避免割裂感。</li> <li>完善拖放组件,涉及到拖放的场景,比如项目分组的拖放、页面排序的拖放、目录管理的拖放,都统一元素高度和样式。</li> <li>调整项目展示页的布局,包括常规多页项目、单页项目和表格展示项目,增加统一的header和图标样式。</li> <li>调整功能按钮的展示与收起逻辑,在便捷和简洁间取得平衡。</li> <li>修复一些累积的bug</li> </ul> <h3>版本v2.10.10</h3> <ul> <li>修复累积的bug以及UI兼容问题</li> </ul> <h3>版本v2.10.8</h3> <ul> <li>紧急修复由v2.10.7引起的bug</li> </ul> <h3>版本v2.10.7</h3> <ul> <li>修复sh脚本自动生成runapi接口的问题</li> <li>修复从vscode粘贴代码的问题</li> <li>可以在showdoc上导出runapi项目(word格式)</li> <li>优化代码的结构</li> </ul> <h3>版本v2.10.6</h3> <ul> <li>项目展示页面可一键展开或者折叠全部目录</li> <li>优化导出markdown压缩包功能</li> <li>优化docker升级机制</li> <li>优化json转参数表格的功能</li> <li>优化附件下载功能</li> </ul> <h3>版本v2.10.5</h3> <ul> <li>修正文件导入时内存不足的bug</li> <li>在代码块中使用等宽字体</li> <li>解决火狐浏览器下复制粘贴的兼容问题</li> <li>团队成员也增加团队显示</li> <li>添加成员时候可快速选择之前的成员</li> </ul> <h3>版本v2.10.4</h3> <ul> <li>可以快速复制网页文章到showdoc,会自动转成markdown格式</li> <li>更改代码块样式</li> <li>代码块增加快速复制功能</li> <li>修复文件上传漏洞</li> <li>修复编辑器一些特殊字符转义的bug</li> <li>增加从SQL转成markdown表格的格式工具</li> <li>退出OAuth2登录时候允许设置回调</li> </ul> <h3>版本v2.10.3</h3> <ul> <li>优化openapi文件导入</li> <li>LDAP设置优化</li> <li>解决重复弹出消息的问题</li> <li>修复验证码机制的bug</li> <li>引用文本会默认渲染成直体</li> </ul> <h3>版本v2.10.2</h3> <ul> <li>添加团队成员时,可设置成员为团队管理员,从而实现多人管理团队</li> <li>添加项目成员时,可设置成员为项目管理员,从而实现多人管理项目</li> <li>新增模板共享功能。模板可共享给项目成员使用。</li> <li>注释脚本可生成runapi项目,可以在runapi客户端调试</li> <li>浏览器新消息提醒</li> </ul> <h3>版本v2.10.1</h3> <ul> <li>本版本为v2.10.0的修复版,专门修复v2.10.0不小心引入的bug</li> <li>版本v2.10.0存在bug,会导致无法复制目录以及手动安装showdoc时可能出问题</li> </ul> <h3>版本v2.10.0</h3> <ul> <li>安全更新</li> <li>增加页面修改提醒功能,可通知指定的项目成员</li> <li>增加项目变更记录功能</li> <li>可以导入文件(postman/swagger/markdown压缩包)到已存在的项目内,也可以重复导入以覆盖更新</li> <li>优化注释生成文档功能</li> <li>支持通过s3协议上传附件</li> </ul> <h3>版本v2.9.15</h3> <ul> <li>安全更新</li> <li>修复导入swagger文件的问题</li> <li>修复点击文件库错误的问题</li> <li>支持runapi客户端的错误返回示例</li> <li>支持runapi客户端的搜索功能</li> <li>支持runapi客户端的query和路径变量功能</li> </ul> <h3>版本v2.9.14</h3> <ul> <li>可一键设置团队的成员项目权限为只读</li> <li>选择目录时候可输入关键字搜索目录</li> <li>在编辑页面时候可跳转去新建目录</li> <li>完善页面排序功能</li> <li>修复xss安全漏洞</li> <li>解决TOC目录遮挡图标的问题</li> <li>支持runapi客户端的接口状态功能</li> <li>支持runapi客户端的全局cookies功能</li> <li>支持runapi客户端的全局脚本功能</li> </ul> <h3>2021年10月</h3> <ul> <li>安全更新</li> </ul> <h3>2021年9月</h3> <ul> <li>修复一个安全漏洞</li> <li>runapi客户端支持cookie</li> </ul> <h3>2021年8月</h3> <ul> <li>修复若干个安全漏洞。</li> <li>升级flowchart.js版本,支持绘制更多图表</li> <li>用户修改密码后,其他设备的登录token会失效</li> <li>全局搜索的时候可以搜索项目名字和文档内容</li> <li>修复编辑器若干bug</li> <li>表格项目的锁定逻辑修复</li> </ul> <h3>2021年6月</h3> <ul> <li>修复一个安全漏洞</li> <li>当有大版本发布时候,开源版showdoc可以在管理后台点击按钮来升级程序</li> </ul> <h3>2021年5月</h3> <ul> <li>开源版showdoc增加OAuth2.0登录和通用接入登录</li> <li>引入项目分组功能,以解决项目数比较多的场景</li> <li>优化代码块高亮UI</li> <li>优化posrtman/swagger文件导入逻辑</li> <li>附件支持拖动上传</li> <li>分享出去的单页支持全屏阅读模式</li> <li>与showdoc搭配使用的runapi客户端支持前后自定义脚本执行,可脚本控制环境变量和请求参数等</li> <li>runapi客户端支持断言和自动化流程测试</li> </ul> <h3>2021年4月</h3> <ul> <li>可在我的项目列表中根据内容进行全局搜索</li> <li>支持跨项目复制和移动目录以及目录下的文档</li> <li>mock功能前缀固定,后缀可以自定义url路径</li> <li>页面的历史版本可以编辑备注信息,方便自己备注版本差异</li> </ul> <h3>2021年3月</h3> <ul> <li>单页项目按钮优化</li> <li>优化编辑器布局</li> <li>编辑器&amp;符号转义</li> </ul> <h3>2021年1月</h3> <ul> <li>兼容php8环境</li> </ul> <h3>2020年12月</h3> <ul> <li>重设计首页UI</li> </ul> <h3>2020年11月</h3> <ul> <li>完善附件管理,统一到文件库功能</li> <li>增加mock数据功能</li> <li>runapi客户端增加全局参数和环境功能</li> </ul> <h3>2020年10月</h3> <ul> <li>新增对swagger3(openapi3)的格式导入支持</li> <li>导出的时候可以选择只导出一个单页</li> <li>runapi增加项目导出功能</li> <li>游客用户也可以看到公开页面的修改历史</li> <li>修复表格项目不支持一些特殊符号的问题</li> <li>修复项目左侧菜单栏初始打开时候默认展开的问题</li> </ul> <h3>2020年8月</h3> <ul> <li>一些安全更新</li> </ul> <h3>2020年7月</h3> <ul> <li>增加附件管理功能</li> <li>增加全屏阅读模式</li> <li>支持在线表格。用户新建项目的时候可以选择类型为表格,随后就可以当做轻量级的Excel表格来使用</li> <li>支持思维导图。在编辑器能找到插入思维导图的按钮,根据系统示例便可知道用法</li> </ul> <h3>2020年6月</h3> <ul> <li>推出可对接口进行开发调试、以及自动生成文档的工具客户端RunApi, 详情地址:<a href="https://www.showdoc.cc/runapi">https://www.showdoc.cc/runapi</a></li> <li>推出Mac客户端,下载链接:<a href="https://www.showdoc.cc/clients">https://www.showdoc.cc/clients</a> </li> <li>可以给成员只授权项目的某个目录,适合更精细化的权限控制。</li> <li>当用户编辑页面的时候将自动锁定,防止其他人修改覆盖</li> <li>当markdown的超链接指向本项目的时候,将在当前项目展开(之前是新窗口打开)</li> </ul> <h3>2020年5月</h3> <ul> <li>编辑器增加三个按钮,对应的功能分别是插入标题目录TOC、插入视频和图文居中</li> <li>开源版showdoc可在管理后台设置图片和附件上传到阿里云或七牛云</li> <li>让编辑器的预览效果和实际样式保持一致,同时优化markdown渲染样式</li> <li>新增团队转让功能</li> </ul> <h3>2020年4月</h3> <ul> <li>支持无限层级目录</li> </ul> <h3>2020年3月</h3> <ul> <li>支持导入postman和swagger。支持导入导出markdown压缩包。</li> </ul> <h3>2020年2月</h3> <ul> <li>推出windows版客户端</li> <li>优化手机app连接服务器的问题</li> <li>showdoc正式支持plantuml,&lt;a href=&quot;<a href="https://www.showdoc.cc/p/69d2f7ad6306f13363bb803e755068c7&quot">https://www.showdoc.cc/p/69d2f7ad6306f13363bb803e755068c7&quot</a>; target=&quot;_blank&quot;&gt;详情点此看文档&lt;/a&gt;</li> </ul> <h3>2020年1月</h3> <ul> <li>管理目录的时候可以通过拖动的方式对目录进行排序和转移</li> <li>编辑页面的时候可以通过拖动的方式对页面进行排序</li> </ul> <h3>2019年12月</h3> <ul> <li>增加回收站功能</li> <li>完善UI,重点优化了项目展示页面</li> </ul> <h3>2019年11月</h3> <ul> <li>推出移动app,支持IOS和Android</li> <li>用户可在管理后台自定义首页</li> <li>支持搜索关键字高亮</li> <li>优化异常输出,使错误信息更友好,以便错误的时候排查问题</li> </ul> <h3>2019年10月</h3> <p>重写接口测试工具的UI <a href="http://runapi.showdoc.cc">http://runapi.showdoc.cc</a></p> <h3>2019年9月</h3> <ul> <li>修复一个php文件上传漏洞</li> <li>优化docker安装镜像,初次启动docker镜像时将自动转移代码数据,不需要用户再执行命令</li> </ul> <h3>2019年8月</h3> <ul> <li>新增重置管理员密码脚本命令</li> <li>编辑时,格式工具处增加粘贴到表格功能。可以从excel或者网页复制表格然后粘贴成markdown格式表格</li> </ul> <h3>2019年6月</h3> <ul> <li>安全更新:为cookie新增httponly属性</li> </ul> <h3>2019年4月</h3> <ul> <li>项目列表页面支持拖动排序。同时废弃了之前的项目置顶功能。</li> <li>删除目录时会把其下的子目录和页面一并删除</li> <li>完善makdown的TOC导航样式</li> </ul> <h3>2019年3月</h3> <ul> <li>完善英文翻译和文档</li> </ul> <h3>2019年1月</h3> <ul> <li>增加附件上传功能</li> </ul> <h3>2018年12月</h3> <ul> <li>优化左侧栏样式</li> </ul> <h3>2018年11月</h3> <ul> <li>优化表格宽度</li> <li>新增用户姓名字段并在团队成员中显示</li> <li>修复一个安全问题,此问题可能导致文档数据被越权修改。</li> <li>开源版showdoc支持ldap登录 </li> <li>开源版showdoc支持在网站管理后台关闭公开注册</li> <li>增加快速复制分享链接的功能</li> <li>为了加强多人多团队情形下的项目协作,正式推出团队管理功能</li> </ul> <h3>2018年10月</h3> <ul> <li>为了应对复杂项目内容的分类需求,showdoc在原来目录支持的基础上增加一层子目录,支持到了三级目录。用户在新建目录的时候选择父层目录为二级目录即可。</li> </ul> <h3>2018年9月</h3> <ul> <li>官网showdoc.cc改写了URL转发规则,使分享出去的URL更友好。开源版不支持此功能。</li> <li>新增一键安装/升级脚本</li> </ul> <h3>2018年8月</h3> <ul> <li>可通过代码注释自动生成API文档。详情请点击任一个具体项目的项目设置页面-开放API</li> <li>页面查看的时候增加历史版本的入口</li> <li>增加对IE11和edge浏览器的兼容支持</li> <li>登录/注册页面,项目密码页面增加回车快捷键支持</li> <li>修改个人设置页面在某些浏览器下不能点击返回的bug</li> <li>修复编辑器在某些情况下预览为空白的bug</li> <li>修复粘贴上传图片时会重复上传的问题</li> <li>修复保存文档的快捷键(ctrl+s或command+s)</li> </ul> <h3>2018年7月</h3> <ul> <li>开源版showdoc新增管理后台功能,可以统一添加、删除用户,以及对全部项目的管理。</li> </ul> <h3>2018年4月</h3> <ul> <li>支持自动化生成数据字典文档</li> <li>修复一个sql注入安全漏洞</li> </ul> <h3>2018年3月</h3> <ul> <li>修复一个跳过验证码注册的bug</li> <li>修复bugs</li> </ul> <h3>2018年2月</h3> <ul> <li>使用vue + element框架重构了ShowDoc的前端页面,优化UI风格</li> <li>提高不同页面之间切换速度</li> <li>项目展示页面,左侧栏允许收缩</li> <li>优化目录的添加和管理</li> </ul> <h3>2017年11月</h3> <ul> <li>禁止上传的文件名后缀为php</li> <li>禁止空目录名的生成</li> <li>禁止删除非空的父目录</li> </ul> <h3>2017年10月</h3> <ul> <li>为了安全性,关闭编辑器对html代码的预览</li> </ul> <h3>2017年9月</h3> <ul> <li>项目展示页的左侧栏将采用固定布局,不会随着网页下拉而滚动,方便多目录浏览。</li> <li>项目展示页的新建按钮调整到目录上方,以方便点击。</li> <li>默认隐藏登录页面和项目密码访问页的验证码,减少用户输入时间。只有当输错密码大于一定次数时才会要求输入验证码。</li> <li>禁用server 目录缓存,以便在不同服务器之间迁移。迁移直接复制文件夹过去即可</li> <li>导出word文件的时候可以指定目录</li> <li>对话框优化</li> </ul> <h3>2017年8月</h3> <ul> <li>修复编辑器在部分可触屏屏幕下的bug</li> <li>修复json格式化工具会把number类型转为string的bug</li> </ul> <h3>2017年7月</h3> <ul> <li>编辑文档时支持直接插入html代码,并支持预览</li> <li>关闭页面缓存,使修改模板、配置时能立马生效</li> <li>优化首页展示方式</li> <li>新增项目归档功能</li> <li>项目主页可以置顶常用项目</li> <li>优化目录编辑页面</li> </ul> <h3>2017年6月</h3> <ul> <li>修复部分浏览器下“点击可放大查看图片”功能与浏览器插件不兼容的bug</li> </ul> <h3>2017年5月</h3> <ul> <li>图片可以粘贴上传</li> <li>点击可放大查看图片</li> <li>显示页面的最后编辑时间和编辑人</li> </ul> <h3>2017年4月</h3> <ul> <li>项目展示页的左侧栏优化:打开三级目录的页面时,父目录也会展开</li> <li>支持站内链接</li> </ul> <h3>2017年1月</h3> <ul> <li>重写项目设置,让交互更友好</li> <li>新增开放API,可以通过API来批量更新文档</li> </ul> <h3>2016年12月</h3> <ul> <li>www.showdoc.cc 启用更安全的https</li> <li>增加logo</li> <li>增加robots.txt</li> </ul> <h3>2016年11月</h3> <ul> <li>增加Docker部署方式</li> <li>创建单页项目功能</li> <li>复制项目功能</li> <li>支持单页面分享功能</li> </ul> <h3>2016年10月</h3> <ul> <li>支持生成TOC目录、科学公式、流程图和序列图</li> </ul> <h3>2016年9月</h3> <ul> <li>用户可以预览页面历史版本与最新版本的差异</li> <li>项目创建者可以添加只读成员</li> </ul> <h3>2016年8月</h3> <ul> <li>完善安装脚本 </li> <li>禁用html缓存、完善页面css样式</li> <li>完善安装脚本 </li> <li>推出v1.0.0正式版,并支持Composer方式安装</li> <li>放弃对Mysql的支持,全面使用Sqlite数据库</li> <li>新增Json格式化工具</li> <li>完善在线测试API的工具(RunApi)</li> </ul> <h3>2016年7月</h3> <ul> <li>优化首页,改用全屏单页插件</li> <li>新增自定义模板功能,允许用户将自己的页面设置为模板</li> <li>保存页面前可以添加注释。添加的页面注释会在页面的版本历史显示,方便查看页面修改记录</li> <li>单账户允许同时多处登录(原来只允许同一时间单机登录)</li> </ul> <h3>2016年6月</h3> <ul> <li>在配置文件可设置上传图片到七牛</li> <li>用户可设置个性域名</li> <li>在线ShowDoc域名由doc.star7th.com更改为www.showdoc.cc</li> <li>增加了多语言的支持</li> </ul> <h3>2016年5月</h3> <ul> <li>新增自助安装脚本</li> <li>新增ShowDoc使用交流qq群(群号:564671853)</li> <li>支持三级目录</li> <li>历史页面保存到数据库的时候采用压缩,以减少数据库体积 </li> <li>默认使用sqlite数据库</li> <li>单个页面的历史版本最多保留20个版本,以减少数据库体积</li> <li>把示例项目和帮助文档指向在线showdoc,以方便以后更新文档是只需要更新在线的即可。showdoc的每个副本也就没必要新建默认项目了</li> <li>修改URL模式为兼容模式,这样即使不再写apache或者nginx的重定向规则,showdoc也能正常访问</li> </ul> <h3>2016年4月</h3> <ul> <li>微调详情页的字体样式</li> <li>修复首页轮播动画</li> <li>增加了页面标题与地址栏链接变化</li> <li>优化数据库结构:</li> <li>增加页面title显示当前项目的名称,同时打开多个项目时方便定位页面</li> </ul> <h3>2016年3月</h3> <ul> <li>完善左侧栏UI</li> <li>增加对nginx下重定向规则说明</li> <li>修复一个自动登录的bug</li> </ul> <h3>2016年2月</h3> <ul> <li>优化了样式</li> <li>增加复制页面的功能</li> <li>web安全:增加SQL过滤防止注入</li> </ul> <h3>2016年1月</h3> <ul> <li>URL不区分大小写</li> <li>新增快捷键操作</li> </ul> <h3>2015年12月</h3> <ul> <li>增加对删除页面的权限细分控制</li> <li>新增图片上传功能</li> <li>增加文档搜索功能</li> <li>删除页面和目录前增加确认按钮以防误操作</li> </ul> <h3>2015年11月</h3> <ul> <li>ShowDoc诞生并开源</li> </ul>

页面列表

ITEM_HTML