https://github.com/truemedia/turndown-ssml
Convert SSML into markdown files, useful for bots that utilise both voice and text chat
https://github.com/truemedia/turndown-ssml
Last synced: 3 months ago
JSON representation
Convert SSML into markdown files, useful for bots that utilise both voice and text chat
- Host: GitHub
- URL: https://github.com/truemedia/turndown-ssml
- Owner: Truemedia
- License: mit
- Created: 2018-09-09T10:49:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-09-09T11:59:15.000Z (over 6 years ago)
- Last Synced: 2025-02-13T05:14:41.727Z (3 months ago)
- Language: JavaScript
- Size: 6.84 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Turndown SSML
A [Turndown](https://github.com/domchristie/turndown) plugin to convert [SSML](https://en.wikipedia.org/wiki/Speech_Synthesis_Markup_Language) into markdown files, useful for bots that utilize both voice and text chat
## Installation
NPM
```bash
npm i --save turndown-ssml
```
Yarn
```bash
yarn add turndown-ssml
```
## Usage
Node
```js
const turndownSsmlPlugin = require('turndown-ssml');
turndownService.use(turndownSsmlPlugin.ssml);
```
ES6+
```js
import turndownSsmlPlugin from 'turndown-ssml';
turndownService.use(turndownSsmlPlugin.ssml);
```
## Tag support
- [speak](https://developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html#speak) - Replaced with nothing
- [s](https://developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html#s) - Adds a new line before and after content
- [break](https://developer.amazon.com/docs/custom-skills/speech-synthesis-markup-language-ssml-reference.html#break) - Depending on strength attribute replaces with nothing, a comma, or ellipsis
If there is a tag not yet supported it just means we haven't got around to adding an implementation yet. Contributions and maintainers welcome.