{"id":22197158,"url":"https://github.com/null-object-0000/newbie-docs","last_synced_at":"2025-07-27T01:31:08.340Z","repository":{"id":180752812,"uuid":"664510142","full_name":"null-object-0000/newbie-docs","owner":"null-object-0000","description":"基于 Vue 3.0 的开源知识库（文档）管理系统","archived":false,"fork":false,"pushed_at":"2023-08-23T12:02:47.000Z","size":2332,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2023-08-23T12:11:06.430Z","etag":null,"topics":["arco-design","codex-editor","java","spring-boot","typescript","vue3","wangeditor5"],"latest_commit_sha":null,"homepage":"https://newbie-docs.zeabur.app","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/null-object-0000.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}},"created_at":"2023-07-10T06:27:03.000Z","updated_at":"2023-08-12T18:45:37.000Z","dependencies_parsed_at":"2023-08-19T04:15:23.555Z","dependency_job_id":null,"html_url":"https://github.com/null-object-0000/newbie-docs","commit_stats":null,"previous_names":["null-object-0000/newbie-docs"],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/null-object-0000%2Fnewbie-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/null-object-0000%2Fnewbie-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/null-object-0000%2Fnewbie-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/null-object-0000%2Fnewbie-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/null-object-0000","download_url":"https://codeload.github.com/null-object-0000/newbie-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227740662,"owners_count":17812687,"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":["arco-design","codex-editor","java","spring-boot","typescript","vue3","wangeditor5"],"created_at":"2024-12-02T14:18:35.879Z","updated_at":"2024-12-02T14:18:36.482Z","avatar_url":"https://github.com/null-object-0000.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# newbie-docs\n\n基于 Vue 3.0 的开源知识库（文档）管理系统，详细 [业务逻辑](./BusinessLogic.md) 介绍以及 [常见问题](./Question.md) 请见对应文档。\n\n## 主要功能\n\n- :ledger: 像书一样的知识库\n- :gift: 多样的在线编辑器\n- :running:\t便捷的私有化部署\n- :blush:\t个人和团队都适用\n  \n## 开发计划\n\n### v1.0.0\n\n- [x] 基于 `Vue 3.0` 完成 [codex.docs](https://github.com/codex-team/codex.docs) 所有能力\n- [ ] 支持多样的在线编辑器\n  - [x] 基于 [wangEditor 5](https://www.wangeditor.com/) 实现富文本编辑器\n  - [ ] 基于 [Editor.js](https://github.com/codex-team/editor.js) 实现块式编辑器\n  - [x] 基于 [mavonEditor](https://github.com/hinesboy/mavonEditor) 实现 Markdown 编辑器\n- [x] 支持通过知识库管理文档，参考 [语雀](https://www.yuque.com/dashboard)\n- [x] 实现基于 `LocalStorage` 的客户端存储用于演示\n- [x] 实现基于 `Amazon S3` 存储的 `Java` RESTful API 服务端\n- [ ] 支持基于 OAuth2 的第三方登录 + 知识库、文档的权限管理\n- [x] 支持通过 Docker 部署\n\n\u003e `LocalStorage` 存储实现不支持权限管理能力，此时默认所有人都拥有所有知识库、文档的管理员权限\n\n### v2.0.0\n- [ ] 基于 `YJS` 实现文档协同编辑\n- [ ] 完成移动端适配 + 暗黑模式\n- [ ] 接入 `AIGC` 辅助文档编写\n\n### v3.0.0\n- [ ] 支持自定义主题样式\n- [ ] 支持更丰富的在线编辑器\n  - [ ] 基于 [Luckysheet](https://github.com/dream-num/Luckysheet) 的表格编辑能力\n- [ ] 文档的多版本管理 + 支持从各平台导入文档\n- [ ] 实现基于 `Amazon S3` 存储的 多语言的 RESTful API 服务端\n  - [ ] 基于 `Node.js` 的 RESTful API 服务端\n\n## 开发部署\n\n### 本地开发\n\n#### website\n\n- node 18\n- pnpm 8.6\n\n``` bash\n# 环境配置（windows）\ncopy .\\newbie-docs-website\\.env .\\newbie-docs-website\\.env.local\n\n# 本地运行\npnpm install\npnpm website:dev\n\n# 代码提交\nnpm install -g commitizen\npnpm run website:commit\n\n# 本地构建\npnpm website:build\n```\n\n#### java-server\n\n- jdk 17\n- maven 3.9\n\n``` bash\n# 环境配置（windows）\ncd .\\newbie-docs-server-java\\\ncopy .\\src\\main\\resources\\application.properties .\\src\\main\\resources\\application-local.properties\n\n# 本地运行（windows）\nmvn clean package -Dmaven.test.skip=true\njava -jar -Dspring.profiles.active=local .\\target\\newbie-docs-server-java.jar\n```\n\n### Codespaces（linux）\n\n``` bash\nnvm install 18\nnvm use 18\nnpm install -g npm\nnpm install -g pnpm\n\ncp ./newbie-docs-website/.env ./newbie-docs-website/.env.local\n\nsdk install java 17.0.8-ms -y\nsdk use java 17.0.8-ms\n\ncd newbie-docs-server-java/\ncp src/main/resources/application.properties src/main/resources/application-local.properties\n\nmvn clean package -Dmaven.test.skip=true\njava -jar -Dspring.profiles.active=local target/newbie-docs-server-java.jar\n```\n\n### Docker 部署\n\n#### java-server + website\n\n``` bash\n# 构建镜像\ndocker build -t newbie-docs:latest .\n# 运行容器\ndocker run -d -p 8080:80 --name newbie-docs newbie-docs:latest\n```\n\n#### nginx + website\n\n``` bash\n# 构建镜像\ncd .\\newbie-docs-website\\\ndocker build -t newbie-docs:latest .\n# 运行容器\ndocker run -d -p 8080:80 --name newbie-docs newbie-docs:latest\n```\n\n## 技术栈\n\n### website\n- [Vue 3.0](https://cn.vuejs.org/) + [TypeScript](https://www.typescriptlang.org/) + [Vite](https://cn.vitejs.dev/) + [Pinia](https://pinia.vuejs.org/zh/) + [Vue Router](https://next.router.vuejs.org/zh/)\n- [Axios](https://axios-http.com/zh/)\n- [VueUse](https://vueuse.org/guide/)\n- [Arco Design](https://arco.design/)\n- [Editor.js](https://github.com/codex-team/editor.js)\n- [wangEditor 5](https://www.wangeditor.com/)\n- [YJS](https://github.com/yjs/yjs)\n\n### server\n- [Spring Boot](https://spring.io/projects/spring-boot) + [Lombok](https://projectlombok.org/) + [MyBatis](https://mybatis.org/mybatis-3/zh/index.html)\n- [HuTool](https://hutool.cn/)\n- [FastJson 2.0](https://alibaba.github.io/fastjson2/)\n\n### database\n- [MySQL](https://www.mysql.com/cn/)\n- [Amazon S3](https://aws.amazon.com/cn/s3/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnull-object-0000%2Fnewbie-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnull-object-0000%2Fnewbie-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnull-object-0000%2Fnewbie-docs/lists"}