Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.28 KB

README.md

File metadata and controls

29 lines (19 loc) · 1.28 KB

Banger Editor: ProseMirror Made Easy

Banger Editor aims to provide missing pieces of ProseMirror components so you don't have to build them from scratch. And trust me, you don't want to build them from scratch.

Why Banger Editor?

  • 🔋 Batteries Included: Everything you need to get started with ProseMirror.
  • 🕸️ Framework Agnostic: Vanilla JS at its core, but works great with React. Vue support coming soon!
  • 👍 Pure ProseMirror: No extra abstractions, just pure ProseMirror. Compatible with libraries like tiptap, milkdown, and novel.
  • 🛠️ Headless & Customizable: Use our shadcn/ui-like components or build your own.

Getting Started

npm install banger-editor

Note

Example Repo: banger-vite-react-starter

Peer Dependencies

Banger Editor uses ProseMirror packages directly. You'll need to install the ones you need.

New to ProseMirror? Install these:

npm install orderedmap prosemirror-commands prosemirror-dropcursor prosemirror-flat-list prosemirror-gapcursor prosemirror-history prosemirror-inputrules prosemirror-keymap prosemirror-model prosemirror-schema-basic prosemirror-state prosemirror-transform prosemirror-view