# rich-voice-editor
Rich Voice Editor: Quill Rich Text Editor Enhancements to support [SSML](https://developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html)
With this module you can enhance the Quill Rich Text Editor https://quilljs.com/ to support SSML tags.
The following SSML tags / functions are supported: [SSML Tags and Functions](https://github.com/fabiancelik/rich-voice-editor/wiki/SSML-Tags-and-Functions)
The current functionality is optimized for [AWS Polly](https://aws.amazon.com/polly/) with special [Amazon SSML Tags](https://docs.aws.amazon.com/polly/latest/dg/supported-ssml.html)
Live Demo: https://fabiancelik.github.io/rich-voice-editor/
Try on jsfiddle: https://jsfiddle.net/fabiancelik/opa6cbj4/16/
## Installation
Use the CDN link https://cdn.jsdelivr.net/npm/quill-rich-voice-editor@0.4.0/dist/richVoiceEditor.min.js
```html
```
Or use the package manager [npm](https://www.npmjs.com/) to install rich-voice-editor.
```bash
npm install quill-rich-voice-editor
```
```html
```
URL to npm package: https://www.npmjs.com/package/quill-rich-voice-editor
## Usage
1. Please check the official Quill documentation for the basics first: https://quilljs.com/docs/quickstart/
2. Include the richVoiceEditor.min.js via CDN or NPM in a script-tag.
3. Add containters and handlers for every tag/function you want to use.
3. Register the module to the Quill Editor.
4. Set 'rich-voice-editor' in modules to true.
```html
Rich Voice Editor - Example
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
To create the production build after changes in /src/index.js please use the following commands:
```shell
npm i
npm run-script build
```
Please see the Wiki to learn more [how to add more SSML Tags](https://github.com/fabiancelik/rich-voice-editor/wiki/Implement-more-SSML-Tags). I would especially appreciate a better [Amazon Alexa](https://developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html#ssml-supported) support.
## License
[MIT](https://choosealicense.com/licenses/mit/)
# rich-voice-editor
Rich Voice Editor: Quill Rich Text Editor Enhancements to support [SSML](https://developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html)
With this module you can enhance the Quill Rich Text Editor https://quilljs.com/ to support SSML tags.
The following SSML tags / functions are supported: [SSML Tags and Functions](https://github.com/fabiancelik/rich-voice-editor/wiki/SSML-Tags-and-Functions)
The current functionality is optimized for [AWS Polly](https://aws.amazon.com/polly/) with special [Amazon SSML Tags](https://docs.aws.amazon.com/polly/latest/dg/supported-ssml.html)
Live Demo: https://fabiancelik.github.io/rich-voice-editor/
Try on jsfiddle: https://jsfiddle.net/fabiancelik/opa6cbj4/16/
## Installation
Use the CDN link https://cdn.jsdelivr.net/npm/quill-rich-voice-editor@0.4.0/dist/richVoiceEditor.min.js
```html
```
Or use the package manager [npm](https://www.npmjs.com/) to install rich-voice-editor.
```bash
npm install quill-rich-voice-editor
```
```html
```
URL to npm package: https://www.npmjs.com/package/quill-rich-voice-editor
## Usage
1. Please check the official Quill documentation for the basics first: https://quilljs.com/docs/quickstart/
2. Include the richVoiceEditor.min.js via CDN or NPM in a script-tag.
3. Add containters and handlers for every tag/function you want to use.
3. Register the module to the Quill Editor.
4. Set 'rich-voice-editor' in modules to true.
```html