https://github.com/kramdown/syntax-coderay

kramdown-syntax-coderay uses coderay to highlight code blocks/spans
https://github.com/kramdown/syntax-coderay

coderay kramdown markdown syntax-highlighting

Last synced: about 1 month ago
JSON representation

kramdown-syntax-coderay uses coderay to highlight code blocks/spans

• Host: GitHub
• URL: https://github.com/kramdown/syntax-coderay
• Owner: kramdown
• License: other
• Created: 2019-01-12T10:46:34.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-01-30T17:03:26.000Z (almost 6 years ago)
• Last Synced: 2024-05-09T21:24:46.912Z (8 months ago)
• Topics: coderay, kramdown, markdown, syntax-highlighting
• Language: Ruby
• Size: 10.7 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
# kramdown syntax highlighter based on Coderay

This is a syntax highlighter for [kramdown](https://kramdown.gettalong.org)

that uses [coderay](http://coderay.rubychan.de/) to highlight code blocks and

spans when converting to HTML.

Note: Until kramdown version 2.0.0 this math engine was part of the kramdown

distribution.

## Installation

~~~ruby

gem install kramdown-syntax-coderay

~~~

## Usage

~~~ruby

require 'kramdown'

require 'kramdown-syntax-coderay'

Kramdown::Document.new(text, syntax_highlighter: :coderay).to_html

~~~

## Documentation

To use Coderay, set the option `syntax_highlighter` to 'coderay' and make sure that Coderay is

available. The Coderay library can be installed, e.g., via Rubygems by running `gem install

coderay`.

> Note that the 'coderay_*' options are deprecated and should not be used anymore!

The Coderay syntax highlighter supports the following keys of the option `syntax_highlighter_opts`:

* span:

  A key-value map of options that are only used when syntax highlighting code spans.

* block:

  A key-value map of options that are only used when syntax highlighting code blocks.

* default_lang:

  The default language that should be used when no language is set for a **code block**.

Furthermore all Coderay options (e.g. `css`, `line_numbers`, `line_numbers_start`, `bold_every`,

`tab_width`, `wrap`) can be set directly on the `syntax_highlighter_opts` option (where they apply

to code spans *and* code blocks) and/or on the `span`/`block` keys.

Here is an example that shows how Ruby code is highlighted:

    require 'kramdown'

    Kramdown::Document.new('* something').to_html

    puts 1 + 1

## Development

Clone the git repository and you are good to go. You probably want to install

`rake` so that you can use the provided rake tasks.

## License

MIT - see the **COPYING** file.