showDoc 文档管理系统 支持markdown

下载地址：https://github.com/star7th/sh...

ShowDoc是什么

每当接手一个他人开发好的模块或者项目，看着那些没有写注释的代码，咱们都无比抓狂。文档呢？！文档呢？！Show me the doc ！！

程序员都很但愿别人能写技术文档，而本身却很不但愿要写文档。由于写文档须要花大量的时间去处理格式排版，想着新建的word文档放在哪一个目录等各类非技术细节。

word文档零零散散地放在团队不一样人那里，须要文档的人基本靠吼，吼一声而后上qq或者邮箱接收对方丢过来的文档。这种沟通方式固然能够，只是效率不高。

ShowDoc就是一个很是适合IT团队的在线文档分享工具，它能够加快团队之间沟通的效率。

它能够用来作什么

API文档 http://www.showdoc.cc/demo?page_id=7

随着移动互联网的发展，BaaS（后端即服务）愈来愈流行。服务端提供API，APP端或者网页前端即可方便调用数据。用ShowDoc能够很是方便快速地编写出美观的API文档。

数据字典 http://www.showdoc.cc/data-dictionary?page_id=13

一份好的数据字典能够很方便地向别人说明你的数据库结构，如各个字段的释义等。

说明文档 http://www.showdoc.cc/help?page_id=14

你彻底可使用showdoc来编写一些工具的说明书,也能够编写一些技术规范说明文档以供团队查阅。
它都有些什么功能

分享与导出
    响应式网页设计，可将项目文档分享到电脑或移动设备查看。同时也能够将项目导出成word文件，以便离线浏览。

权限管理

    公开项目与私密项目

    ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登陆与非登陆的用户访问，而私密项目则须要输入密码验证访问。密码由项目建立者设置。

    项目转让

    项目建立者能够自由地把项目转让给网站的其余用户。

    项目成员

    你能够很方便地为ShowDoc的项目添加、删除项目成员。项目成员能够对项目进行编辑，但不可转让或删除项目（只有项目建立者才有权限）

编辑功能

    markdown编辑

    ShowDoc采用markdown编辑器，不管是编辑仍是阅读体验都极佳很棒。若是你不了解Markdown，请在搜索引擎搜索”认识与入门 Markdown”

    模板插入

    在ShowDoc的编辑页面，点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后，剩下的就是改动数据了，省去了不少编辑的力气。

    历史版本

    ShowDoc为页面提供历史版本功能，你能够方便地把页面恢复到以前的版本。
    
    部署到本身的服务器

ShowDoc部署手册

请参考：http://blog.star7th.com/2016/05/2007.html

使用在线的ShowDoc

若是你没有本身的服务器，但又想使用ShowDoc做为分档分享工具，你可使用在线的ShowDoc http://www.showdoc.cc

http://www.showdoc.cc 做为在线服务会长期维护，请放心托管你的文档数据。使用在线服务时请记住showdoc惟一官方网址showdoc.cc