带有Rouge和KaTeX的Jekyll不能在代码中包含$

时间:2018-12-25 18:57:36

标签: jekyll katex rouge

我正在创建一个新的Jekyll博客设置,我希望在该博客中进行自我托管并生成服务器端所有可能的内容(因此基本上是除Disqus和Google Analytics(分析)之外的所有内容)。我希望我的网站即使在关闭JS的浏览器上也能正常运行,这就是为什么我选择Kramdown + Rouge进行语法突出显示,而选择KaTex进行网站生成过程中的TeX公式扩展。

但是我发现了一个问题。当我有这样的例子时:

```bash
$ echo test
test
```

它将在KaTeX命令中中断:

{% katexmm %}
{{ content }}
{% endkatexmm %}

我找出了原因:

  • 胭脂将代​​码段变成类似<span class="gp">$</span>
  • katexmm表示每个$与另一个$配对或转义为\$

我想知道的是如何解决此问题,例如通过将$中的所有pre转义,而其他$(打算用作实际的LaTeX代码段)保持原样。还是以某种方式将jekyll-katex配置为忽略未配对的$? (throw_error: false选项在文本已经使用美元符号进行匹配之后才起作用,因此没有帮助。)

我想通过配置或应用katexmm来解决此问题,这样我就不必修改任何帖子的内容。

1 个答案:

答案 0 :(得分:1)

我设法通过将jekyll-katex中的tag修改为code(内联,使用单波浪号)和pre code(使用缩进或3个波浪号):

# frozen_string_literal: true

require 'jekyll'
require 'jekyll-katex/configuration'
require 'jekyll-katex/katex_js'
require 'nokogiri'

module Jekyll
  module Tags
    # Defines the custom Liquid tag for compile-time rendering of KaTeX math.
    # This differs from the katex tag in that it allows use of `$` and `$$` fencing to mark math mode blocks similar to
    # standard latex.
    #   {% katexmm %}
    #   This is a mixed environment where you can write text as normal but fence off latex math using `$`. Escape
    #   using `\$`. For example.
    #   $latex math with \$$
    #   $$display mode latex$$
    #   {% endkatexmm %}
    class KatexMathModeFixed < Liquid::Block
      LOG_TOPIC = 'KatexMathModeFixed:'
      KATEX ||= Jekyll::Katex::KATEX_JS
      LATEX_TOKEN_PATTERN = /(?<!\\)([$]{2}|[$]{1})(.+?)(?<!\\)\1/m

      def initialize(tag_name, markup, tokens)
        super
        @markup = markup
        @tokens = tokens
        @display_mode_rendering = Jekyll::Katex::Configuration.global_rendering_options.merge(displayMode: true)
        @inline_mode_rendering = Jekyll::Katex::Configuration.global_rendering_options.merge(displayMode: false)
      end

      def render(context)
        enclosed_block = super
        fixed_block = fix_code(enclosed_block)
        rendered_str = fixed_block.to_s.gsub(LATEX_TOKEN_PATTERN) do |match|
          display_mode = match.to_s.start_with? '$$'
          rendering_options = display_mode ? @display_mode_rendering : @inline_mode_rendering
          Jekyll.logger.debug LOG_TOPIC, "Rendering matched block - #{match}"
          KATEX.call('katex.renderToString', Regexp.last_match(2), rendering_options)
        end
        # KaTeX should fix escaped `$` within fenced blocks, this addresses instances outside of math mode
        rendered_str.to_s.gsub(/\\[$]/, '$').to_s
      end

      def fix_code(input)
        updated = false
        html = Nokogiri::HTML.fragment(input)
        Jekyll.logger.debug LOG_TOPIC, "Fixing - #{input}"
        html.css("code, code span").each do |c|
          if c.css('*').empty? && c.content['$']
            updated = true
            Jekyll.logger.debug LOG_TOPIC, "current tag - #{c}"
            content = c.content
            content['$'] = '\$'
            c.content = content
            Jekyll.logger.debug LOG_TOPIC, "current tag now - #{c}/#{content}"
          end
        end
        output = html.to_s
        Jekyll.logger.debug LOG_TOPIC, "Fixed - #{output}"
        if updated then html.to_s else input end
      end
    end
  end
end

Liquid::Template.register_tag('katexmmx', Jekyll::Tags::KatexMathModeFixed)

它可安装在_plugins目录中。

问题是,这仍然是错误的-默认情况下,kramdown仍尝试使用mathjax引擎并生成<script type="math/tex">,因此必须进行更改。在研究方式时,我发现kramdown也支持math_engine: katex-我只需要添加字体和CSS,jekyll-katex就完全过时了(以及我的解决方法,我如果有人好奇的话,会离开这里。