# Highlighting

Highlighting is based on [PrismJS](http://prismjs.com).

> Prism is a lightweight, robust, elegant syntax highlighting library. It's a spin-off project from Dabblet.

To use highlighting, please read this [stackoverflow post](http://stackoverflow.com/a/34373693/388280)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'highlighting'
```

And then execute:

```
$ bundle
```

Or install it yourself as:

```
$ gem install highlighting
```

## Usage

```
<pre>
<code class="language-ruby">
   <!-- type any ruby code you like -->
</code>
</pre>

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ytbryan/highlighting. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

## License

Highlighting is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).