Module: Jazzy::Markdown

Defined in:
lib/jazzy/jazzy_markdown.rb

Defined Under Namespace

Classes: JazzyCopyright, JazzyDeclarationHTML, JazzyHTML

Constant Summary collapse

REDCARPET_OPTIONS = 
{
  autolink: true,
  fenced_code_blocks: true,
  no_intra_emphasis: true,
  quote: true,
  strikethrough: true,
  space_after_headers: false,
  tables: true,
  lax_spacing: true,
}.freeze

Class Method Summary collapse

Class Method Details



195
196
197
198
199
200
 
# File 'lib/jazzy/jazzy_markdown.rb', line 195

def self.copyright_markdown
  @copyright_markdown ||= Redcarpet::Markdown.new(
    JazzyCopyright,
    REDCARPET_OPTIONS,
  )
end

.markdown ⇒ Object 



170
171
172
 
# File 'lib/jazzy/jazzy_markdown.rb', line 170

def self.markdown
  @markdown ||= Redcarpet::Markdown.new(renderer, REDCARPET_OPTIONS)
end

.render(markdown_text, default_language = nil) ⇒ Object 



174
175
176
177
178
 
# File 'lib/jazzy/jazzy_markdown.rb', line 174

def self.render(markdown_text, default_language = nil)
  renderer.reset
  renderer.default_language = default_language
  markdown.render(markdown_text)
end

.render_copyright(markdown_text) ⇒ Object 



202
203
204
 
# File 'lib/jazzy/jazzy_markdown.rb', line 202

def self.render_copyright(markdown_text)
  copyright_markdown.render(markdown_text)
end

.rendered_parameters ⇒ Object 



184
185
186
 
# File 'lib/jazzy/jazzy_markdown.rb', line 184

def self.rendered_parameters
  renderer.parameters
end

.rendered_returns ⇒ Object 



180
181
182
 
# File 'lib/jazzy/jazzy_markdown.rb', line 180

def self.rendered_returns
  renderer.returns
end

.renderer ⇒ Object 



166
167
168
 
# File 'lib/jazzy/jazzy_markdown.rb', line 166

def self.renderer
  @renderer ||= JazzyDeclarationHTML.new
end