|
21 | 21 | <img src="https://img.shields.io/github/last-commit/vueup/vue-quill?logo=github" alt="Last commit"> |
22 | 22 | </a> |
23 | 23 | </p> |
24 | | - |
25 | | -## Overview |
| 24 | + |
| 25 | + [](https://vueup.github.io/vue-quill/#demo) |
| 26 | + |
| 27 | + <p align="center"> |
| 28 | + <a href="https://vueup.github.io/vue-quill/#demo" target="_blank" rel="noopener noreferrer">👀 See a Live Demo</a> |
| 29 | + </p> |
| 30 | + |
| 31 | +## 🔎 Overview |
26 | 32 |
|
27 | 33 | **VueQuill** is a **Component** for building rich text editors, powered by Vue 3 and Quill. |
28 | 34 |
|
29 | 35 | - 💚 **Built With Vue 3:** More powerful and performant framework than ever before. |
30 | 36 | - 🧙♂️ **Fully Typescript:** VueQuill source code is written entirely in TypeScript. |
31 | 37 | - 🛠️ **Easy To Use:** Straightforward implementation through a simple API. |
32 | 38 |
|
33 | | -[👀 See a Live Demo](https://vueup.github.io/vue-quill/#demo). |
34 | | - |
35 | | -[📘 Read the Docs to Learn More.](https://vueup.github.io/vue-quill/guide/) |
| 39 | +> 🚀 **VueQuill** is in **@beta** version! Currently the focus is on making VueQuill stable and feature complete first. Some of its features are not "finalized" and will have breaking changes over time as we discover better solutions. |
36 | 40 |
|
37 | | -> 🚀 **VueQuill** is in **@beta** version! Currently the focus is on making VueQuill stable and feature complete first. It is not recommended to use this for anything serious yet. Some of its features are not "finalized" and will have breaking changes over time as we discover better solutions. |
| 41 | +## 📚 Documentation |
38 | 42 |
|
39 | | -> 🧑🤝🧑 **VueQuill** is also contributor-driven. It is not backed by any huge company, which means that all contributions are voluntary and done by the people who need them. If you need something improved, added, or fixed, please contribute it yourself or no one will. |
| 43 | +- **[📘 Guide](https://vueup.github.io/vue-quill/guide/)** |
| 44 | + - [🚀 Introduction](https://vueup.github.io/vue-quill/guide/) |
| 45 | + - [⚙️ Installation](https://vueup.github.io/vue-quill/guide/installation.html) |
| 46 | + - [💡 Usage](https://vueup.github.io/vue-quill/guide/usage.html) |
| 47 | + - [🎨 Themes](https://vueup.github.io/vue-quill/guide/themes.html) |
| 48 | + - [🚥 Toolbar](https://vueup.github.io/vue-quill/guide/toolbar.html) |
| 49 | + - [📦 Modules](https://vueup.github.io/vue-quill/guide/modules.html) |
| 50 | + - [🛠️ Options](https://vueup.github.io/vue-quill/guide/options.html) |
| 51 | + |
| 52 | +- **[🧰 APIs](https://vueup.github.io/vue-quill/api/)** |
| 53 | + - [📌 Props](https://vueup.github.io/vue-quill/api/) |
| 54 | + - [⚡ Events](https://vueup.github.io/vue-quill/api/events.html) |
| 55 | + - [📢 Methods](https://vueup.github.io/vue-quill/api/methods.html) |
| 56 | + - [🔌 Slots](https://vueup.github.io/vue-quill/api/slots.html) |
| 57 | + - [↗️ Export](https://vueup.github.io/vue-quill/api/export.html) |
40 | 58 |
|
41 | | -## To do list |
| 59 | +## ☑️ To do list |
42 | 60 |
|
43 | 61 | - [x] Release `alpha` version |
44 | 62 | - [x] Release `beta` version |
45 | 63 | - [ ] Stable `v1.0.0` release |
46 | 64 | - [x] Enhance Typescript support with Vue 3 |
47 | 65 | - [ ] Update the Documentation with more examples and more information |
48 | 66 |
|
49 | | -## Demo |
50 | | -- [See a Live Demo](https://vueup.github.io/vue-quill/#demo). |
51 | | - |
52 | | - [](https://vueup.github.io/vue-quill/#demo) |
| 67 | +## 👏 Contributing |
53 | 68 |
|
54 | | -## Documentation |
55 | | -- **[Guide](https://vueup.github.io/vue-quill/guide/)** |
56 | | - - [Introduction](https://vueup.github.io/vue-quill/guide/) |
57 | | - - [Installation](https://vueup.github.io/vue-quill/guide/installation.html) |
58 | | - - [Usage](https://vueup.github.io/vue-quill/guide/usage.html) |
59 | | - - [Themes](https://vueup.github.io/vue-quill/guide/themes.html) |
60 | | - - [Toolbar](https://vueup.github.io/vue-quill/guide/toolbar.html) |
61 | | - - [Modules](https://vueup.github.io/vue-quill/guide/modules.html) |
62 | | - - [Options](https://vueup.github.io/vue-quill/guide/options.html) |
63 | | - |
64 | | -- **[APIs](https://vueup.github.io/vue-quill/api/)** |
65 | | - - [Props](https://vueup.github.io/vue-quill/api/) |
66 | | - - [Events](https://vueup.github.io/vue-quill/api/events.html) |
67 | | - - [Methods](https://vueup.github.io/vue-quill/api/methods.html) |
68 | | - - [Slots](https://vueup.github.io/vue-quill/api/slots.html) |
69 | | - - [Export](https://vueup.github.io/vue-quill/api/export.html) |
70 | | - |
71 | | -## Contributing |
72 | 69 | Pull requests are welcome. For major changes, please create a [new discussion](https://github.com/vueup/vue-quill/discussions) first about what you would like to change. |
73 | 70 |
|
74 | | -## License |
| 71 | +## 📝 License |
| 72 | + |
75 | 73 | [MIT](https://choosealicense.com/licenses/mit/) |
0 commit comments