Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/globocom/megadraft
Megadraft is a Rich Text editor built on top of Facebook's Draft.JS featuring a nice default base of components and extensibility
https://github.com/globocom/megadraft
contenteditable draft-js editor hacktoberfest javascript megadraft react reactjs rich-text-editor wysiwyg wysiwyg-editor
Last synced: 7 days ago
JSON representation
Megadraft is a Rich Text editor built on top of Facebook's Draft.JS featuring a nice default base of components and extensibility
- Host: GitHub
- URL: https://github.com/globocom/megadraft
- Owner: globocom
- License: mit
- Created: 2016-03-22T21:28:13.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-31T22:36:57.000Z (about 1 year ago)
- Last Synced: 2024-10-29T15:33:22.376Z (about 1 month ago)
- Topics: contenteditable, draft-js, editor, hacktoberfest, javascript, megadraft, react, reactjs, rich-text-editor, wysiwyg, wysiwyg-editor
- Language: JavaScript
- Homepage: http://megadraft.io
- Size: 82.3 MB
- Stars: 1,215
- Watchers: 53
- Forks: 219
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-react-components - megadraft - Rich Text editor built on top of draft.js. (UI Components / Form Components)
- awesome-react - megadraft - Rich Text editor built on top of draft.js.  (UI Components / Form Components)
- awesome-list - megadraft - Rich Text editor built on top of draft.js. (Demos / Form Components)
- awesome-react-components - megadraft - Rich Text editor built on top of draft.js. (UI Components / Form Components)
- awesome-react-components - megadraft - Rich Text editor built on top of draft.js. (UI Components / Form Components)
- awesome-react-components - megadraft - Rich Text editor built on top of draft.js. (UI Components / Form Components)
- best-of-react - GitHub - 14% open · ⏱️ 31.10.2023): (Editor Components)
- fucking-awesome-react-components - megadraft - Rich Text editor built on top of draft.js. (UI Components / Form Components)
- awesome-draft-js - Megadraft - A rich text editor with a nice default base of plugins and extensibility. (Standalone Editors Built on Draft.js)
- starred-awesome - megadraft - Megadraft is a Rich Text editor built on top of Facebook's Draft.JS featuring a nice default base of components and extensibility (JavaScript)
README
# Megadraft
[](https://github.com/globocom/megadraft/actions/workflows/unittest.yml)
[](https://www.npmjs.com/package/megadraft)
Rich Text editor built on top of [Facebook's draft.js](https://github.com/facebook/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](https://megadraft.io/)!
## 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](http://sass-lang.com/) 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.
### [Contributing Guide](CONTRIBUTING.md)
Read our [contributing guide](CONTRIBUTING.md) 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](LICENSE).
## Third Party
The Megadraft website uses a picture from
[Stocksnap.io by Tim Marshall](https://stocksnap.io/photo/K148YZIFJ3) licensed
under [CC0 license](https://stocksnap.io/license).
The Landing page uses a Megadeth picture by [Ted Van Pelt](https://flic.kr/p/7Pr94f)
licensed under [CC-BY](https://creativecommons.org/licenses/by/2.0/).
[plugin-generator]: https://github.com/globocom/generator-megadraft-plugin
[docs-overview-and-usage]: https://megadraft.io/#/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