showdoc mysql版_ShowDoc上手

ShowDoc是什么

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

程序员都很希望别人能写技术文档，而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版，想着新建的word文档放在哪个目录等各种非技术细节。

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

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

它可以用来做什么

API文档( 查看Demo)

随着移动互联网的发展，BaaS(后端即服务)越来越流行。服务端提供API，APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。

数据字典( 查看Demo)

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

说明文档

你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅

它都有些什么功能

分享与导出

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

权限管理

公开项目与私密项目

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

项目转让

项目创建者可以自由地把项目转让给网站的其他用户。

项目成员

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

编辑功能

markdown编辑

ShowDoc采用markdown编辑器，无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown，请在搜索引擎搜索"认识与入门 Markdown"

模板插入

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

历史版本

ShowDoc为页面提供历史版本功能，你可以方便地把页面恢复到之前的版本。

部署到自己的服务器

导入数据库

下载代码后，将根目录的showdoc.sql文件导入mysql数据库

修改配置文件

进入Application/Common/Conf/目录，编辑config.php文件，填写相应的数据库信息

目录权限

请确保Application/Runtime 和Public/Uploads 有可写权限

使用在线的ShowDoc

如果你没有自己的服务器，但又想使用ShowDoc作为分档分享工具，你可以使用在线的ShowDoc http://doc.star7th.com

版权

ShowDoc遵循Apache2开源协议发布，并提供免费使用

【Python五篇慢慢弹】快速上手学python

快速上手学python 作者:白宁超 2016年10月4日19:59:39 摘要:python语言俨然不算新技术,七八年前甚至更早已有很多人研习,只是没有现在流行罢了.之所以当下如此盛行,我想肯定是多 ...

Impress.js上手 - 抛开PPT、制作Web 3D幻灯片放映

前言: 如果你已经厌倦了使用PPT设置路径.设置时间.设置动画方式来制作动画特效.那么Impress.js将是你一个非常好的选择. 用它制作的PPT将更加直观.效果也是嗷嗷美观的. 当然,如果用它来装 ...

ECharts数据图表系统？ 5分钟上手！

目录: 前言 简介 方法一:模块化单文件引入(推荐) 方法二:标签式单文件引入 [前言] 最近在捣鼓各种插件各种框架,发现这个ECharts还是比较不错的,文档也挺全的,还是中文的,给大家推荐一下. ...

快速上手Unity原生Json库

现在新版的Unity(印象中是从5.3开始)已经提供了原生的Json库,以前一直使用LitJson,研究了一下Unity用的JsonUtility工具类的使用,发现使用还挺方便的,所以打算把项目中的J ...

Masonry介绍与使用实践：快速上手Autolayout

1 MagicNumber -> autoresizingMask -> autolayout 以上是纯手写代码所经历的关于页面布局的三个时期 在iphone1-iphone3gs时代 w ...

[译]：Xamarin.Android开发入门——Hello,Android Multiscreen快速上手

原文链接:Hello, Android Multiscreen Quickstart. 译文链接:Hello,Android Multiscreen快速上手 本部分介绍利用Xamarin.Androi ...

[译]：Xamarin.Android开发入门——Hello,Android快速上手

返回索引目录 原文链接:Hello, Android_Quickstart. 译文链接:Xamarin.Android开发入门--Hello,Android快速上手 本部分介绍利用Xamarin开发A ...

快速上手seajs——简单易用Seajs

快速上手seajs——简单易用Seajs   原文  http://www.cnblogs.com/xjchenhao/p/4021775.html 主题 SeaJS 简易手册 http://yslo ...

Git版本控制Windows版快速上手

说到版本控制,之前用过VSS,SVN,Git接触不久,感觉用着还行.写篇博文给大家分享一下使用Git的小经验,让大家对Git快速上手. 说白了Git就是一个控制版本的工具,其实没想象中的那么复杂,咱在 ...

随机推荐

requesting java ast from selection

遇到這個錯誤是因為在eclipse中選擇了maven->update project.接著就不斷的出現題目上的錯誤,然後就提示是否退出workbench. 查看了一下項目的compile jre ...

Codeforces Round #327 (Div. 2) E. Three States

题目链接: 题目 E. Three States time limit per test:5 seconds memory limit per test:512 megabytes 问题描述 The ...

DataSet离线数据集实例

using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.W ...

JSP基础——关于中文乱码问题

乱码问题十分烦人,今天在写一个登陆的demo时,表单中需要提交的中文姓名,如下代码