module Kramdown::Converter::SyntaxHighlighter::Rouge

Uses Rouge which is CSS-compatible to Pygments to highlight code blocks and code spans.

Constants

AVAILABLE

Highlighting via Rouge is available if this constant is true.

Public Class Methods

call(converter, text, lang, type, call_opts) click to toggle source
# File lib/kramdown/converter/syntax_highlighter/rouge.rb, line 23
def self.call(converter, text, lang, type, call_opts)
  opts = options(converter, type)
  call_opts[:default_lang] = opts[:default_lang]
  return nil unless lang || opts[:default_lang] || opts[:guess_lang]

  lexer = ::Rouge::Lexer.find_fancy(lang || opts[:default_lang], text)
  return nil if opts[:disable] || !lexer || (lexer.tag == "plaintext" && !opts[:guess_lang])

  opts[:css_class] ||= 'highlight' # For backward compatibility when using Rouge 2.0
  formatter = formatter_class(opts).new(opts)
  formatter.format(lexer.lex(text))
end
formatter_class(opts = {}) click to toggle source
# File lib/kramdown/converter/syntax_highlighter/rouge.rb, line 67
def self.formatter_class(opts = {})
  case formatter = opts[:formatter]
  when Class
    formatter
  when /\A[[:upper:]][[:alnum:]_]*\z/
    ::Rouge::Formatters.const_get(formatter)
  else
    # Available in Rouge 2.0 or later
    ::Rouge::Formatters::HTMLLegacy
  end
rescue NameError
  # Fallback to Rouge 1.x
  ::Rouge::Formatters::HTML
end
normalize_keys(hash) click to toggle source
# File lib/kramdown/converter/syntax_highlighter/rouge.rb, line 59
def self.normalize_keys(hash)
  return if hash.empty?

  hash.keys.each do |k|
    hash[k.kind_of?(String) ? Kramdown::Options.str_to_sym(k) : k] = hash.delete(k)
  end
end
options(converter, type) click to toggle source
# File lib/kramdown/converter/syntax_highlighter/rouge.rb, line 36
def self.options(converter, type)
  prepare_options(converter)
  converter.data[:syntax_highlighter_rouge][type]
end
prepare_options(converter) click to toggle source
# File lib/kramdown/converter/syntax_highlighter/rouge.rb, line 41
def self.prepare_options(converter)
  return if converter.data.key?(:syntax_highlighter_rouge)

  cache = converter.data[:syntax_highlighter_rouge] = {}

  opts = converter.options[:syntax_highlighter_opts].dup

  span_opts = opts.delete(:span)&.dup || {}
  block_opts = opts.delete(:block)&.dup || {}
  normalize_keys(span_opts)
  normalize_keys(block_opts)

  cache[:span] = opts.merge(span_opts)
  cache[:span][:wrap] = false

  cache[:block] = opts.merge(block_opts)
end