{"id":18897683,"url":"https://github.com/banyudu/kedao","last_synced_at":"2025-04-15T02:11:49.244Z","repository":{"id":37809972,"uuid":"453100472","full_name":"banyudu/kedao","owner":"banyudu","description":"React 编辑器，从 braft-editor 修改而来，基于 draft-js 实现","archived":false,"fork":false,"pushed_at":"2023-06-08T05:46:25.000Z","size":2117,"stargazers_count":7,"open_issues_count":5,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-06T04:06:30.910Z","etag":null,"topics":["braft-editor","draft-js","editor","kedao","react","react-editor","typescript"],"latest_commit_sha":null,"homepage":"https://kedao.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/banyudu.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"publiccode":null,"codemeta":null}},"created_at":"2022-01-28T14:36:07.000Z","updated_at":"2024-01-03T03:12:17.000Z","dependencies_parsed_at":"2024-09-23T06:32:05.034Z","dependency_job_id":"7d5d43ef-e04d-41a8-a176-e312f7a04f58","html_url":"https://github.com/banyudu/kedao","commit_stats":{"total_commits":188,"total_committers":4,"mean_commits":47.0,"dds":0.276595744680851,"last_synced_commit":"29f08d1393b7620c84718c189f44c1e70ae1150d"},"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/banyudu%2Fkedao","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/banyudu%2Fkedao/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/banyudu%2Fkedao/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/banyudu%2Fkedao/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/banyudu","download_url":"https://codeload.github.com/banyudu/kedao/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248604800,"owners_count":21132049,"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":["braft-editor","draft-js","editor","kedao","react","react-editor","typescript"],"created_at":"2024-11-08T08:39:18.032Z","updated_at":"2025-04-15T02:11:49.219Z","avatar_url":"https://github.com/banyudu.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kedao（刻刀） 编辑器\n\nkedao 是一个基于 [braft-editor](https://github.com/margox/braft-editor) 修改而来的前端编辑器，底层基于 [draft-js](https://github.com/facebook/draft-js)。\n\n在 Braft-Editor 的基础之上，kedao 做了一些改进工作，如：\n\n1. 重构了 braft-editor 的多个工程，合并成一个大工程，并修改构建产物，从原来的 webpack 打包后的 bundle，改成源码打包。\n1. 升级了依赖包和工具链的版本。\n1. 改成 Typescript 语言，添加类型定义，方便使用。\n\n## 安装\n\n```bash\nnpm i kedao\n```\n\n## 使用\n\n```jsx\nimport React, { useState } from \"react\";\nimport Editor, {\n  EditorState,\n  convertRawToEditorState,\n  convertEditorStateToRaw,\n} from \"kedao\";\nimport { useLocalStorage } from \"react-use\";\n\nfunction App() {\n  const [value, setValue] = useLocalStorage(\n    \"kedao-state\",\n    convertEditorStateToRaw(EditorState.createEmpty())\n  );\n\n  const [editorState, setEditorState] = useState(\n    convertRawToEditorState(value)\n  );\n\n  const handleChange = (newEditorState: EditorState) =\u003e {\n    setEditorState(newEditorState);\n    setValue(convertEditorStateToRaw(newEditorState));\n  };\n\n  return (\n    \u003cdiv className=\"App\"\u003e\n      \u003cEditor value={editorState} onChange={handleChange} /\u003e\n    \u003c/div\u003e\n  );\n}\n\nexport default App;\n```\n\n更多示例参见 [examples](./examples/)\n\n## 贡献\n\n欢迎任何方式的贡献，issue、文档、翻译等。\n\n[贡献指南](./CONTRIBUTE.md)\n\n## 文档\n\n更多文档见组件官网：[https://kedao.vercel.app](https://kedao.vercel.app)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbanyudu%2Fkedao","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbanyudu%2Fkedao","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbanyudu%2Fkedao/lists"}