{"_id":"@arkxos/choerodon-knowledge","_rev":"2-af736134e8572cd9297c6379c413081e","name":"@arkxos/choerodon-knowledge","dist-tags":{"latest":"2.0.1"},"versions":{"2.0.1":{"name":"@arkxos/choerodon-knowledge","version":"2.0.1","author":"","license":"ISC","_id":"@arkxos/choerodon-knowledge@2.0.1","maintainers":[{"name":"arkxos","email":"arkxos@qq.com"}],"dist":{"shasum":"afcdf4d8cd553f5488e09768b1758a7ce3a13fbb","tarball":"https://registry.npmjs.org/@arkxos/choerodon-knowledge/-/choerodon-knowledge-2.0.1.tgz","fileCount":215,"integrity":"sha512-bDLFou0M6QWPnScbAskJ258jqSjbBSMzHzY7g47gx0jQwMupqPVDygnhGyqWIpnsbxiflu54RWY+NCem8fSkag==","signatures":[{"sig":"MEUCIHWAGXY+2Dn4k/9Fbe6KpyxrCDqDi/BGSl3uyN4+PhVMAiEAjj1o/Qw7xJcdHvh76I+f5lP3Jxs/tSPW68DBJzFhb0g=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":848180},"main":"./lib/index.js","husky":{"hooks":{"pre-commit":"lint-staged"}},"gitHead":"f51582c98bedad4329126a69df2975030a391713","scripts":{"dist":"choerodon-front-boot dist --config ./react/config.js","start":"node --max_old_space_size=4096 node_modules/@arkxos/choerodon-boot/bin/choerodon-front-boot-start --config ./react/config.js","compile":"choerodon-front-boot compile","lint-staged":"lint-staged","lint-staged:es":"eslint"},"_npmUser":{"name":"arkxos","email":"arkxos@qq.com"},"routeName":"knowledge","_npmVersion":"10.8.2","description":"Choerodon Knowledge Front ","directories":{},"lint-staged":{"react/**/*.scss":"stylelint --syntax scss","react/**/*.{js,jsx}":["npm run lint-staged:es"]},"resolutions":{"react":"16.14.0","react-dom":"16.14.0"},"_nodeVersion":"20.19.0","dependencies":{"jquery":"^3.5.0","file-saver":"^2.0.2","@atlaskit/icon":"^17.0.0","@atlaskit/tree":"^6.0.0","@atlaskit/button":"^13.0.0","copy-to-clipboard":"^3.2.0","styled-components":"^5.1.1","react-image-lightbox":"^4.6.0","@toast-ui/react-editor":"^2.1.0","@toast-ui/react-image-editor":"^1.0.0","@toast-ui/editor-plugin-color-syntax":"^1.0.0","@toast-ui/editor-plugin-table-merged-cell":"^1.0.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^7.6.0","babel-eslint":"8.x","babel-preset-c7n":"0.0.2","eslint-plugin-react":"^7.20.5","eslint-config-airbnb":"^18.2.0","eslint-plugin-import":"^2.22.0","eslint-config-c7n-app":"^0.0.2","@arkxos/choerodon-boot":"1.2.1","eslint-plugin-jsx-a11y":"^6.3.1","@arkxos/choerodon-agile":"2.0.4","@arkxos/choerodon-master":"1.4.2","@typescript-eslint/parser":"^3.7.1","eslint-plugin-react-hooks":"^4.0.8","@typescript-eslint/eslint-plugin":"^3.7.1"},"_npmOperationalInternal":{"tmp":"tmp/choerodon-knowledge_2.0.1_1763904759838_0.13314092111318088","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2025-11-23T13:32:39.779Z","modified":"2026-01-08T09:37:30.595Z","2.0.1":"2025-11-23T13:32:40.098Z"},"license":"ISC","description":"Choerodon Knowledge Front ","maintainers":[{"email":"arkxos@qq.com","name":"arkxosboot"}],"readme":"# 知识库服务\r\n猪齿鱼知识管理是一种内容管理工具，具有创建、编辑、导航、链接、搜索等功能，可以与猪齿鱼其他服务结合共同来帮助企业做好协助管理工作。\r\n\r\n## 特性\r\n- `文档管理 `：可以快速操作文档，并支持文档上传附件、评论、记录操作日志等功能，支持word导入及pdf导出\r\n\r\n- `版本管理 `：记录用户每次保存文档的版本记录，并支持版本回滚、比较、自动保存等\r\n\r\n- `树状文档结构 `：文档结构以树的形式进行展示，不限制层级，可以无限向下创建子级。通过树形的展示方式，可以查看你所在的项目下的所有文档，包括文档之间的父子关系\r\n\r\n- `全文检索`：根据关键词对搜索结果进行权重排序\r\n\r\n- `操作简单快速 `\r\n\r\n## 应用场景\r\n\r\n* `知识沉淀`——沉淀软件开发过程中的需求、设计、规范等知识文档。\r\n\r\n* `项目协同`——有效管理项目中的计划安排，会议记录等，加强项目成员之间的合作。\r\n\r\n* `产品文档`——便捷地编写软件产品的概念说明、用户手册、快速入门等产品文档。\r\n\r\n* `培训教材`——方便地编写软件功能使用等培训材料，甚至视频教程等。\r\n\r\n## 环境需求\r\n\r\n- Java8\r\n- mysql 5.6+\r\n- 该项目是一个 Eureka Client 项目启动后需要注册到 `EurekaServer`，本地环境需要 `eureka-server`，线上环境需要使用 `go-register-server`\r\n- ElasticSearch7.0\r\n\r\n## 服务配置\r\n- `application.yml`\r\n ```yaml\r\nspring:\r\n  datasource:\r\n    url: jdbc:mysql://localhost:3306/knowledgebase_service?useUnicode=true&characterEncoding=utf-8&useSSL=false&useInformationSchema=true&remarks=true\r\n    username: choerodon\r\n    password: 123456\r\n  servlet: #设置上传文件最大为30M\r\n    multipart:\r\n      max-file-size: 30MB\r\n      max-request-size: 30MB\r\nchoerodon:\r\n  saga:\r\n    consumer:\r\n      thread-num: 5 # saga消息消费线程池大小\r\n      max-poll-size: 200 # 每次拉取消息最大数量\r\n      enabled: false # 关闭消费端\r\n      poll-interval-ms: 1000 # 拉取间隔，默认1000毫秒\r\n  schedule:\r\n    consumer:\r\n      enabled: false # 关闭任务调度消费端\r\n      thread-num: 1 # 任务调度消费线程数\r\n      poll-interval-ms: 1000 # 拉取间隔，默认1000毫秒\r\nservices:\r\n  attachment:\r\n    url: http://minio.example.com/knowledgebase-service/\r\nfeign:\r\n  hystrix:\r\n    shareSecurityContext: true\r\n    command:\r\n      default:\r\n        execution:\r\n          isolation:\r\n            thread:\r\n              timeoutInMilliseconds: 10000\r\nribbon:\r\n  ConnectTimeout: 5000\r\n  ReadTimeout: 5000\r\neureka:\r\n  instance:\r\n    preferIpAddress: true\r\n    leaseRenewalIntervalInSeconds: 10\r\n    leaseExpirationDurationInSeconds: 30\r\n  client:\r\n    serviceUrl:\r\n      defaultZone: ${EUREKA_DEFAULT_ZONE:http://localhost:8000/eureka/}\r\n    registryFetchIntervalSeconds: 10\r\nmybatis:\r\n  mapperLocations: classpath*:/mapper/*.xml\r\n  configuration: # 数据库下划线转驼峰配置\r\n    mapUnderscoreToCamelCase: true\r\nelasticsearch:\r\n  ip: 127.0.0.1:9200\r\n```\r\n\r\n- `bootstrap.yml`\r\n\r\n  ```yaml\r\n  server:\r\n    port: 8280\r\n  spring:\r\n    application:\r\n      name: knowledgebase-service\r\n    mvc:\r\n      static-path-pattern: /**\r\n    resources:\r\n      static-locations: classpath:/static,classpath:/public,classpath:/resources,classpath:/META-INF/resources,file:/dist\r\n    cloud:\r\n      config:\r\n        failFast: true\r\n        retry:\r\n          maxAttempts: 6\r\n          multiplier: 1.5\r\n          maxInterval: 2000\r\n        uri: localhost:8010\r\n        enabled: false\r\n  management:\r\n    server:\r\n      port: 8281\r\n    endpoints:\r\n      web:\r\n        exposure:\r\n          include: '*'\r\n      health:\r\n        show-details: \"ALWAYS\"\r\n  ```\r\n## 安装和启动\r\n- 运行 `eureka-server`，[代码在这里](https://code.choerodon.com.cn/choerodon-framework/eureka-server.git)。\r\n\r\n- 拉取当前项目到本地\r\n\r\n  ```shell\r\n  git clone https://code.choerodon.com.cn/choerodon-agile/knowledgebase-service.git\r\n  ```\r\n\r\n- 初始化数据库，本地创建 `knowledgebase_service` 数据表，代码如下：\r\n\r\n\r\n```sql\r\nCREATE USER 'choerodon'@'%' IDENTIFIED BY \"choerodon\";\r\nCREATE DATABASE knowledgebase_service DEFAULT CHARACTER SET utf8;\r\nGRANT ALL PRIVILEGES ON knowledgebase_service.* TO choerodon@'%';\r\nFLUSH PRIVILEGES;\r\n```\r\n- 初始化 `knowledgebase_service` 数据表数据，运行项目根目录下的 `init-local-database.sh`，该脚本默认初始化数据库的地址为 `localhost`，若有变更需要修改脚本文件\r\n\r\n  ```sh\r\n  sh init-local-database.sh\r\n  ```\r\n\r\n- 启动项目，项目根目录下运行 `mvn clean spring-boot:run` 命令，或者在本地集成环境中运行 `SpringBoot` 启动类 `/src/main/java/io/choerodon/kb/KnowledgeBaseServiceApplication.java`\r\n\r\n## 报告问题\r\n如果你发现任何缺陷或者bugs，请在[issue](https://github.com/choerodon/choerodon/issues/new?template=issue_template.md)上面描述并提交给我们。\r\n\r\n## 贡献\r\n我们十分欢迎您的参与！ [Follow](https://github.com/choerodon/choerodon/blob/master/CONTRIBUTING.md) 去获得更多关于提交贡献的信息。\r\n","readmeFilename":"README.zh-CN.md"}