前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Github标星5300+,专门为程序员开发文档开源管理系统

Github标星5300+,专门为程序员开发文档开源管理系统

作者头像
加米谷大数据
发布2020-02-14 16:32:55
1.1K0
发布2020-02-14 16:32:55
举报
文章被收录于专栏:加米谷大数据加米谷大数据

今天,就和大家分享一个专门为程序员开发文档开源管理系统——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/

本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2020-01-13,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 加米谷大数据 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档