{"id":13418015,"url":"https://github.com/machisuji/ssmd","last_synced_at":"2025-06-24T06:02:08.192Z","repository":{"id":59156281,"uuid":"90958922","full_name":"machisuji/ssmd","owner":"machisuji","description":"Speech Synthesis Markdown (SSMD) is a lightweight alternative syntax for SSML.","archived":false,"fork":false,"pushed_at":"2019-07-13T21:21:51.000Z","size":53,"stargazers_count":20,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-27T23:02:22.855Z","etag":null,"topics":["ssml"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/machisuji.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-05-11T08:58:56.000Z","updated_at":"2024-04-24T21:57:21.000Z","dependencies_parsed_at":"2022-09-13T20:03:29.165Z","dependency_job_id":null,"html_url":"https://github.com/machisuji/ssmd","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/machisuji%2Fssmd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/machisuji%2Fssmd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/machisuji%2Fssmd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/machisuji%2Fssmd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/machisuji","download_url":"https://codeload.github.com/machisuji/ssmd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248456381,"owners_count":21106605,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ssml"],"created_at":"2024-07-30T22:00:57.129Z","updated_at":"2025-04-14T09:42:06.198Z","avatar_url":"https://github.com/machisuji.png","language":"Ruby","funding_links":[],"categories":["Other Markdown Alternative Projects"],"sub_categories":[],"readme":"# SSMD\n\n[![Build Status](https://travis-ci.org/machisuji/ssmd.svg?branch=master)](https://travis-ci.org/machisuji/ssmd)\n\nSpeech Synthesis Markdown (SSMD) is a lightweight alternative syntax for [SSML](https://www.w3.org/TR/speech-synthesis/).\nThis repository contains both the reference implementation of the SSMD-to-SSML conversion tool (`ssmd`) as well\nas the [specification](SPECIFICATION.md) of the language.\n\n## Requirements\n\nThe tools and executable specification provided in this repository require **Ruby 2.3.4** or better.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'ssmd'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install ssmd\n\n## Usage\n\nYou can convert SSML to SSMD using `SSMD::to_ssml`:\n\n```ruby\nrequire 'ssmd'\n\nssmd = \"hello *SSMD*!\"\nssml = SSMD.to_ssml ssmd\n\nputs ssml\n# Output: \u003cspeak\u003ehello \u003cemphasis\u003eSSMD\u003c/emphasis\u003e!\u003c/speak\u003e\n```\n\nSometimes you will want to see just the plain text without any SSMD annotations.\nFor this you can use `SSMD::stip_ssmd`:\n\n```ruby\nrequire 'ssmd'\n\nssmd = \"[hallo](de) *SSMD*!\"\nplain_text = SSMD.strip_ssmd ssmd\n\nputs plain_text\n# Output: hallo SSMD!\n```\n\n**Note:**\n\nThis version is still under development. See below which essential SSML constructs are implemented so far:\n\n* [x] Text\n* [x] Emphasis\n* [x] Break\n* [x] Language\n* [x] Mark\n* [x] Paragraph\n* [x] Phoneme\n* [x] Prosody\n* [ ] Say-as\n* [x] Substitution\n* [ ] Extensions\n\n## Development\n\nAfter 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.\n\nTo 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](https://rubygems.org).\n\n### Tests\n\nRun `rake spec` to run the tests against a given executable.\n\nThis implementation and any other can be tested against the SSMD specification.\nSaid specification is extracted from `SPECIFICATION.md`.\nIt runs each SSMD snippet through the tested tool and compares it to the output of\nthe following SSML snippet. If they match the test passes.\n\n## Contributing\n\nBug 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](http://contributor-covenant.org) code of conduct.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n## Related projects\n\n### SSMD (JS)\n\nFollows the SSMD [specification]((SPECIFICATION.md)).\n\nSource: https://github.com/fabien88/ssmd\n\n### Speech Markdown\n\nSpeech Markdown has their own specification which is different than SSMD.\n\nWebsite: https://www.speechmarkdown.org/\nSource: https://github.com/speechmarkdown/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmachisuji%2Fssmd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmachisuji%2Fssmd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmachisuji%2Fssmd/lists"}