今天开源君分享一款简单好用的文档管理项目 - Mindoc
,听这个名字, Mind + Doc
,或许是想表达“心智文档”的含义,希望能让文档管理变得像吃饭睡觉一样简单。
Mindoc
是一个基于 Go 语言开发的开源文档管理系统。它的界面简洁,功能强大,支持Markdown和HTML编辑器,可以存储接口文档、数据库字典、手册说明等。而且,它还有项目管理、用户管理、权限管理等内置功能,满足中小团队的文档管理需求。
项目简介
Mindoc 是一个基于 Go 语言开发的开源文档管理系统。它的界面简洁,功能强大,支持Markdown和HTML编辑器,可以存储接口文档、数据库字典、手册说明等。而且,它还有项目管理、用户管理、权限管理等内置功能,满足中小团队的文档管理需求。
使用的技术
- Beego 1.10.0
- MySQL 5.6
- editor.md Markdown 编辑器
- cherry-markdown Cherry Markdown Writer
- Bootstrap 3.2
- jQuery 库
- WebUploader 文件上传框架
- NProgress 库
- jsTree 树状结构库
- Font Awesome 字体库
- Cropper 图片剪裁库
- layer 弹出层框架
- highlight.js 代码高亮库
- to-markdownTurndown HTML转Markdown库
- quill 富文本编辑器
- wangEditor 富文本编辑器
- Vue.js 框架
性能特色
简单易用:操作界面直观,即使是技术小白也能快速上手。
多格式支持:支持 Markdown 和富文本编辑器,写文档就像写日记一样简单。
强大的搜索功能:内置全文搜索,再也不怕找不到文档了。
权限管理:可以对文档进行细粒度的权限控制,确保文档安全。
版本控制:文档的每次修改都有记录,可以随时回滚到之前的版本。
安装部署
MinDoc官方提供了非常多的安装部署方法,包括编译安装,Docker安装,脚本一键安装,大家可以安装自己的喜好自行选择。
如常规编译的方法如下,注意golang版本不小于1.15.1,需支持CGO、go mod和import _ “time/tzdata”,推荐Go版本为1.18.1。
# 克隆源码
git clone https://github.com/mindoc-org/mindoc.git
# go包安装
go mod tidy -v
# 编译(sqlite需要CGO支持)
go build -ldflags "-w" -o mindoc main.go
# 数据库初始化(此步骤执行之前,需配置`conf/app.conf`)
./mindoc install
# 执行
./mindoc
# 开发阶段运行
bee run
然后打开浏览器,访问 http://localhost:8181 就可以看到 Mindoc 的界面了。
项目体验展示
MinDoc的界面简洁大方,功能模块一目了然。
编辑器,基于Editor.md开发,支持流程图、思维导图,简直是笔记利器。
基于Editor.md开发的Markdown编辑器
基于wangEditor开发的富文本编辑器
基于cherryMarkdown开发的编辑器
项目预览
超级管理员后台
项目地址:
https://github.com/mindoc-org/mindoc