ruby-on-rails - 如何在 Rails 中实现 Rouge 语法高亮？

Question

周围有很多教程，但它们似乎不完整或不完全最新或不完全适合我。

这就是我所做的。

gem 文件:

gem 'rouge'
gem 'redcarpet'

然后我创建了一个 config/initializer/rouge.rb :

require 'rouge/plugins/redcarpet'

然后我创建了一个名为 app/assets/stylesheets/rouge.css.erb 的文件。

<%= Rouge::Themes::Github.render(:scope => '.highlight') %>

然后在我的 app/helpers/application_helper.rb ，我添加了这个:

module ApplicationHelper
  class HTML < Redcarpet::Render::HTML
    include Rouge::Plugins::Redcarpet

    def block_code(code, language)
      Rouge.highlight(code, language || 'text', 'html')
    end
  end

  def markdown(text)
    render_options = {
      filter_html: true,
      hard_wrap: true,
      link_attributes: { rel: 'nofollow' }
    }
    renderer = HTML.new(render_options)

    extensions = {
      autolink: true,
      fenced_code_blocks: true,
      lax_spacing: true,
      no_intra_emphasis: true,
      strikethrough: true,
      superscript: true
    }
    Redcarpet::Markdown.new(renderer, extensions).render(text).html_safe
  end
end

然后在我的 show.html.erb ，我这样做了:

<%= markdown(@question.body) %>

但这实际上是行不通的。它输出我的 ruby像这样的代码片段:



如何让这段代码像 Github 一样格式化？或者甚至只是第一步被格式化，那么我该如何调整格式呢？

我没有看到页面源代码中包含样式表，所以我不知道要调整哪些样式来满足我的需求。

编辑 1

甚至当我这样做时:

            <div class="highlight">
              <%= @question.test_suite %>
            </div>

它呈现如下:



编辑 2

我尝试了 BoraMa 的建议，得到的输出如下所示:



编辑 3

我对 BoraMa 的回答做了如下修改。

在我的 block_code方法，我将highlight称为如下:

Rouge.highlight(code, 'ruby', 'html')

然后在我看来，我这样做:

<%= raw rouge_markdown(<<-'EOF'
                def rouge_me
                  puts "this is a #{'test'} for rouge"
                end
                EOF
                ) %>

然后产生这个:



注意我指的是屏幕截图底部的代码片段。

但是，顶部的文本是这样生成的:

          <pre class="highlight ruby">
            <%= rouge_markdown(@question.body) %>
          </pre>

它的渲染如屏幕截图所示。

编辑 4

删除 <div class="highlight"> 后，我看到了这个:



Aka....根本没有渲染任何东西。

一旦我添加 raw在我看来...又名 <%= raw rouge_markdown(@question.body) %>
该 View 呈现:



编辑 5

这是各种 @question的内容对象:

[1] pry(#<#<Class:0x007fc041b97ce8>>)> @question.body
=> "5.times do\r\n   puts \"Herro Rerl!\"\r\nend"
[1] pry(#<#<Class:0x007fc041b97ce8>>)> @question.body
=> "puts \"Hello World version 9\"\r\nputs \"This comes after version 8.\"\r\nputs \"This comes after version 7.\"\r\nputs \"This comes after version 6.\"\r\nputs \"This comes after version 5.\"\r\nputs \"This comes after version 4.\"\r\nputs \"This comes after version 3.\"\r\nputs \"This comes after version 2.\"\r\nputs \"This definitely comes after version 1.\""

[1] pry(#<#<Class:0x007fc041b97ce8>>)> @question.body
=> "def convert_relation(invited_gender, relation)\r\n case invited_gender\r\n \twhen \"male\"\r\n  \tcase relation\r\n      when \"daughter\", \"son\" then \"dad\"\r\n      when \"mom\", \"dad\" then \"son\"\r\n      when \"grandfather\", \"grandmother\" then \"grandson\"\r\n      when \"sister\", \"brother\" then \"brother\"\r\n      when \"wife\" then \"husband\"\r\n      when \"husband\" then \"husband\"\r\n    end\r\n  when \"female\"\r\n  \tcase relation\r\n      when \"daughter\", \"son\" then \"mom\"\r\n      when \"mom\", \"dad\" then \"daughter\"\r\n      when \"grandfather\", \"grandmother\" then \"granddaughter\"\r\n      when \"sister\", \"brother\" then \"sister\"\r\n      when \"wife\" then \"wife\"\r\n      when \"husband\" then \"wife\"\r\n    end\r\n  end\r\nend\r\n\r\nputs convert_relation(\"male\", \"wife\")"

Answer 1

原始问题表明(在尝试的解决方案中)在突出显示的问题中将使用 Markdown ，但事实并非如此。所以这个答案分为两个不同的部分，一个用于突出显示没有 Markdown 的纯代码，另一个用于带有代码的 Markdown 文本。

A)你想突出显示纯代码(不涉及 Markdown)

在这种情况下，根据 README ，您只需要使用 Rouge 突出显示代码 词法分析器和 格式化程序 .由于突出显示的文本将显示在网页上，因此您需要 HTML formatter .对于词法分析器，您需要事先了解代码所使用的语言(或者您可以尝试从源代码本身猜测它，但对于小代码片段似乎不太可靠)。

您可以为突出显示创建一个简单的辅助方法:

module RougeHelper
  def rouge(text, language)
    formatter = Rouge::Formatters::HTML.new(css_class: 'highlight')
    lexer = Rouge::Lexer.find(language)
    formatter.format(lexer.lex(text))
  end
end

然后在模板中，只需使用要突出显示的文本和语言调用此助手:

<%= raw rouge("def rouge_me\n  puts 'hey!'\nend", "ruby") %>

这将呈现:



获取 Rouge 支持的所有语言列表及其对应的名称应传递给 rouge助手，您可以使用以下代码。代码从 Rouge 获取所有定义的词法分析器并显示它们的标签(即 Rouge 识别它们的名称):

Rouge::Lexer.all.map(&:tag).sort
# => ["actionscript", "apache", "apiblueprint", "applescript", ..., "xml", "yaml"]

在选择框中向用户显示可供选择的语言时，您可以(并且可能应该)使用此列表。请注意，每个词法分析器还具有 title和 desc定义的方法将为您提供一个人类可读的名称和每个方法的简短描述。您可能也希望使用此信息向用户显示。

备注 : 你应该去掉初始化器、自定义 HTML 类和 div包裹在 rouge 助手调用(所有这些你在你最初的尝试中都有)。除了上面的代码，您唯一需要的是 CSS 规则，您已经正确地包含在网页中。

B) 突出显示的文本是带有代码块的 Markdown 文本

您尝试使其工作的一些更改:

不需要初始化程序，我认为您可以将其删除(但如果您不想 require 稍后在助手中的所有文件，我想您可以保留它)。

删除 block_code辅助类中的方法，通过包含 Markdown 插件已经完成了相同的操作。

删除 <div class="highlight">包装 div 从您的模板中，只需使用其中的帮助程序。 Rouge 使用“highlight”类添加了自己的包装器，而另一个 div 似乎混淆了它。

试试下面的帮助代码。顺便说一句，我将代码从 ApplicationHelper到一个单独的 RougeHelper (但这不是必需的更改):

module RougeHelper
  require 'redcarpet'
  require 'rouge'
  require 'rouge/plugins/redcarpet'

  class HTML < Redcarpet::Render::HTML
    include Rouge::Plugins::Redcarpet
  end

  def rouge_markdown(text)
    render_options = {
        filter_html: true,
        hard_wrap: true,
        link_attributes: { rel: 'nofollow' }
    }
    renderer = HTML.new(render_options)

    extensions = {
        autolink: true,
        fenced_code_blocks: true,
        lax_spacing: true,
        no_intra_emphasis: true,
        strikethrough: true,
        superscript: true
    }
    markdown = Redcarpet::Markdown.new(renderer, extensions)
    markdown.render(text)
  end
end

然后，在模板中，我尝试突出显示测试 ruby​​ 代码:

<%= raw rouge_markdown(<<-'EOF'
```ruby
def rouge_me
  puts "this is a #{'test'} for rouge"
end
```
EOF
) %>

请注意，我需要手动指定语言，这使我使用 3 个反引号来分隔代码而不是空格缩进。我不知道为什么代码语言自动检测在这里不起作用，也许它的代码太短了。

最后，这很好地为我呈现了颜色: