Rouge syntax highlighter 使用教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00206/article/details/147291045

Rouge syntax highlighter 使用教程

rouge A pure Ruby code highlighter that is compatible with Pygments 项目地址: https://gitcode.com/gh_mirrors/ro/rouge

1. 项目介绍

Rouge 是一个纯 Ruby 编写的语法高亮器。它支持超过 200 种不同的语言，并且能够输出 HTML 或 ANSI 256 色文本。Rouge 的 HTML 输出与 Pygments 的样式表兼容。

2. 项目快速启动

首先，确保你的系统中已经安装了 Ruby。然后，可以通过以下方式安装 Rouge：

gem install rouge

或者，如果你使用的是 Bundler，可以在你的 Gemfile 中添加：

gem 'rouge'

然后执行 bundle install 命令。

使用 Rouge 作为 Ruby 库

以下是一个使用 Rouge 作为 Ruby 库的快速示例：

require 'rouge'

# 读取要高亮的源代码
source = File.read('/etc/bashrc')

# 创建一个 HTML 格式化器和一个 Shell 语法解析器
formatter = Rouge::Formatters::HTML.new
lexer = Rouge::Lexers::Shell.new

# 进行高亮处理并输出结果
highlighted_code = formatter.format(lexer.lex(source))
puts highlighted_code

使用 Rouge 作为命令行工具

Rouge 还提供了一个命令行工具 rougify，你可以通过以下方式高亮文件：

rougify foo.rb

或者输出 CSS 样式：

rougify style monokai.sublime > syntax.css

3. 应用案例和最佳实践

Jekyll 集成

Rouge 是 Jekyll 默认的语法高亮器。在 Jekyll 中，你可以使用 {% highlight %} 模板标签来高亮代码。例如：

{% highlight ruby %}
def hello
  puts "Hello, World!"
end
{% endhighlight %}

自定义 HTML 格式化器

如果你需要自定义 HTML 输出格式，可以创建一个继承自 Rouge::Formatters::HTML 的类，并覆盖相应的方法：

class MyFormatter < Rouge::Formatters::HTML
  def stream(tokens, &block)
    yield "<div class='my-outer-div'>"
    tokens.each do |token, value|
      yield span(token, value)
    end
    yield "</div>"
  end

  def safe_span(token, safe_value)
    if token == Token::Tokens::Text
      safe_value
    else
      "<span class=\"#{token.shortname}\">#{safe_value}</span>"
    end
  end
end