Contents

require "github/markup/implementation"

module GitHub
  module Markup
    class Markdown < Implementation
      MARKDOWN_GEMS = {
        "commonmarker" => proc { |content, options: {}|
          commonmarker_opts = [:GITHUB_PRE_LANG].concat(options.fetch(:commonmarker_opts, []))
          commonmarker_exts = options.fetch(:commonmarker_exts, [:tagfilter, :autolink, :table, :strikethrough])
          CommonMarker.render_html(content, commonmarker_opts, commonmarker_exts)
        },
        "github/markdown" => proc { |content, options: {}|
          GitHub::Markdown.render(content)
        },
        "redcarpet" => proc { |content, options: {}|
          Redcarpet::Markdown.new(Redcarpet::Render::HTML).render(content)
        },
        "rdiscount" => proc { |content, options: {}|
          RDiscount.new(content).to_html
        },
        "maruku" => proc { |content, options: {}|
          Maruku.new(content).to_html
        },
        "kramdown" => proc { |content, options: {}|
          Kramdown::Document.new(content).to_html
        },
        "bluecloth" => proc { |content, options: {}|
          BlueCloth.new(content).to_html
        },
      }

      def initialize
        super(
          /md|mkdn?|mdwn|mdown|markdown|mdx|litcoffee/i,
          ["Markdown", "MDX", "Literate CoffeeScript"])
      end

      def load
        return if @renderer
        MARKDOWN_GEMS.each do |gem_name, renderer|
          if try_require(gem_name)
            @renderer = renderer
            return
          end
        end
        raise LoadError, "no suitable markdown gem found"
      end

      def render(filename, content, options: {})
        load
        @renderer.call(content, options: options)
      end

      def name
        "markdown"
      end

    private
      def try_require(file)
        require file
        true
      rescue LoadError
        false
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 2 rubygems

Version	Path
blacklight-spotlight-3.6.0.beta8	vendor/bundle/ruby/3.2.0/gems/github-markup-5.0.1/lib/github/markup/markdown.rb
github-markup-5.0.1	lib/github/markup/markdown.rb
github-markup-5.0.0	lib/github/markup/markdown.rb
github-markup-4.0.2	lib/github/markup/markdown.rb