Module: GfmToBlockkit

Defined in:
lib/gfm_to_blockkit.rb,
lib/gfm_to_blockkit/version.rb,
lib/gfm_to_blockkit/converter.rb,
lib/gfm_to_blockkit/text_splitter.rb,
lib/gfm_to_blockkit/converters/base.rb,
lib/gfm_to_blockkit/converters/list.rb,
lib/gfm_to_blockkit/converters/image.rb,
lib/gfm_to_blockkit/converters/table.rb,
lib/gfm_to_blockkit/renderers/mrkdwn.rb,
lib/gfm_to_blockkit/converters/heading.rb,
lib/gfm_to_blockkit/renderers/rich_text.rb,
lib/gfm_to_blockkit/converters/paragraph.rb,
lib/gfm_to_blockkit/converters/code_block.rb,
lib/gfm_to_blockkit/converters/html_block.rb,
lib/gfm_to_blockkit/converters/block_quote.rb,
lib/gfm_to_blockkit/converters/table/native.rb,
lib/gfm_to_blockkit/converters/thematic_break.rb,
lib/gfm_to_blockkit/converters/table/preformatted.rb,
lib/gfm_to_blockkit/converters/footnote_definition.rb

Defined Under Namespace

Modules: Converters, Renderers Classes: Context, Converter, TextSplitter

Constant Summary collapse

VERSION = 
"0.0.1"

Class Method Summary collapse

Class Method Details

.convert(markdown, table_format: :preformatted) ⇒ Array<Hash>

Convert a GitHub-Flavored Markdown string to Slack Block Kit blocks.

Parameters:

  • markdown (String) —

    GFM content

  • table_format (:preformatted, :native) (defaults to: :preformatted) —

    Table rendering strategy

Returns:

  • (Array<Hash>) —

    Block Kit blocks with symbol keys



29
30
31
 
# File 'lib/gfm_to_blockkit.rb', line 29

def self.convert(markdown, table_format: :preformatted)
  Converter.new(markdown, table_format: table_format).call
end