Skip to content

react-markedit 0.1.0

Latest

Choose a tag to compare

@github-actions github-actions released this 10 Nov 21:31
· 1 commit to main since this release

react-markedit 0.1.0

The first public package release of MarkEdit's React editor and preview components.

Install

npm install react-markedit react@^19 react-dom@^19

Import react-markedit/style.css once in your application. The package is ESM-only and targets React 19 applications with a browser-capable bundler.

Included

  • Controlled and uncontrolled Markdown editors, a standalone preview, read-only mode, themes, configurable toolbar, and ref commands.
  • GFM tables and tasks, KaTeX formulas, Mermaid diagrams, and on-demand code highlighting.
  • Link, image, code, and table insertion dialogs; host-provided image upload callbacks.
  • Heading navigation metadata through getHeadings and MarkdownPreview.onHeadings, plus synchronized scrolling.
  • Scoped CSS, TypeScript declarations, English interface, and MIT license.

Integration notes

Keep controlled value updates synchronous in onChange. Persistence belongs to the host application. Image uploads require the host's uploadImage callback. The separate workspace uses IndexedDB but the package does not.

Raw HTML and nonstandard Markdown dialects are not rendered. Embedded HTML language completion is not loaded by default. Formula and diagram resources load on demand. SSR framework integrations, real-device IME coverage, and offline cold starts are not guaranteed by this release.

Long documents still produce synchronous rendering tasks. See the repository performance report for measurements and limits.

An upstream math-parser dependency still resolves an older KaTeX with a low-severity advisory. The editor renders with the patched direct dependency; see the package README for the application-level override used by the tested example.