Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arokettu/commonmarker-rouge

CommonMarker wrapper with Rouge as syntax highlighter
https://github.com/arokettu/commonmarker-rouge

commonmark commonmarker markdown rouge syntax-highlighting

Last synced: about 1 month ago
JSON representation

CommonMarker wrapper with Rouge as syntax highlighter

Awesome Lists containing this project

README

        

# CommonMarker+Rouge

[![Gem](https://img.shields.io/gem/v/commonmarker-rouge.svg?style=flat-square)](https://rubygems.org/gems/commonmarker-rouge)
[![Gitlab pipeline status](https://img.shields.io/gitlab/pipeline/sandfox/commonmarker-rouge/master.svg?style=flat-square)](https://gitlab.com/sandfox/commonmarker-rouge/-/pipelines)

A [CommonMarker](https://rubygems.org/gems/commonmarker) wrapper with
syntax highlight support by [Rouge](https://rubygems.org/gems/rouge).

## IMPORTANT

`commonmarker-rouge` currently works only with renderer in `:UNSAFE` mode.
Don't forget to set `:UNSAFE` manually if you're overwriting the renderer mode.

## Installation

Add these lines to your application's Gemfile:

```ruby
gem 'commonmarker-rouge'
```

## Documentation

Read full documentation here:

## Support

Please file issues on our main repo at GitLab:

## License

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