huangwei9527 / ink-wash-docs Goto Github PK

View Code? Open in Web Editor NEW

567.0 15.0 148.0 2.49 MB

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

License: Apache License 2.0

JavaScript 28.05% HTML 16.22% Vue 44.95% CSS 7.33% SCSS 3.44%

vue nodejs eggjs koa

ink-wash-docs's Introduction

前言

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

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

node 版本 14

功能列表

系统界面预览

工程目录结构

|-- 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 dev-web

本地部署

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

1、npm run build-web
2、npm run copy-web-html
3、npm run start

License

Apache License 2.0

ink-wash-docs's People

Contributors

Stargazers

Watchers

Forkers

iyaq luoyangc asnowbear whf605319646 bestjex zzcandor weilyjy rotate-life xiaocuitest yangangzhang l455202325 gxkai lt1067066026 fe-family yongbolu beluxx yunguoguo xiecz123 song-of-songs whw155 fuyu1993 hailinchen assinx verylove llccing-demo hansxing bayi-lzp xyf-anonymity jiaozheng a1285771357 794321012 codemud freedomdebug zhouxiaoyou326 mvcers luguo124 huyarufitor mtsf blusno1 xuebijishui wylc niunai2016 skyydq oldyangsir ideas-design xunzhaotech fef-design livepo elonchen zhengdeding jack-rainbow hj3938 gpsbird vwin imloama formzs licco89 zhangle1993 ylmzfun forkai toughlama cnvp erickwang 526870237 huangweiboy2 lhx11187 wwwk tengsimon gavincoder-china tonyoki simlan zhou8811356 inmapx user7124732 yuanhaijie wangminhua-fe 521hellogithub army11711 chenyincao wangyuan-ky zyn926 w960603 hellobabi zhaowei-plus xxyqsy rongjiale1225 kysoft-github wxamlzm dgo2dance apicescn xudagongzi denghuafeng two-heads-are-better-than-one 845015895 chunlei ifoxchat shanwenjie wuchunfu xfront-end mklp

ink-wash-docs's Issues

有没有可能做成gitbook那样？

文件夹内多个文档同一页面显示，侧边加上文章目录。

【bug】关于最近浏览始终为空的bug和解决方案

我注意到项目有bug，最近浏览始终为空。

分析代码后发现，

由于在获取历史信息接口的用户信息是从token负载解析出来的。

而token又是由getUsersByUsername方法获取并封装的。

从 let selectUserKey = {password: 0, history_visit_doc: 0}; 看来，问题的根源已经很明显了。在这个定义中，password: 0 和 history_visit_doc: 0 表示在执行 MongoDB 查询时，这两个字段将被排除，不会出现在查询结果中。这就是为什么从数据库查询中获取 history_visit_doc 字段的原因。

解决方法：删除history_visit_doc: 0

修复办法：
在web\common\styles\index.scss中，将.scroll-wrapper增加样式，改为如下

.list-wrapper{
  height: 100%;
  overflow: auto;
}

这样一切就回复正常了。

破坏性修改方法
直接修改
node_modules\egg-multipart\app\extend\context.js 库文件！
在

async saveRequestFiles(options) {
    options = options || {};
    const ctx = this;

    const multipartOptions = {
      autoFields: false,
      limits: {
        fileSize: '50mb'  // 加上这句，这里你可以直接使用 '50mb'，因为函数中似乎有一个 `bytes` 函数来处理这样的字符串
      }
    };

修改config\config.default.js配置
见下