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,
  strikethrough: true,
  space_after_headers: false,
  tables: true,
  lax_spacing: true,
}.freeze

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.has_math ⇒ Object

Returns the value of attribute has_math.



8
9
10
 
# File 'lib/jazzy/jazzy_markdown.rb', line 8

def has_math
  @has_math
end

Class Method Details



211
212
213
214
215
216
 
# File 'lib/jazzy/jazzy_markdown.rb', line 211

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

.markdown ⇒ Object 



186
187
188
 
# File 'lib/jazzy/jazzy_markdown.rb', line 186

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

.render(markdown_text, default_language = nil) ⇒ Object 



190
191
192
193
194
 
# File 'lib/jazzy/jazzy_markdown.rb', line 190

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 



218
219
220
 
# File 'lib/jazzy/jazzy_markdown.rb', line 218

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

.rendered_parameters ⇒ Object 



200
201
202
 
# File 'lib/jazzy/jazzy_markdown.rb', line 200

def self.rendered_parameters
  renderer.parameters
end

.rendered_returns ⇒ Object 



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

def self.rendered_returns
  renderer.returns
end

.renderer ⇒ Object 



182
183
184
 
# File 'lib/jazzy/jazzy_markdown.rb', line 182

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