Project

slackdown

0.01
No commit activity in last 3 years
No release in over 3 years
A converter for Kramdown that converts GitHub-Flavored Markdown to Slack's simplified Markdown
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

Slackdown

Slackdown converts Markdown to Slack's simpler markup syntax.

Slackdown implements a converter for kramdown.

Usage

require "slackdown"

Slackdown.convert(markdown_text)

If you're familiar with Kramdown, you can also do:

require "kramdown/converter/slack"

Kramdown::Document.new(markdown_text, options).to_slack

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/houston/slackdown.

License

The gem is available as open source under the terms of the MIT License.