今天,就和大家分享一个专门为程序员开发文档开源管理系统——ShowDoc。
目前,它已经在Github上标星超5300,1.3K个Fork,Github地址:
https://github.com/star7th/showdoc
01 | 它可以用来做什么? |
---|
API文档
服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。
数据字典
一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。
说明文档
可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。
02 | 它都有些什么功能? |
---|
分享与导出
响应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件,以便离线浏览。
权限管理
ShowDoc上的项目有公开项目和私密项目两种。
公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。
项目转让、项目成员、团队管理等。
编辑功能
采用markdown编辑器。
模板插入:在编辑页面,点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。
历史版本:ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。
如果不想安装,还可以在线使用ShowDoc。在线地址:https://www.showdoc.cc/