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: 6 months ago
JSON representation

CommonMarker wrapper with Rouge as syntax highlighter

• Host: GitHub
• URL: https://github.com/arokettu/commonmarker-rouge
• Owner: arokettu
• License: mit
• Created: 2016-04-05T21:07:40.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-12-09T08:12:52.000Z (over 1 year ago)
• Last Synced: 2024-10-16T01:28:24.060Z (8 months ago)
• Topics: commonmark, commonmarker, markdown, rouge, syntax-highlighting
• Language: Ruby
• Size: 50.8 KB
• Stars: 3
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

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).