{"id":20253686,"url":"https://github.com/chanzuckerberg/czi-prosemirror","last_synced_at":"2025-04-06T03:09:37.372Z","repository":{"id":34597469,"uuid":"156305507","full_name":"chanzuckerberg/czi-prosemirror","owner":"chanzuckerberg","description":"Rich Text Editor built with React and ProseMirror","archived":false,"fork":false,"pushed_at":"2023-07-07T20:41:19.000Z","size":5284,"stargazers_count":345,"open_issues_count":41,"forks_count":62,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-03-30T02:06:06.032Z","etag":null,"topics":["prosemirror","react","rich-text-editor"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/chanzuckerberg.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-06T01:06:02.000Z","updated_at":"2025-02-07T08:45:55.000Z","dependencies_parsed_at":"2024-11-14T10:40:15.356Z","dependency_job_id":null,"html_url":"https://github.com/chanzuckerberg/czi-prosemirror","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/chanzuckerberg%2Fczi-prosemirror","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chanzuckerberg%2Fczi-prosemirror/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chanzuckerberg%2Fczi-prosemirror/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chanzuckerberg%2Fczi-prosemirror/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chanzuckerberg","download_url":"https://codeload.github.com/chanzuckerberg/czi-prosemirror/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247427006,"owners_count":20937201,"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":["prosemirror","react","rich-text-editor"],"created_at":"2024-11-14T10:26:59.674Z","updated_at":"2025-04-06T03:09:37.334Z","avatar_url":"https://github.com/chanzuckerberg.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n***Notice: This project still under active development. API documentations will be available later.***\n\n---\n\n# CZI-ProseMirror \u0026middot; [![Build Status](https://travis-ci.com/chanzuckerberg/czi-prosemirror.svg?branch=master)](https://travis-ci.com/chanzuckerberg/czi-prosemirror)\n\n+ Drop-In WYSIWYG editor based on ProseMirror \u0026 React\n+ Live DEMO: http://cdn.summitlearning.org/assets/czi_prosemirror_0_0_1_1_20190509151928_index.html\n\n---\n\n## Getting Started\n\n### Getting repository\n\n```\ngit clone https://github.com/chanzuckerberg/czi-prosemirror.git\ncd czi-prosemirror\nnpm install\n```\n\n\n### Install dependencies\n```\ncd czi-prosemirror\nnpm install\n```\n\n### Start the web server\n\n```\n# At the working directory `czi-prosemirror`\nnpm start\n```\nTest http://localhost:3001/ from your browser\n\n### Build the distribution files\n\n```\n# At the working directory `czi-prosemirror`\nnpm run build:dist\n```\n\n## Development with React\n\n```\nimport React from 'react';\nimport {createEmptyEditorState, EditorState, RichTextEditor} from 'czi-prosemirror';\n\nclass Example extends React.PureComponent {\n\n  constructor(props) {\n    super(props, context);\n    this.state = {\n      editorState: createEmptyEditorState(),\n    };\n  }\n\n  render() {\n    const {editorState, editorView} = this.state;\n    return (\n      \u003cRichTextEditor\n        editorState={editorState}\n        onChange={this._onChange}\n      /\u003e\n    );\n  }\n\n  _onChange = (editorState: EditorState): void =\u003e {\n    this.setState({editorState});\n  };\n}\n\nexport default Example;\n```\n\n## Use it for your own project\n\n\nThis project still under active development. There will be NPM package published later.\nFor now, you can install using the commit hash to include the package to your own `package.json`.\n\nFor example:\n\n```\nnpm install --save \"chanzuckerberg/czi-prosemirror#8313aa0970b607c17019f7a5cc8df58c46e78916\"\n```\n\nYou may find the latest commit hash at https://github.com/chanzuckerberg/czi-prosemirror/commits/master\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchanzuckerberg%2Fczi-prosemirror","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchanzuckerberg%2Fczi-prosemirror","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchanzuckerberg%2Fczi-prosemirror/lists"}