MinDoc 是ぜ一いち款针对IT团队开发的てき简单好このみ用よう的てき文ぶん档管理系りけい统。

MinDoc 的てき前身ぜんしん是ぜ SmartWiki 文ぶん档系统。SmartWiki 是ぜ基もと于 PHP 框かまち架か laravel 开发的てき一款文档管理系统。因よし PHP 的てき部署ぶしょ对普通用つうよう户来说太复杂，所以ゆえん改あらため用よう Golang 开发。可か以方便びん用よう户部署しょ和わ实用。

开发缘起是ぜ公司こうしIT部ぶ门需要じゅよう一款简单实用的项目接口文档管理和分享的系统。其功能のう和わ界面かいめん源げん于 kancloud 。

可か以用来らい储存日常にちじょう接せっ口こう文ぶん档，数すう据すえ库字典じてん，手て册さつ说明等とう文ぶん档。内うち置おけ项目管理かんり，用よう户管理かんり，权限管理かんり等とう功こう能のう，能のう够满足あし大だい部分ぶぶん中小ちゅうしょう团队的てき文ぶん档管理かんり需求。

• https://www.iminho.me/wiki/docs/mindoc/
• https://doc.gsw945.com/docs/mindoc-docs/

感かん谢作者しゃ lifei6671 创造了りょうMinDoc，并持续维护了很久。

作者さくしゃ因いん工作こうさく等とう原因げんいん，精力せいりょく有限ゆうげん，无法花はな费足够的时间来らい持じ续维护mindoc，已やめ于北京ぺきん时间2021年ねん3月がつ23日にち将はたmindoc交给社しゃ区く(github组织mindoc-org)维护，期待きたい热心开发者しゃ加入かにゅうmindoc-org一起かずき来らい维护MinDoc。

遇ぐう到いた问题请提 Issues，欢迎使用しよう者しゃ和わ贡献者しゃ加入かにゅうQQ群ぐん 1051164153

对开发感兴趣请关注ちゅう Development:

• Todo List
• Work in progress
• Review in progress

如果你的服ふく务器上じょう没ぼつ有安ありやす装そうgolang程ほど序じょ请手动设置おけ一个环境变量如下：键名为 ZONEINFO，值为MinDoc跟目录下的てき/lib/time/zoneinfo.zip 。

更さら多た信しん息いき请查看み手しゅ册さつ： MinDoc 使用しよう手しゅ册さつ

对于没ぼつ有ゆうGolang使用しよう经验的てき用よう户，可か以从 https://github.com/mindoc-org/mindoc/releases 这里下か载编译完的てき程ほど序じょ。

如果有ゆうGolang开发经验，建けん议通过编译安装そう，要求ようきゅうgolang版本はんぽん不ふ小しょう于1.13(需支持しじCGO和わgo mod)。

注意ちゅうい: CentOS7上じょうGLibC版本はんぽん低てい，需要じゅよう源げん码编译, 编译好このみ的てき二进制文件无法运行。

# 克かつ隆りゅう源はじめ码
git clone https://github.com/mindoc-org/mindoc.git
# go包つつみ安あん装そう
go mod tidy
# 编译(sqlite需要じゅようCGO支持しじ)
go build -ldflags "-w"
# 数かず据すえ库初始はじめ化か(此步骤执行ぎょう之の前まえ，需配置はいち`conf/app.conf`)
./mindoc install
# 执行
./mindoc

MinDoc 如果使用しようMySQL储存数すう据すえ，则编码必须是utf8mb4_general_ci。请在安あん装そう前ぜん，把わ数すう据すえ库配置はいち填はま充たかし到いた项目目め录下的てき conf/app.conf 中なか。

如果使用しよう SQLite 数かず据すえ库，则直接ちょくせつ在ざい配置はいち文ぶん件けん中ちゅう配置はいち数すう据すえ库路径みち即そく可か.

如果conf目め录下不ふ存在そんざい app.conf 请重命名めいめい app.conf.example 为 app.conf。

默だま认程序じょ会かい自じ动初始はじめ化か一个超级管理员用户：admin 密みつ码：123456 。请登录后重おも新しん设置密みつ码。

wget -c http://www.musl-libc.org/releases/musl-1.2.2.tar.gz
tar -xvf musl-1.2.2.tar.gz
cd musl-1.2.2
./configure
make
sudo make install

go mod tidy -v
export GOARCH=amd64
export GOOS=linux
# 设置使用しようmusl-gcc
export CC=/usr/local/musl/bin/musl-gcc
# 设置版本はんぽん
export TRAVIS_TAG=temp-musl-v`date +%y%m%d`
go build -o mindoc_linux_musl_amd64 --ldflags="-linkmode external -extldflags '-static' -w -X 'github.com/mindoc-org/mindoc/conf.VERSION=$TRAVIS_TAG' -X 'github.com/mindoc-org/mindoc/conf.BUILD_TIME=`date`' -X 'github.com/mindoc-org/mindoc/conf.GO_VERSION=`go version`'"
# 验证
./mindoc_linux_amd64 version

#邮件配置はいち-示しめせ例れい
#是ぜ否ひ启用邮件
enable_mail=true
#smtp服ふく务器的てき账号
smtp_user_name=admin@iminho.me
#smtp服ふく务器的てき地ち址し
smtp_host=smtp.ym.163.com
#密みつ码
smtp_password=1q2w3e__ABC
#端はし口こう号ごう
smtp_port=25
#邮件发送人的じんてき地ち址し
form_user_name=admin@iminho.me
#邮件有效ゆうこう期き30分ふん钟
mail_expired=30

如果是ぜDocker用よう户，可か参考さんこう项目内ない置おけ的てきDockerfile文ぶん件けん自じ行くだり编译镜像(编译命令めいれい见Dockerfile文ぶん件けん底部ていぶ注ちゅう释，仅供参考さんこう)。

在ざい启动镜像时需要よう提供ていきょう如下的てき常用じょうよう环境变量(全部ぜんぶ支持しじ的てき环境变量请参考さんこう: conf/app.conf.example)：

DB_ADAPTER                  指定していDB类型(默だま认为sqlite)
MYSQL_PORT_3306_TCP_ADDR    MySQL地ち址し
MYSQL_PORT_3306_TCP_PORT    MySQL端はし口こう号ごう
MYSQL_INSTANCE_NAME         MySQL数すう据すえ库名称めいしょう
MYSQL_USERNAME              MySQL账号
MYSQL_PASSWORD              MySQL密みつ码
HTTP_PORT                   程ほど序じょ监听的てき端はし口こう号ごう
MINDOC_ENABLE_EXPORT        开启导出(默だま认为false)

set MINDOC=//d/mindoc
docker run -it --name=mindoc --restart=always -v "%MINDOC%":"/mindoc-sync-host" -p 8181:8181 -e MINDOC_ENABLE_EXPORT=true -d registry.cn-hangzhou.aliyuncs.com/mindoc-org/mindoc:v2.1-beta.5

export MINDOC=/home/ubuntu/mindoc-docker
docker run -it --name=mindoc --restart=always -v "${MINDOC}":"/mindoc-sync-host" -p 8181:8181 -e MINDOC_ENABLE_EXPORT=true -d registry.cn-hangzhou.aliyuncs.com/mindoc-org/mindoc:v2.1-beta.5

docker run -p 8181:8181 --name mindoc -e DB_ADAPTER=mysql -e MYSQL_PORT_3306_TCP_ADDR=10.xxx.xxx.xxx -e MYSQL_PORT_3306_TCP_PORT=3306 -e MYSQL_INSTANCE_NAME=mindoc -e MYSQL_USERNAME=root -e MYSQL_PASSWORD=123456 -e httpport=8181 -d daocloud.io/lifei6671/mindoc:latest

• 无需代理だいり直接ちょくせつ加速かそく各かく种 GitHub 资源拉ひしげ取ど | 国内こくない镜像赋能 | 助力じょりょく开发
• 阿おもね里さと云うん - Ubuntu 镜像

1. 修おさむ改あらため配置はいち文ぶん件けん 修おさむ改あらためdocker-compose.yml中なか的てき配置はいち信しん息いき，主要しゅよう修おさむ改あらためvolumes节点，将はた宿主しゅくしゅ机つくえ的てき两个目め录映射い到いた容器ようき内ない。 environment节点，配置はいち自己じこ的てき环境变量。

2. 一键完成所有环境搭建

   docker-compose up -d

3. 浏览器き访问

   http://localhost:8181/

   整せい个部署しょ完成かんせい了りょう

4. 常用じょうよう命令めいれい参考さんこう

   • 启动

     docker-compose up -d

   • 停止ていし

     docker-compose stop

   • 重じゅう启

     docker-compose restart

   • 停止ていし删除容器ようき，释放所有しょゆう资源

     docker-compose down

   • 删除并重新しん创建

     docker-compose -f docker-compose.yml down && docker-compose up -d

     更さら多た docker-compose 的てき使用しよう相しょう关的内容ないよう 请查看み官かん网文档或百ひゃく度ど

创建项目

项目列れつ表ひょう

项目概がい述じゅつ

项目成なり员

项目设置

基もと于Editor.md开发的てきMarkdown编辑器き

基もと于wangEditor开发的てき富とみ文ぶん本ほん编辑器き

项目预览

超ちょう级管理かんり员后台だい

• Beego 1.10.0
• MySQL 5.6
• editor.md Markdown 编辑器き
• Bootstrap 3.2
• jQuery 库
• WebUploader 文ぶん件けん上じょう传框架か
• NProgress 库
• jsTree 树状结构库
• Font Awesome 字体じたい库
• Cropper 图片剪裁库
• layer 弹出层框架か
• highlight.js 代だい码高亮あきら库
• to-markdownTurndown HTML转Markdown库
• quill 富とみ文ぶん本ほん编辑器き
• wangEditor 富とみ文ぶん本ほん编辑器き
  • 参考さんこう
    • wangEditor v4.7 富とみ文ぶん本ほん编辑器き教程きょうてい
    • 扩展菜さい单注册さつ太ふとし过繁琐 #2493
  • 工具こうぐ： https://babeljs.io/repl + @babel/plugin-transform-classes
• Vue.js 框かまち架か

• 项目管理かんり，可か以对项目进行编辑更改こうかい，成なり员添加てんか等とう。
• 文ぶん档管理かんり，添加てんか和わ删除文ぶん档等。
• 评论管理かんり，可か以管理かんり文ぶん档评论和自己じこ发布的てき评论。
• 用よう户管理かんり，添加てんか和わ禁きん用よう用よう户，个人资料更改こうかい等とう。
• 用よう户权限げん管理かんり ， 实现用よう户角色しょく的てき变更。
• 项目加か密みつ，可か以设置おけ项目公こう开状态，私有しゆう项目需要じゅよう通どおり过Token访问。
• 站点配置はいち，可か开启匿名とくめい访问、验证码等。

我わが们欢迎むかえ您在 MinDoc 项目的もくてき GitHub 上じょう报告 issue 或ある者もの pull request。

如果您还不ふ熟じゅく悉GitHub的てきFork and Pull开发模も式しき，您可以阅读GitHub的てき文ぶん档（https://help.github.com/articles/using-pull-requests） 获得更さら多た的てき信しん息いき。

一いち个不纯粹的てきPHPer，一いち个不自由ふじゆう的てき gopher 。