module Kramdown::Converter::SyntaxHighlighter::Rouge
Uses Rouge which is CSS-compatible to Pygments to highlight code blocks and code spans.
Constants
- AVAILABLE
Highlighting via
Rougeis available if this constant istrue.
Public Class Methods
call(converter, text, lang, type, call_opts)
click to toggle source
# File lib/kramdown/converter/syntax_highlighter/rouge.rb 53 def self.call(converter, text, lang, type, call_opts) 54 opts = options(converter, type) 55 call_opts[:default_lang] = opts[:default_lang] 56 return nil unless lang || opts[:default_lang] || opts[:guess_lang] 57 58 lexer = ::Rouge::Lexer.find_fancy(lang || opts[:default_lang], text) 59 return nil if opts[:disable] || !lexer || (lexer.tag == "plaintext" && !opts[:guess_lang]) 60 61 opts[:css_class] ||= 'highlight' # For backward compatibility when using Rouge 2.0 62 formatter = formatter_class(opts).new(opts) 63 formatter.format(lexer.lex(text)) 64 end
formatter_class(opts = {})
click to toggle source
# File lib/kramdown/converter/syntax_highlighter/rouge.rb 97 def self.formatter_class(opts = {}) 98 case formatter = opts[:formatter] 99 when Class 100 formatter 101 when /\A[[:upper:]][[:alnum:]_]*\z/ 102 ::Rouge::Formatters.const_get(formatter, false) 103 else 104 HTMLLegacy 105 end 106 rescue NameError 107 # Fallback to Rouge 1.x 108 ::Rouge::Formatters::HTML 109 end
normalize_keys(hash)
click to toggle source
# File lib/kramdown/converter/syntax_highlighter/rouge.rb 89 def self.normalize_keys(hash) 90 return if hash.empty? 91 92 hash.keys.each do |k| 93 hash[k.kind_of?(String) ? Kramdown::Options.str_to_sym(k) : k] = hash.delete(k) 94 end 95 end
options(converter, type)
click to toggle source
# File lib/kramdown/converter/syntax_highlighter/rouge.rb 66 def self.options(converter, type) 67 prepare_options(converter) 68 converter.data[:syntax_highlighter_rouge][type] 69 end
prepare_options(converter)
click to toggle source
# File lib/kramdown/converter/syntax_highlighter/rouge.rb 71 def self.prepare_options(converter) 72 return if converter.data.key?(:syntax_highlighter_rouge) 73 74 cache = converter.data[:syntax_highlighter_rouge] = {} 75 76 opts = converter.options[:syntax_highlighter_opts].dup 77 78 span_opts = opts.delete(:span)&.dup || {} 79 block_opts = opts.delete(:block)&.dup || {} 80 normalize_keys(span_opts) 81 normalize_keys(block_opts) 82 83 cache[:span] = opts.merge(span_opts) 84 cache[:span][:wrap] = false 85 86 cache[:block] = opts.merge(block_opts) 87 end