{"id":15048815,"url":"https://github.com/tuture-dev/editure","last_synced_at":"2025-08-24T09:19:16.566Z","repository":{"id":57219647,"uuid":"237747932","full_name":"tuture-dev/editure","owner":"tuture-dev","description":"✍️The richtext markdown editor from the future.","archived":false,"fork":false,"pushed_at":"2021-12-31T12:13:37.000Z","size":1036,"stargazers_count":18,"open_issues_count":3,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T03:11:55.441Z","etag":null,"topics":["editor","hotkeys","markdown","markdown-editor","richtext","wysiwyg"],"latest_commit_sha":null,"homepage":"https://editure-preview.netlify.com/","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/tuture-dev.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}},"created_at":"2020-02-02T09:33:45.000Z","updated_at":"2023-05-31T03:37:58.000Z","dependencies_parsed_at":"2022-08-28T23:22:34.631Z","dependency_job_id":null,"html_url":"https://github.com/tuture-dev/editure","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuture-dev%2Fediture","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuture-dev%2Fediture/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuture-dev%2Fediture/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuture-dev%2Fediture/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tuture-dev","download_url":"https://codeload.github.com/tuture-dev/editure/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247827022,"owners_count":21002792,"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":["editor","hotkeys","markdown","markdown-editor","richtext","wysiwyg"],"created_at":"2024-09-24T21:16:28.364Z","updated_at":"2025-04-10T01:33:57.980Z","avatar_url":"https://github.com/tuture-dev.png","language":"TypeScript","readme":"# Editure\n\n[![Build Status](https://travis-ci.com/tuture-dev/editure.svg?branch=master)](https://travis-ci.com/tuture-dev/editure)[![codecov](https://codecov.io/gh/tuture-dev/editure/branch/master/graph/badge.svg)](https://codecov.io/gh/tuture-dev/editure)\n\nEditure is a richtext markdown editor built on top of [Slate](https://www.slatejs.org/), with out-of-the-box support for markdown **shortcuts**, **hotkeys**, **serialization**. It aims to provide editing experience on par with [Typora](https://typora.io/) or [Yuque](https://www.yuque.com/).\n\n\u003e Warning: Editure is currently experimental. DO NOT USE IT IN PRODUCTION!\n\n## Highlights\n\n- **Hotkeys**: e.g. toggle bold font with `Ctrl+B` or `Cmd+B`\n- **Shortcuts**: trigger the full rendering of Markdown as you are typing\n- **Toolbar**: a toolbar for adjusting format with buttons\n\n## Supported Formats\n\nMarks: **bold**, _italic_, \u003cspan style=\"text-decoration: underline; \"\u003eunderline\u003c/span\u003e, ~~strikethrough~~ and [link](https://tuture.co).\n\nBlocks: paragraphs, headings, blockquotes, code blocks, note blocks, bulleted lists, numbered lists, images, and horizontal lines.\n\n## Installation\n\n```bash\nnpm install editure editure-react\n# or if you prefer yarn:\nyarn add editure editure-react\n```\n\n## Getting Started\n\n### Using the Component\n\nA quick demo:\n\n```javascript\nimport Editure from 'editure-react';\n\nclass MyComponent extends React.Component {\n  constructor(props) {\n    super(props);\n    this.state = { value: [] };\n  }\n\n  handleChange = (value) =\u003e {\n    this.setState({ value });\n  };\n\n  render() {\n    return \u003cEditure value={this.state.value} onChange={this.handleChange} /\u003e;\n  }\n}\n```\n\nOr, if you prefer [Hooks](https://reactjs.org/docs/hooks-intro.html):\n\n```javascript\nimport Editure from 'editure-react';\n\nfunction MyComponent() {\n  const [value, setValue] = useState([]);\n  return \u003cEditure value={value} onChange={setValue} /\u003e;\n}\n```\n\n### Content Serialization\n\nAs in Slate, the `value` prop is a plain JavaScript object. You can perform serialization with `JSON` global object:\n\n```javascript\n// serialize to JSON\nconst serialized = JSON.stringify(value);\n\n// parse from JSON\nconst value = JSON.stringify(serialized);\n```\n\nMoreover, Editure provides serialization support for HTML and Markdown, for example:\n\n```javascript\nimport { toHtml, toMarkdown, parseHtml, parseMarkdown } from 'editure';\n\n// serialize to HTML\nconst htmlString = toHtml(value);\n\n// parse from HTML\nconst value = parseHtml(htmlString);\n\n// serialize to Markdown\nconst markdownString = toMarkdown(value);\n\n// parse from Markdown\nconst value = parseMarkdown(markdownString);\n```\n\n## API Reference\n\n### `editure`\n\nThe `editure` package provides low-level utilities to work with Slate.\n\n### `editure-react`\n\nHere is a full list of props from `Editure` component:\n\n- `value`: the current value of the editor\n- `onChange`: handler called after the content changed\n- `placeholder`: placeholder string for the editor\n- `readOnly`: if `true`, the editor won't allow changing its contents.\n\n## LICENSE\n\nMIT.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftuture-dev%2Fediture","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftuture-dev%2Fediture","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftuture-dev%2Fediture/lists"}