OneDoc 开源文档管理系统搭建指南

OneDoc 是一款开源的轻量级的企业（项目）文档协同管理系统。

OneDoc 可以用来储存日常接口文档，数据库字典，手册说明等文档。内置项目管理，用户管理，权限管理等功能，能够满足大部分中小团队的文档管理需求。

OneDoc 基于 MinDoc 二次开发。重写了前端页面样式，并更新了部分功能。

OneDoc 适用于以下应用场景：

• 项目技术资料管理
• 企业文档资料管理
• 互联网博客和在线教程网站

项目开源地址：Github 点击下载最新的源码包

技术架构

OneDoc 是一款用 Golang 语言实现的基于 beego 框架的企业（项目）文档协同管理系统。

OneDoc 包含以下技术栈：

• Beego （go语言 web 项目框架）
• Boostrap 5.0.0 （前端页面框架）
• MySQL 5.6 （关系数据库）
• editor.md （Markdown 编辑器）
• Jquery（Javascript 库）
• Vue.js（前端 js 框架）
• …

系统功能

前端功能

前端具有以下功能：

• 首页
• 登录页
• 文章页
  • 文章列表页
  • 文章阅读页
• 教程页
  • 教程分类页
  • 教程列表页
  • 教程阅读页
• 搜索
• 个人中心
  • 基本信息页
  • 修改密码页
• 我的文章
  • 添加文章
  • 编辑文章
• 我的教程
  • 添加教程
  • 编辑教程
• 版权声明、关于我们、联系我们等静态页面

后台功能

后台具有以下功能：

• 用户管理
  • 添加用户
  • 编辑用户
• 团队管理
  • 添加团队
  • 编辑团队
  • 添加和管理团队项目
  • 添加和管理团队成员
• 项目管理
  • 项目列表
  • 设置项目
  • 编辑项目
  • 删除项目
• 项目分类管理
  • 创建项目分类
  • 编辑项目分类
  • 删除项目分类
• 配置管理

系统特点

系统具有以下特点：

• 美观的页面与友好的用户交互体验
• 支持 Markdown 文件和富文本内容
• 支持项目团队对文档的协同管理
• 灵活的用户权限管理
• 灵活的站点配置，可以配置匿名访问和验证码等
• 支持配置 Redis 缓存数据库
• 支持配置邮件服务器

更新说明

OneDoc 基于 MinDoc 二次开发，主要更新了以下内容：

• 将主菜单中的项目空间栏目改为教程，并更新了部分相关的文字描述
• 更新了前端页面样式，包括：
  • header 页面
  • footer 页面
  • 首页
  • 文章页
  • 教程页
  • 搜索页
  • 登录与注册页
• 增加了教程（原项目空间）分类图片
• 增加了文章封面图片
• 增加了文章阅读次数
• 增加了关于我们等静态页面

安装与运行

安装

第一步，下载或克隆仓库源码到指定的项目目录，并将 static.rar 静态文件的压缩包解压缩到项目根目录。

git clone https://github.com/StevenX5/OneDoc.git

第二步，按照 MinDoc 官方的安装教程进行安装。

第三步，更新部分数据库表结构

1. 更新表 md_itemsets，增加 img_url 字段

imgurl	varchar(500)

2. 更新表 md_blogs，增加 cover 和 view_count 字段

cover	      varchar(1000)
view_count	int		default(0)

编译与运行

# 编译
go build

# 开发环境运行
bee run

# 生产环境运行
.\OneDoc      # Windows 环境
# 或
./OneDoc      # Linux 环境

界面截图

首页

登录页

这篇好文章是转载于：学新通技术网