Getting started
To get started with bangle.dev you need to install the core module:
#
With ReactBangle at its heart is framework agnostic, but it comes with first party support for React. To get started, run the follow command:
❤️ Support for Vue is coming soon. Meanwhile you can either use vanilla Bangle Components or consider tiptap an awesome library which runs the same Prosemirror blood in its veins!
#
StabilityCurrent:
- Bangle is currently in
alpha
phase and we plan to iterate fast, bug fixes and many breaking changes. I would request you to try it out and use it in your side projects but avoid using it in production.
Short term:
- Once we achieve a good stable month with
beta
with some community adoption, we can move to general release. I expect this to come around March or April.
#
The Bangle eco-systemThe Bangle project is made up of smaller individual packages to fit a particular scoped need. You can find their documentation under the API section of the sidebar. Please keep the following things in mind when consuming any of the Bangle packages:
Only the packages with names starting
@bangle.dev/react-
require a React dependency.Certain packages have a peer dependency on other Bangle packages, your package manager should help you install them.
If a package has a stylesheet, it will always under a file named
style.css
and can be imported by doingimport @bangle.dev/xyz-module/style.css
.