MinDoc 是一款专门为 IT 团队打造的在线文档管理系统，它以简单易用为特色，能够满足中小团队在项目接口文档管理、数据库字典存储、手册说明记录等多方面的需求。它的前身是基于 PHP 框架 laravel 开发的 SmartWiki，后因部署复杂性改用 Golang 开发，大大提升了部署的便捷性。

一、核心功能详解

（一）项目管理

在 MinDoc 中，项目管理功能丰富且实用。团队可以创建不同的项目，为每个项目设置唯一标识、标题、描述、封面等信息。例如，一个软件开发项目，可以详细描述项目的功能、技术架构等内容。项目管理者还能轻松添加或删除项目成员，并为成员分配相应的角色，如管理员、普通成员等，通过角色来控制成员对项目文档的访问和编辑权限。这一功能确保了项目信息的安全性和保密性，同时也方便团队成员协同工作。

（二）文档管理

MinDoc 支持多种文档操作，包括添加、编辑和删除文档。它提供了两种强大的编辑器：基于 Editor.md 开发的 Markdown 编辑器和基于 wangEditor 开发的富文本编辑器。Markdown 编辑器适合熟悉 Markdown 语法的用户，能够快速高效地编写文档，通过简单的标记语法就能实现文本格式的设置；富文本编辑器则更加直观，用户可以像使用 Word 一样直接对文本进行字体、字号、颜色等格式设置，满足不同用户的编辑习惯。无论是技术文档、会议记录还是项目报告，都能轻松撰写。

（三）评论管理

评论管理功能方便团队成员之间对文档进行交流和反馈。当成员对文档内容有疑问、建议或需要进一步讨论时，可以在文档下方发表评论。同时，用户还能对自己发布的评论进行管理，如修改、删除等操作，确保评论的准确性和有效性。这有助于团队成员及时沟通，提高文档质量和项目推进效率。

（四）用户管理

管理员在 MinDoc 中拥有全面的用户管理权限。可以添加新用户，为新成员创建账号；对于违规或不再使用系统的用户，能够进行禁用操作。此外，还能修改用户的个人资料，如用户名、邮箱等信息。通过用户权限管理，可灵活变更用户角色，如将普通成员提升为管理员，赋予更多的管理权限，或者将管理员降为普通成员，调整其权限范围，从而实现对系统访问和操作的精细控制。

（五）项目加密

为了保护项目文档的隐私和安全，MinDoc 提供了项目加密功能。可以将项目设置为公开或私有状态。公开项目允许任何人访问，适合一些需要对外展示的文档项目；而私有项目则需要通过 Token 访问，只有获得授权的人员才能查看和编辑项目内容。例如，涉及公司机密的项目文档，就可以设置为私有项目，确保信息安全。

（六）站点配置

站点配置功能为管理员提供了对整个系统的定制能力。可以开启匿名访问，让未注册用户也能查看部分公开文档，方便信息的传播和共享；开启验证码功能，则能有效防止恶意注册和暴力破解，提高系统的安全性。这些配置选项能够根据团队的实际需求进行灵活调整，打造个性化的文档管理环境。

二、安装与部署

2.1.1 本地部署

下载 Mindoc 的 release 包，解压到指定目录。

配置 conf/app.conf 文件，设置数据库连接等信息。

运行 mindoc_linux_amd64 或 mindoc_windows_amd64.exe 启动服务。

2.1.2 Docker 部署

拉取 Mindoc 的 Docker 镜像：

docker pull mindoc/mindoc

运行容器：

docker run -d -p 8181:8181 --name mindoc mindoc/mindoc

访问 http://localhost:8181 即可使用。

2.2 创建文档

登录 Mindoc 系统，进入文档管理页面。

点击“新建文档”按钮，输入文档标题和内容。

使用 Markdown 语法编写文档内容，支持实时预览。

保存文档后，可以继续编辑或发布。

2.3 团队协作

在用户管理页面，添加团队成员并设置角色和权限。

在文档页面，点击“评论”按钮，添加评论或回复其他成员的评论。

通过版本控制功能，查看文档的历史版本并进行对比。

2.4 导出文档

在文档页面，点击“导出”按钮。

选择导出格式（PDF、Markdown 等），点击“导出”即可下载文档。

项目地址：https://github.com/mindoc-org/mindoc