UNPKG

megadraft

Version:

Rich Text editor built on top of draft.js

github.com/globocom/megadraft

globocom/megadraft

96 lines (61 loc) • 3.06 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# Megadraft [![Build Status](https://secure.travis-ci.org/globocom/megadraft.png?branch=master)](https://travis-ci.org/globocom/megadraft) [![npm version](https://img.shields.io/npm/v/megadraft.svg?style=flat)](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](http://globocom.github.io/megadraft/)! ## 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]: 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