当前位置: 首页 > 后端技术 > PHP

showDoc文档管理系统,支持markdown

时间:2023-03-29 21:47:09 PHP

下载地址:https://github.com/star7th/sh...什么是ShowDoc每当接手别人开发的模块或项目,看代码没有注释时,我们都疯了。文件呢?!文件呢?!给我看医生!!程序员希望别人能写技术文档,自己却不想写文档。因为写一个文档需要花很多时间去处理格式化排版,思考各种非技术性的细节,比如新创建的word文档放在哪个目录下。需要文件基本靠喊,然后上QQ或者邮箱接收对方丢过来的文件。这种通信方式当然可行,但效率不高。ShowDoc是一款非常适合IT团队的在线文档共享工具,可以加快团队之间的沟通效率。可以用什么API文档http://www.showdoc.cc/demo?page_id=7随着移动互联网的发展,BaaS(BackendasaService)越来越流行。服务端提供API,APP或Web前端可以方便的调用数据。使用ShowDoc,您可以非常方便快捷地编写精美的API文档。数据字典http://www.showdoc.cc/data-dictionary?page_id=13一个好的数据字典可以方便的向别人解释你的数据库结构,比如每个字段的定义。文档http://www.showdoc.cc/help?page_id=14可以用showdoc写一些工具的使用手册,也可以写一些技术规范文档供团队参考。它有什么功能?分享导出响应式网页设计,您可以将项目文档分享到电脑或移动设备上进行查看。同时,项目还可以导出为word文件,供离线浏览。权限管理公共和私人项目ShowDoc上有两种类型的项目:公共项目和私人项目。公共项目可以被任何登录和未登录的用户访问,而私有项目需要输入密码来验证访问。密码由项目创建者设置。项目转移项目创建者可以自由地将项目转移给网站的其他用户。项目成员您可以轻松地为ShowDoc项目添加和删除项目成员。项目成员可以编辑项目,但不能转移或删除项目(只有项目创建者有权限)。编辑功能Markdown编辑ShowDoc使用markdown编辑器,无论是编辑还是阅读体验都非常出色。如果你不知道Markdown,请在搜索引擎中搜索“Markdown知识入门”。模板插入在ShowDoc的编辑页面,点击编辑器上方的按钮,即可轻松插入API接口模板和数据字典模板。插入模板后,剩下的就是更改数据,省去了很多编辑工作。历史版本ShowDoc为页面提供了历史版本功能,您可以轻松地将页面恢复到之前的版本。部署到自己的服务器ShowDoc部署手册,请参考:http://blog.star7th.com/2016/05/2007.html使用在线ShowDoc如果您没有自己的服务器,但又想使用ShowDoc作为文件共享工具,您可以使用在线ShowDochttp://www.showdoc.cchttp://www.showdoc.cc在线服务将长期维护,欢迎您随时托管您的文档资料。使用在线服务时,请记住showdoc唯一官网showdoc.cc