ShowDoc,一款深受IT团队喜爱的在线API文档和技术文档工具,近期迎来重要更新。此次更新重点增强了开放API能力,支持页面和目录的新增、修改、删除操作,为自动化流程提供了更多可能。同时,新增了对Mermaid绘图的支持,使得文档的可视化表现力更强。用户现在可以将项目导出为离线HTML文件,方便本地查阅。此外,项目管理员可配置评论和质量反馈功能,超级管理员则能管理登录超时和密码强度,并清理未使用附件。ShowDoc提供云托管和免费开源版本,以Markdown语法或程序注释自动生成文档,并支持RunApi客户端一边调试一边生成文档,极大提升了团队协作和文档编写效率,已被众多知名互联网团队广泛使用。
📝 **API功能增强与自动化支持**:ShowDoc此次更新大幅提升了其开放API的能力,新增了对页面和目录的新增、修改、删除接口的支持,这为实现更高级别的自动化文档管理和内容同步提供了坚实基础,使得IT团队能够更高效地维护和更新API文档。
📊 **可视化与离线阅读体验升级**:新版本集成了Mermaid绘图功能,允许用户在文档中直接创建和展示流程图、序列图等,极大地增强了技术文档的可读性和直观性。同时,支持将项目导出为离线HTML,确保用户在无网络环境下也能方便地访问和查阅文档。
🔒 **管理与安全配置优化**:ShowDoc为项目管理员和超级管理员提供了更精细化的控制选项。项目管理员可以根据需要启用或禁用评论和质量反馈功能,以优化协作流程。超级管理员则能够统一配置登录状态的超时时长,并设定注册密码的强度要求,进一步提升了系统的安全性和管理效率。此外,还新增了查找和清理未使用附件的功能,有助于保持数据整洁。
🚀 **高效协作与广泛应用**:ShowDoc作为一款集成了在线托管和免费开源版本的文档工具,支持Markdown语法,并能通过程序注释自动生成API文档,或结合RunApi客户端边调试边生成。这些特性极大地解放了生产力,降低了文档编写的门槛。其便捷的权限管理和团队协作功能,以及跨平台客户端支持,使其成为腾讯、华为、百度等众多互联网团队的首选,用户数量已超过10万。
地址
开源地址: https://github.com/star7th/showdoc
官网: https://www.showdoc.com.cn/
更新内容:
完善开放 api ,支持页面和目录的新增修改删除接口,以实现更多自动化能力支持 Mermaid 绘图可将项目导出成离线 html项目管理员可配置项目是否开启评论和质量反馈超级管理员可在管理后台配置登录态超时时间和注册密码强度超级管理员可在管理后台查找并清理未使用附件
如何操作
更新步骤请参考请参考手册的升级安装部分: https://www.showdoc.com.cn/help?page_id=13732
介绍
ShowDoc 是一个非常适合 IT 团队的在线 API 文档、技术文档工具,既有开箱即用的在线托管服务版,也有免费的开源版( github 1 万+ star )。通过 showdoc ,你可以方便地使用 markdown 语法来书写出美观的 API 文档、数据字典文档、技术文档、在线 excel 文档等等。如果不想编辑 markdown 文档,你还可以利用 showdoc 的自动化能力,从程序注释中自动生成 API 文档,或者从搭配的 RunApi 客户端(类似 postman 的 api 调试工具)中一边调试接口、一边自动生成文档。无需手动编写文档,释放生产力。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc 还支持多平台客户端,有 win 客户端、mac 客户端、ios 、android 等,更方便跨平台使用。目前超过 100000+的互联网团队正在使用 showdoc ,包括知名公司内部的一些团队,比如腾讯、华为、百度、京东、字节跳动等等。
关于 Showdoc 的详细介绍,请看: https://www.showdoc.com.cn/help