/Ink-wash-docs

水墨文档,一款基于egg+vue开发的在线文档管理平台,支持markdown文档, excel文档,原型托管等功能. http://47.104.247.183:7001/

Primary LanguageVueApache License 2.0Apache-2.0

前言

团队中会遇到在线文档管理的需求,包括技术文档,接口文档,excel文档,和产品原型的托管等需求,一直没有找到合适的开源项目来满足需求,所以动手实现了个文档管理系统(实现起来并不复杂,该教程只是提供思路,并非最佳实践)

Github: 传送门
演示地址:传送门
掘金文章:传送门

功能列表

  • 登录注册
  • 工作台|文档列表
  • 文档编辑预览(支持:md, excel,html产品原型托管)
  • 协作编辑
  • 访问权限设置
  • 团队管理
  • 点赞收藏
  • 模板管理
  • 浏览历史
  • 回收站
  • 文件夹形式阅读(接口文档)
  • 编辑历史版本

系统界面预览

工程目录结构

|-- app					--------服务器端项目代码
    |--controller				--------用于解析用户的输入,处理后返回相应的结果
    |--extend					--------框架的扩展
    |--middleware				--------编写中间件
    |--model					--------Schema数据模型
    |--public					--------用于放置静态资源
    |--service					--------用于编写业务逻辑层
    |--router.js				--------用于配置 URL 路由规则
|-- config					--------egg 配置文件
    |--config.default.js			--------默认配置
    |--config.local.js				--------开发环境配置
    |--config.prod.js				--------生产环境配置
    |--plugin.js					--------配置需要加载的插件
|-- web						--------前端项目界面代码
    |--common					--------前端界面对应静态资源
    |--components				--------组件
    |--config					--------配置文件
    |--filter					--------过滤器
    |--pages					--------页面
    |--router					--------路由配置
    |--store					--------vuex状态管理
    |--service					--------axios封装
    |--App.vue					--------App
    |--main.js					--------入口文件
    |--permission.js			--------权限控制
|-- docs					--------预留编写项目文档目录
|-- vue.config.js			--------vue webpack配置文件
|-- package.json
...
...

本地开发

// 启动后端服务
npm run dev
// 启动前端项目
npm run build

本地部署

先build个前端版本,然后再部署egg服务到本地

License

Apache License 2.0

捐赠作者

如果你觉得这个项目对你有用或者有所启发,可以请作者喝杯果汁:(黄维)

d023c7f64e8d9f8b899b561f31a7463.jpg