thredded-markdown_coderay

Thredded Plugin: Syntax Highlighting in Markdown via Coderay

A Thredded plugin that Highlights code syntax in your Markdown posts via Coderay.

The result with the default styles looks like this:

Code language is not inferred, and must be specified, e.g.:

```ruby
puts 'hi'
```

or

~~~ ruby
puts 'hi'
~~~

Currently only supports the default Thredded markdown parser: Kramdown.

Installation

Add this line to your application's Gemfile:

gem 'thredded-markdown_coderay'

And then execute:

bundle
rails g thredded:markdown_coderay:install

Usage

-

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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/thredded/thredded-markdown_coderay. 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.

License

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