Class: Coradoc::Markdown::Serializer::Strategies::Admonition::GfmAlert

Inherits:
Base
  • Object
show all
Defined in:
lib/coradoc/markdown/serializer/strategies/admonition/gfm_alert.rb

Overview

GFM Alerts (native since Dec 2023): ‘> [!TYPE]n> content`. Recognized types: NOTE, TIP, IMPORTANT, WARNING, CAUTION. Source: docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts

Class Method Summary collapse

Methods inherited from Base

mode_name

Class Method Details

.render(admonition, _ctx) ⇒ Object 



15
16
17
18
19
20
21
 
# File 'lib/coradoc/markdown/serializer/strategies/admonition/gfm_alert.rb', line 15

def render(admonition, _ctx)
  type = admonition.admonition_type.to_s.capitalize
  body = admonition.content.to_s
  body = body.lines.map { |line| "> #{line}".rstrip }.join("\n")
  title_suffix = admonition.title ? " \"#{admonition.title}\"" : ''
  "> [!#{type}]#{title_suffix}\n#{body}"
end