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

Stella981
• 阅读 580

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

码农那点事儿

关注我们,一起学习进步

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

开源最前线    猿妹综合整理

每当接手一个他人开发好的模块或者项目,看着那些没写注释的代码,是不是很抓狂?

每次写文档都要花大量的时间处理格式排版等非技术问题,是不是崩溃?

有时候一份文档,不止是一个人编写,几种不同风格掺杂在一起,阅读起来吃不吃力?

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

今天,就和大家分享一个专门为程序员开发文档开源管理系统——ShowDoc。

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

目前,它已经在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/

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

创建项目也很简单,你只需要按照步骤一步步创建就可以了:

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

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

如果你也对这个项目感兴趣,可以下载下来尝试一下。

     End
      
  
     
     
     
     
 
    
    
    
    

   
   
   
    

   
   
   
     
 
    
    
    
      
  
     
     
     
       
   
      
      
      
        
    
       
       
        
         
          
           
           推荐阅读 ↓↓↓ 
           
          
          
          ☞干货 | 绿色破解资源站分享  
          ☞讲讲Python爬虫绕过登录的小技巧 
          ☞这个月薪过万的岗位,为什么招不到人? 
          ☞爆红GitHub!有人打算用这个项目100天拿下Python 
          
         
       
        
    
       
       
        
         
       
        
    
       
       
        
        【小编微信】 
        扫一扫微信二维码...发1元红包...需要的源码,私信我哦! 
       
        
    
       
       
        
         
          
           
            
           
          
         
       
        
    
       
       
       
        
    
       
       
       ● 后台回复【网页特效】,免费获取网页制作特效源码!  
        
    
       
       
       ● 后台回复【源码】,免费获取源代码!  
        
    
       
       
       
        
    
       
       
        
         
          
           
           
          
         
       
        
    
       
       
       
        
    
       
       
       
        
    
       
       
       
        
    
       
       
       商务合作请加微信:31690503
       
   
      
      
      
      
  
     
     
     
     
 
    
    
    
    

   
   
   
    

   
   
   
     
 
    
    
    
     
 
    
    
    
      
  
     
     
     
       
   
      
      
      
       
       
       
    
        点「在看」的人都变好看
       
   
      
      
      
      
  
     
     
     
     
 
    
    
    
    

   
   
   

本文分享自微信公众号 - 码农那点事儿(code_ndsh_2018)。
如有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。

点赞
收藏
评论区
推荐文章
blmius blmius
2年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
Jacquelyn38 Jacquelyn38
2年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
Stella981 Stella981
2年前
Android So动态加载 优雅实现与原理分析
背景:漫品Android客户端集成适配转换功能(基于目标识别(So库35M)和人脸识别库(5M)),导致apk体积50M左右,为优化客户端体验,决定实现So文件动态加载.!(https://oscimg.oschina.net/oscnet/00d1ff90e4b34869664fef59e3ec3fdd20b.png)点击上方“蓝字”关注我
Wesley13 Wesley13
2年前
mysql设置时区
mysql设置时区mysql\_query("SETtime\_zone'8:00'")ordie('时区设置失败,请联系管理员!');中国在东8区所以加8方法二:selectcount(user\_id)asdevice,CONVERT\_TZ(FROM\_UNIXTIME(reg\_time),'08:00','0
Wesley13 Wesley13
2年前
00:Java简单了解
浅谈Java之概述Java是SUN(StanfordUniversityNetwork),斯坦福大学网络公司)1995年推出的一门高级编程语言。Java是一种面向Internet的编程语言。随着Java技术在web方面的不断成熟,已经成为Web应用程序的首选开发语言。Java是简单易学,完全面向对象,安全可靠,与平台无关的编程语言。
Stella981 Stella981
2年前
Docker 部署SpringBoot项目不香吗?
  公众号改版后文章乱序推荐,希望你可以点击上方“Java进阶架构师”,点击右上角,将我们设为★“星标”!这样才不会错过每日进阶架构文章呀。  !(http://dingyue.ws.126.net/2020/0920/b00fbfc7j00qgy5xy002kd200qo00hsg00it00cj.jpg)  2
Stella981 Stella981
2年前
Django中Admin中的一些参数配置
设置在列表中显示的字段,id为django模型默认的主键list_display('id','name','sex','profession','email','qq','phone','status','create_time')设置在列表可编辑字段list_editable
Wesley13 Wesley13
2年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
Python进阶者 Python进阶者
3个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这