Speech Synthesis Markdown (SSMD) is a lightweight alternative syntax for SSML.
This repository contains both the reference implementation of the SSMD-to-SSML conversion tool (
ssmd) as well
as the specification of the language.
The tools and executable specification provided in this repository require Ruby 2.3.4 or better.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install ssmd
You can convert SSML to SSMD using
require 'ssmd' ssmd = "hello *SSMD*!" ssml = SSMD.to_ssml ssmd puts ssml # Output: <speak>hello <emphasis>SSMD</emphasis>!</speak>
Sometimes you will want to see just the plain text without any SSMD annotations.
For this you can use
require 'ssmd' ssmd = "[hallo](de) *SSMD*!" plain_text = SSMD.strip_ssmd ssmd puts plain_text # Output: hallo SSMD!
This version is still under development. See below which essential SSML constructs are implemented so far:
After checking out the repo, run
bin/setup to install dependencies. You can run
bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run
bundle exec rake install. To release a new version, update the version number in
version.rb, and then run
bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the
.gem file to rubygems.org.
rake spec to run the tests against a given executable.
This implementation and any other can be tested against the SSMD specification.
Said specification is extracted from
It runs each SSMD snippet through the tested tool and compares it to the output of
the following SSML snippet. If they match the test passes.
Bug reports and pull requests are welcome on GitHub at https://github.com/machisuji/ssmd. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.