From cf3d13330516f8d005ac5826cb9ac83c40a5c4c4 Mon Sep 17 00:00:00 2001 From: Minho Date: Thu, 1 Jun 2017 14:39:09 +0800 Subject: [PATCH] Updated Home (markdown) --- Home.md | 1 - MinDoc-简介.md | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 87 insertions(+), 1 deletion(-) delete mode 100644 Home.md create mode 100644 MinDoc-简介.md diff --git a/Home.md b/Home.md deleted file mode 100644 index 13ffa1c..0000000 --- a/Home.md +++ /dev/null @@ -1 +0,0 @@ -Welcome to the godoc wiki! diff --git a/MinDoc-简介.md b/MinDoc-简介.md new file mode 100644 index 0000000..8882941 --- /dev/null +++ b/MinDoc-简介.md @@ -0,0 +1,87 @@ +MinDoc 是一款针对IT团队开发的简单好用的文档管理系统。 + +MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂,所以改用 Golang 开发。可以方便用户部署和实用。 + +开发缘起是公司IT部门需要一款简单实用的项目接口文档管理和分享的系统。其功能和界面源于 kancloud 。 + +可以用来储存日常接口文档,数据库字典,手册说明等文档。内置项目管理,用户管理,权限管理等功能,能够满足大部分中小团队的文档管理需求。 + +演示站点: [http://doc.iminho.me](http://doc.iminho.me) + +### 项目截图 + +**创建项目** + +![创建项目](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501204438.png) + +**项目列表** + +![项目列表](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501203542.png) + +**项目概述** + +![项目概述](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501203619.png) + +**项目成员** + +![项目成员](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501203637.png) + +**项目设置** + +![项目设置](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501203656.png) + +**基于Editor.md开发的Markdown编辑器** + +![基于Editor.md开发的Markdown编辑器](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501203854.png) + +**基于wangEditor开发的富文本编辑器** + +![基于wangEditor开发的富文本编辑器](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501204651.png) + +**项目预览** + +![项目预览](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501204609.png) + +**超级管理员后台** + +![超级管理员后台](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501204710.png) + + +### 使用的技术 + +- beego 1.8.1 +- mysql 5.6 +- editor.md +- bootstrap 3.2 +- jquery 库 +- layer 弹出层框架 +- webuploader 文件上传框架 +- Nprogress 库 +- jstree 树状结构库 +- font awesome 字体库 +- cropper 图片剪裁库 +- layer 弹出层框架 +- highlight 代码高亮库 +- to-markdown HTML转Markdown库 +- wangEditor 富文本编辑器 + + +### 主要功能 + +- 项目管理,可以对项目进行编辑更改,成员添加等。 +- 文档管理,添加和删除文档等。 +- 评论管理,可以管理文档评论和自己发布的评论。 +- 用户管理,添加和禁用用户,个人资料更改等。 +- 用户权限管理 , 实现用户角色的变更。 +- 项目加密,可以设置项目公开状态,私有项目需要通过Token访问。 +- 站点配置,可开启匿名访问、验证码等。 + +### 参与开发 + +我们欢迎您在 MinDoc 项目的 GitHub 上报告 issue 或者 pull request。 + +如果您还不熟悉GitHub的Fork and Pull开发模式,您可以阅读GitHub的文档(https://help.github.com/articles/using-pull-requests) 获得更多的信息。 + +### 关于作者 + +一个不纯粹的PHPer,一个不自由的 gopher 。 \ No newline at end of file