Do not mention or emojify in a codeblock

[parkr]

If the @mention or :emoji: is in a code block, do not transform it. This applies to the HTML, rather than to a Markdown, codeblock.

Related issues:

• emoji shouldn't be compiled in code block jekyll/jemoji#12
• Shouldn't mention in code block. jekyll/jekyll-mentions#7

Thanks!

[jch]

Could you provide a code snippet to reproduce this? See the contributing guide for details.

[parkr]

Input

:metal:
`:metal:`

Output

Expected

The :metal: does not change inside <code> or <pre>.

[parkr]

@jch Here's the code snippet:

require 'html/pipeline'

#
# Emoji
#

content = <<-MD
:metal:
`:metal:`
MD
puts HTML::Pipeline::EmojiFilter.new(nil, {
  asset_root: "https://assets.github.com/images/icons/"
}).emoji_image_filter(content)

#
# Mentions
#

content = <<-MD
@jch
`@jch`
MD
puts HTML::Pipeline::MentionFilter.new(nil, {
  base_url: "https://github.com"
}).mention_link_filter(content)

[simeonwillbanks]

@parkr the MentionFilter has IGNORE_PARENTS which filters @mentions from code blocks.

The EmojiFilter has something similar, but it doesn't use a constant.

First, we should convert the Markdown to HTML. Second, we can use the #call interface and pipeline the HTML through the EmojiFilter and MentionFilter.

By sending messages to #emoji_image_filter and #mention_link_filter, we're circumventing the next logic (skip conversion within code block).

Emoji Example Implementation

content = <<-MD
:metal:
`:metal:`
MD
puts HTML::Pipeline.new([HTML::Pipeline::MarkdownFilter,HTML::Pipeline::EmojiFilter], {
  asset_root: "https://assets.github.com/images/icons/"
}).call(content)[:output].to_s

Emoji Example Output

:metal:

Mentions Example Implementation

content = <<-MD
@jch
`@jch`
MD
puts HTML::Pipeline.new([HTML::Pipeline::MarkdownFilter,HTML::Pipeline::MentionFilter], {
  base_url: "https://github.com"
}).call(content)[:output].to_s

Mentions Example Output

@jch
@jch

Hope this helps! 😄

[Jastrzebowski]

@parkr any news about this?

[parkr]

The problem is that the Emoji filter runs before the markdown is rendered.

[simeonwillbanks]

@parkr In Jekyll, can you send HTML fragments to the Emoji filter?

As mentioned by @jch, "this (Emoji) filter is designed to run on HTML fragments, so we should assume that tags is a reasonable input to work with."

[parkr]

@simeonwillbanks We'll have to convert it into a Converter, rather than a Generator.

[simeonwillbanks]

OK, cool. I'll close this issue.