1 | <h1 align="center">
|
2 | <a href="http://quilljs.com/" title="Quill">Quill Rich Text Editor</a>
|
3 | </h1>
|
4 | <p align="center">
|
5 | <a href="http://quilljs.com/" title="Quill"><img alt="Quill Logo" src="https://quilljs.com/assets/images/logo.svg" width="180"></a>
|
6 | </p>
|
7 | <p align="center">
|
8 | <a title="Quickstart" href="#quickstart"><strong>Quickstart</strong></a>
|
9 | •
|
10 | <a title="Documentation" href="https://quilljs.com/docs/"><strong>Documentation</strong></a>
|
11 | •
|
12 | <a title="Development" href="https://github.com/quilljs/quill/blob/master/.github/DEVELOPMENT.md"><strong>Development</strong></a>
|
13 | •
|
14 | <a title="Contributing" href="https://github.com/quilljs/quill/blob/master/.github/CONTRIBUTING.md"><strong>Contributing</strong></a>
|
15 | •
|
16 | <a title="Interactive Playground" href="https://quilljs.com/playground/"><strong>Interactive Playground</strong></a>
|
17 | </p>
|
18 | <p align="center">
|
19 | <a href="https://travis-ci.org/quilljs/quill" title="Build Status">
|
20 | <img src="https://travis-ci.org/quilljs/quill.svg?branch=master" alt="Build Status">
|
21 | </a>
|
22 | <a href="https://npmjs.com/package/quill" title="Version">
|
23 | <img src="https://img.shields.io/npm/v/quill.svg" alt="Version">
|
24 | </a>
|
25 | <a href="https://npmjs.com/package/quill" title="Downloads">
|
26 | <img src="https://img.shields.io/npm/dm/quill.svg" alt="Downloads">
|
27 | </a>
|
28 | </p>
|
29 | <p align="center">
|
30 | <a href="https://saucelabs.com/u/quill" title="Test Status">
|
31 | <img src="https://cdn.quilljs.com/badge.svg?v=2" alt="Test Status">
|
32 | </a>
|
33 | </p>
|
34 |
|
35 | Quill is a modern rich text editor built for compatibility and extensibility. It was created by [Jason Chen](https://twitter.com/jhchen) and [Byron Milligan](https://twitter.com/byronmilligan) and open sourced by [Salesforce.com](http://www.salesforce.com).
|
36 |
|
37 | To get started, check out the [Quill website](http://quilljs.com/) for documentation, guides, and live demos!
|
38 |
|
39 |
|
40 | ## Quickstart
|
41 |
|
42 | Instantiate a new Quill object with a css selector for the div that should become the editor.
|
43 |
|
44 | ```html
|
45 | <!-- Include Quill stylesheet -->
|
46 | <link href="https://cdn.quilljs.com/1.0.0/quill.snow.css" rel="stylesheet">
|
47 |
|
48 | <!-- Create the toolbar container -->
|
49 | <div id="toolbar">
|
50 | <button class="ql-bold">Bold</button>
|
51 | <button class="ql-italic">Italic</button>
|
52 | </div>
|
53 |
|
54 | <!-- Create the editor container -->
|
55 | <div id="editor">
|
56 | <p>Hello World!</p>
|
57 | </div>
|
58 |
|
59 | <!-- Include the Quill library -->
|
60 | <script src="https://cdn.quilljs.com/1.0.0/quill.js"></script>
|
61 |
|
62 | <!-- Initialize Quill editor -->
|
63 | <script>
|
64 | var editor = new Quill('#editor', {
|
65 | modules: { toolbar: '#toolbar' },
|
66 | theme: 'snow'
|
67 | });
|
68 | </script>
|
69 | ```
|
70 |
|
71 | Take a look at the [Quill website](https://quilljs.com/) for more documentation, guides and [live playground](https://quilljs.com/playground/)!
|
72 |
|
73 |
|
74 | ## Download
|
75 |
|
76 | - [npm](https://www.npmjs.com/package/quill) - `npm install quill`
|
77 | - tar - https://github.com/quilljs/quill/releases
|
78 |
|
79 |
|
80 | ### CDN
|
81 |
|
82 | ```html
|
83 | <!-- Main Quill library -->
|
84 | <script src="//cdn.quilljs.com/1.0.0/quill.js"></script>
|
85 | <script src="//cdn.quilljs.com/1.0.0/quill.min.js"></script>
|
86 |
|
87 | <!-- Theme included stylesheets -->
|
88 | <link href="//cdn.quilljs.com/1.0.0/quill.snow.css" rel="stylesheet">
|
89 | <link href="//cdn.quilljs.com/1.0.0/quill.bubble.css" rel="stylesheet">
|
90 |
|
91 | <!-- Core build with no theme, formatting, non-essential modules -->
|
92 | <link href="//cdn.quilljs.com/1.0.0/quill.core.css" rel="stylesheet">
|
93 | <script src="//cdn.quilljs.com/1.0.0/quill.core.js"></script>
|
94 | ```
|
95 |
|
96 |
|
97 | ## Community
|
98 |
|
99 | Get help or stay up to date.
|
100 |
|
101 | - [Contribute](https://github.com/quilljs/quill/blob/develop/.github/CONTRIBUTING.md) on [Issues](https://github.com/quilljs/quill/issues)
|
102 | - Follow [@jhchen](https://twitter.com/jhchen) and [@quilljs](https://twitter.com/quilljs) on Twitter
|
103 | - Ask questions on [Stack Overflow](http://stackoverflow.com/questions/tagged/quill)
|
104 | - If privacy is required, email support@quilljs.com
|
105 |
|
106 |
|
107 | ## License
|
108 |
|
109 | BSD 3-clause
|
110 |
|
\ | No newline at end of file |