Class: Confluence::MarkdownConverter

Inherits:
Object
  • Object
show all
Defined in:
lib/confluence/markdown_converter.rb

Overview

By default, all documentation should be written in a normal Markdown format. Later, when we're generating/uploading final documentation, we'll use Confluence::MarkdownConverter to convert normal Markdown into Confluence specific Markdown https://confluence.atlassian.com/bitbucketserver/markdown-syntax-guide-776639995.html

Constant Summary collapse

CONVERTERS = 
%w[
  convert_h1
  convert_h2
  convert_h3
  convert_h4
  convert_h5
  convert_bold
  convert_italic
  convert_code
  convert_unordered_list
].freeze

Instance Method Summary collapse

Instance Method Details

#convert(original_markdown) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/confluence/markdown_converter.rb', line 24

def convert(original_markdown)
  return if original_markdown.nil?

  output = original_markdown

  CONVERTERS.each do |converter_method|
    output = send(converter_method, output)
  end

  output
end