Megadraft  

Rich Text editor built on top of Facebook's draft.js

Discussion and Support

Join the [#megadraft][megadraft-slack] channel on the DraftJS [Slack team][draftjs-slack]!

Live Example & Documentation

Checkout our website with a live demo!

Developing

To run the development server and see the examples:

``
git clone https://github.com/globocom/megadraft.git
cd megadraft/
make setup
make run
`

> Note: make sure you're using node <14

Then visit http://localhost:8080/#/ on your browser.

To run local tests:

`
make unit
`

To lint local source files:

`
make lint
`

To run tests and lint:

`
make test
``

Dependencies

Megadraft depends on Sass to build style assets.

Importing the default styles

Megadraft ships with a default styling available at this location in the installed package: node_modules/megadraft/dist/css/megadraft.css.

Documentation

- [Overview & Usage][docs-overview-and-usage]
- [Customization][docs-customization]
- [Custom Entities][docs-custom-entities]
- [Plugins][docs-plugins]
- [Saving & Loading][docs-saving-loading]

Plugins

Check out the [docs][docs-plugins] for information about plugin structure.
To help in this process there is a [Yeoman Megadraft Plugin Generator][plugin-generator].

Contributing

Development of Megadraft happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Megadraft.

$3

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Megadraft.

License

Megadraft is licensed under the MIT license.

Third Party

The Megadraft website uses a picture from
Stocksnap.io by Tim Marshall licensed
under CC0 license.

The Landing page uses a Megadeth picture by Ted Van Pelt
licensed under CC-BY.

[plugin-generator]: https://github.com/globocom/generator-megadraft-plugin
[docs-overview-and-usage]: http://globocom.github.io/megadraft/#/docs/overview
[docs-customization]: http://globocom.github.io/megadraft/#/docs/customization
[docs-custom-entities]: http://globocom.github.io/megadraft/#/docs/custom-entities
[docs-plugins]: http://globocom.github.io/megadraft/#/docs/plugins
[docs-saving-loading]: http://globocom.github.io/megadraft/#/docs/saving-loading
[megadraft-slack]: https://draftjs.slack.com/messages/megadraft/
[draftjs-slack]: https://draftjs.herokuapp.com