{"id":13846189,"url":"https://github.com/huangwei9527/Ink-wash-docs","last_synced_at":"2025-07-12T05:32:11.327Z","repository":{"id":39984922,"uuid":"294017796","full_name":"huangwei9527/Ink-wash-docs","owner":"huangwei9527","description":"水墨文档，一款基于egg+vue开发的在线文档管理平台，支持markdown文档， excel文档，原型托管等功能. http://139.199.172.193:7001/","archived":false,"fork":false,"pushed_at":"2023-09-08T07:39:20.000Z","size":2551,"stargazers_count":589,"open_issues_count":11,"forks_count":149,"subscribers_count":15,"default_branch":"master","last_synced_at":"2024-11-05T07:34:13.541Z","etag":null,"topics":["eggjs","koa","nodejs","vue"],"latest_commit_sha":null,"homepage":"","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/huangwei9527.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-09-09T06:01:35.000Z","updated_at":"2024-11-03T00:14:05.000Z","dependencies_parsed_at":"2024-02-21T10:59:47.537Z","dependency_job_id":null,"html_url":"https://github.com/huangwei9527/Ink-wash-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huangwei9527%2FInk-wash-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huangwei9527%2FInk-wash-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huangwei9527%2FInk-wash-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huangwei9527%2FInk-wash-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/huangwei9527","download_url":"https://codeload.github.com/huangwei9527/Ink-wash-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225799485,"owners_count":17526054,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["eggjs","koa","nodejs","vue"],"created_at":"2024-08-04T17:04:35.111Z","updated_at":"2024-11-21T20:30:19.269Z","avatar_url":"https://github.com/huangwei9527.png","language":"Vue","funding_links":[],"categories":["Vue"],"sub_categories":[],"readme":"## 前言\n团队中会遇到在线文档管理的需求，包括技术文档，接口文档，excel文档，和产品原型的托管等需求，一直没有找到合适的开源项目来满足需求，所以动手实现了个文档管理系统（实现起来并不复杂，该教程只是提供思路，并非最佳实践）\n\nGithub: [传送门](https://github.com/huangwei9527/Ink-wash-docs)\u003cbr/\u003e\n演示地址：[传送门](http://47.104.247.183:7001)\u003cbr/\u003e\n掘金文章：[传送门](https://juejin.im/post/6886735919697788941)\n\n## node 版本 14\n\n## 功能列表\n* [x] 登录注册\n* [x] 工作台|文档列表\n* [x] 文档编辑预览（支持：md， excel，html产品原型托管）\n* [x] 协作编辑\n* [x] 访问权限设置\n* [x] 团队管理\n* [x] 点赞收藏\n* [x] 模板管理\n* [x] 浏览历史\n* [x] 回收站\n* [ ] 文件夹形式阅读（接口文档）\n* [ ] 编辑历史版本\n\n\n## 系统界面预览\n![](https://p9-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/7ed9c1e870e54da290344ab480ecf587~tplv-k3u1fbpfcp-watermark.image)\n\n\n## 工程目录结构\n\n```\n|-- app\t\t\t\t\t--------服务器端项目代码\n    |--controller\t\t\t\t--------用于解析用户的输入，处理后返回相应的结果\n    |--extend\t\t\t\t\t--------框架的扩展\n    |--middleware\t\t\t\t--------编写中间件\n    |--model\t\t\t\t\t--------Schema数据模型\n    |--public\t\t\t\t\t--------用于放置静态资源\n    |--service\t\t\t\t\t--------用于编写业务逻辑层\n    |--router.js\t\t\t\t--------用于配置 URL 路由规则\n|-- config\t\t\t\t\t--------egg 配置文件\n    |--config.default.js\t\t\t--------默认配置\n    |--config.local.js\t\t\t\t--------开发环境配置\n    |--config.prod.js\t\t\t\t--------生产环境配置\n    |--plugin.js\t\t\t\t\t--------配置需要加载的插件\n|-- web\t\t\t\t\t\t--------前端项目界面代码\n    |--common\t\t\t\t\t--------前端界面对应静态资源\n    |--components\t\t\t\t--------组件\n    |--config\t\t\t\t\t--------配置文件\n    |--filter\t\t\t\t\t--------过滤器\n    |--pages\t\t\t\t\t--------页面\n    |--router\t\t\t\t\t--------路由配置\n    |--store\t\t\t\t\t--------vuex状态管理\n    |--service\t\t\t\t\t--------axios封装\n    |--App.vue\t\t\t\t\t--------App\n    |--main.js\t\t\t\t\t--------入口文件\n    |--permission.js\t\t\t--------权限控制\n|-- docs\t\t\t\t\t--------预留编写项目文档目录\n|-- vue.config.js\t\t\t--------vue webpack配置文件\n|-- package.json\n...\n...\n```\n## 本地开发\n```\n// 启动后端服务\nnpm run dev\n// 启动前端项目\nnpm run dev-web\n```\n## 本地部署\n先build个前端版本，然后再部署egg服务到本地\n```\n1、npm run build-web\n2、npm run copy-web-html\n3、npm run start\n\n```\n\n### License\nApache License 2.0\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhuangwei9527%2FInk-wash-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhuangwei9527%2FInk-wash-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhuangwei9527%2FInk-wash-docs/lists"}