mindoc-org
/
mindoc
mirror of https://github.com/mindoc-org/mindoc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

*

pull/83/merge
Minho 2017-06-14 09:41:23 +08:00
parent 51c60dc6c5
commit 7d41014bb7
1 changed files with 20 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -17,19 +17,23 @@ MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 lara
**如果你的服务器上没有安装golang程序请手动设置一个环境变量如下：键名为 ZONEINFO，值为MinDoc跟目录下的/lib/time/zoneinfo.zip 。** **如果你的服务器上没有安装golang程序请手动设置一个环境变量如下：键名为 ZONEINFO，值为MinDoc跟目录下的/lib/time/zoneinfo.zip 。**
更多信息请查看手册： [MinDoc 使用手册](https://github.com/lifei6671/godoc/wiki/MinDoc-%E4%BD%BF%E7%94%A8%E6%89%8B%E5%86%8C) 更多信息请查看手册： [MinDoc 使用手册](https://github.com/lifei6671/mindoc/wiki/MinDoc-%E4%BD%BF%E7%94%A8%E6%89%8B%E5%86%8C)
对于没有Golang使用经验的用户，可以从 [https://github.com/lifei6671/godoc/releases](https://github.com/lifei6671/godoc/releases) 这里下载编译完的程序。 对于没有Golang使用经验的用户，可以从 [https://github.com/lifei6671/mindoc/releases](https://github.com/lifei6671/mindoc/releases) 这里下载编译完的程序。
如果有Golang开发经验，建议通过编译安装。 如果有Golang开发经验，建议通过编译安装。
```bash ```bash
git clone https://github.com/lifei6671/godoc.git git clone https://github.com/lifei6671/mindoc.git
go get -d ./... glide update
go build -ldflags "-w" go build -ldflags "-w"
./mindoc install
./mindoc
``` ```
MinDoc 使用MySQL储存数据，且编码必须是`utf8mb4_general_ci`。请在安装前，把数据库配置填充到项目目录下的 conf/app.conf 中。 MinDoc 使用MySQL储存数据，且编码必须是`utf8mb4_general_ci`。请在安装前，把数据库配置填充到项目目录下的 conf/app.conf 中。
@ -46,7 +50,7 @@ MinDoc 使用MySQL储存数据，且编码必须是`utf8mb4_general_ci`。请在
```bash ```bash
#使程序后台运行 #使程序后台运行
nohup ./godoc & nohup ./mindoc &
``` ```
该命令会使程序后台执行，但是服务器重启后不会自动启动服务。 该命令会使程序后台执行，但是服务器重启后不会自动启动服务。
@ -66,7 +70,7 @@ ws.run "cmd /c start.bat",vbhide
#再建一个start.bat文件： #再建一个start.bat文件：
@echo off @echo off
godoc_windows_amd64.exe mindoc_windows_amd64.exe
``` ```
@ -123,46 +127,46 @@ HTTP_PORT 程序监听的端口号
举个栗子 举个栗子
```bash ```bash
docker run -p 8181:8181 -e MYSQL_PORT_3306_TCP_ADDR=127.0.0.1 -e MYSQL_PORT_3306_TCP_PORT=3306 -e MYSQL_INSTANCE_NAME=mindoc_db -e MYSQL_USERNAME=root -e MYSQL_PASSWORD=123456 -e httpport=8181 -d daocloud.io/lifei6671/godoc:latest docker run -p 8181:8181 -e MYSQL_PORT_3306_TCP_ADDR=127.0.0.1 -e MYSQL_PORT_3306_TCP_PORT=3306 -e MYSQL_INSTANCE_NAME=mindoc_db -e MYSQL_USERNAME=root -e MYSQL_PASSWORD=123456 -e httpport=8181 -d daocloud.io/lifei6671/mindoc:latest
``` ```
# 项目截图 # 项目截图
**创建项目** **创建项目**
![创建项目](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501204438.png) ![创建项目](https://raw.githubusercontent.com/lifei6671/mindoc/master/uploads/20170501204438.png)
**项目列表** **项目列表**
![项目列表](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501203542.png) ![项目列表](https://raw.githubusercontent.com/lifei6671/mindoc/master/uploads/20170501203542.png)
**项目概述** **项目概述**
![项目概述](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501203619.png) ![项目概述](https://raw.githubusercontent.com/lifei6671/mindoc/master/uploads/20170501203619.png)
**项目成员** **项目成员**
![项目成员](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501203637.png) ![项目成员](https://raw.githubusercontent.com/lifei6671/mindoc/master/uploads/20170501203637.png)
**项目设置** **项目设置**
![项目设置](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501203656.png) ![项目设置](https://raw.githubusercontent.com/lifei6671/mindoc/master/uploads/20170501203656.png)
**基于Editor.md开发的Markdown编辑器** **基于Editor.md开发的Markdown编辑器**
![基于Editor.md开发的Markdown编辑器](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501203854.png) ![基于Editor.md开发的Markdown编辑器](https://raw.githubusercontent.com/lifei6671/mindoc/master/uploads/20170501203854.png)
**基于wangEditor开发的富文本编辑器** **基于wangEditor开发的富文本编辑器**
![基于wangEditor开发的富文本编辑器](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501204651.png) ![基于wangEditor开发的富文本编辑器](https://raw.githubusercontent.com/lifei6671/mindoc/master/uploads/20170501204651.png)
**项目预览** **项目预览**
![项目预览](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501204609.png) ![项目预览](https://raw.githubusercontent.com/lifei6671/mindoc/master/uploads/20170501204609.png)
**超级管理员后台** **超级管理员后台**
![超级管理员后台](https://raw.githubusercontent.com/lifei6671/godoc/master/uploads/20170501204710.png) ![超级管理员后台](https://raw.githubusercontent.com/lifei6671/mindoc/master/uploads/20170501204710.png)
# 使用的技术 # 使用的技术