Github 标星 6100+！专门为程序员开发文档开源管理系统，我粉了。

杰哥的IT之旅 2022-06-07

来源：开源最前线（ID：OpenSourceTop）

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

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

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

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

目前，它已经在Github上标星超 6100+，1.4K个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/

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

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

扫描下方二维码，添加杰哥微信，备注：地区/城市-职业方向/学校-昵称，即可加入杰哥的IT之旅读者群，群内仅供学习交流、日常互动、资源分享、经验分享等，一定要记得备注，我会尽快通过好友验证的。

👆长按识别，添加微信

（添加人数较多，请耐心等待）

本公众号全部博文已整理成一个目录，请在公众号后台回复「m」获取！

好文和朋友一起看！