明天,就和大家分享一个专门为顺序员开发文档开源管理系统——ShowDoc。
目前,它曾经在Github上标星超5300,1.3K个Fork(Github地址:https://github.com/star7th/showdoc)
它可以用来做什么?API文档( 查看Demo)
随着移动互联网的开展,BaaS(后端即效劳)越来越盛行。效劳端提供API,APP端或许网页前端便可方便调用数据。用ShowDoc可以十分方便快速地编写出美观的API文档。
数据字典( 查看Demo)
一份好的数据字典可以很方便地向别人阐明你的数据库结构,如各个字段的释义等。
阐明文档 ( 查看Demo)
你完全可以运用showdoc来编写一些工具的阐明书,也可以编写一些技术标准阐明文档以供团队查阅
它都有些什么功用?分享与导出
照应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件,以便离线阅读。
权限管理
地下项目与私密项目:ShowDoc上的项目有地下项目和私密项目两种。地下项目可供任何登录与非登录的用户拜访,而私密项目则需求输入密码验证拜访。密码由项目创立者设置。
项目转让:项目创立者可以自在地把项目转让给网站的其他用户。
项目成员:你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目停止编辑,但不可转让或删除项目(只要项目创立者才有权限)
团队管理:应用showdoc的团队功用你可以更好地停止团队协作
编辑功用
markdown编辑:ShowDoc采用markdown编辑器,无论是编辑还是阅读体验都极佳很棒。假设你不了解Markdown,请在搜索引擎搜索”看法与入门 Markdown”
模板插入:在ShowDoc的编辑页面,点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后,剩下的就是改动数据了,省去了很多编辑的力气。
历史版本:ShowDoc为页面提供历史版本功用,你可以方便地把页面恢复到之前的版本。
假设你不想安装,你还可以在线运用ShowDoc。在线地址:https://www.showdoc.cc/
创立项目也很复杂,你只需求按照步骤一步步创立就可以了:
假设你也对这个项目感兴味,可以下载上去尝试一下。
【编辑引荐】
Linus Torvalds 礼貌的批判一位开发者的博文
天下苦Vim久矣!硬核顺序员教你如何花式参加Vim,一周播种2400星
一个退休顺序员,用高中几何办法,让百年数学难题逼近实际极限
20年前偷懒修复的千年虫bug归来 顺序员:该来的总会来
Mac上顺序员很喜欢用10大开发软件
(责任编辑:admin)