Contents

#!/usr/bin/env ruby
# frozen_string_literal: true

# Released under the MIT License.
# Copyright, 2014, by John MacFarlane.
# Copyright, 2015-2019, by Garen Torikian.
# Copyright, 2015, by Nick Wellnhofer.
# Copyright, 2016-2017, by Yuki Izumi.
# Copyright, 2020-2023, by Samuel Williams.

require 'markly/markly'

require_relative 'markly/flags'
require_relative 'markly/node'
require_relative 'markly/renderer/html'

require_relative 'markly/version'

module Markly
	# Public: Parses a Markdown string into a `document` node.
	#
	# string - {String} to be parsed
	# option - A {Symbol} or {Array of Symbol}s indicating the parse options
	# extensions - An {Array of Symbol}s indicating the extensions to use
	#
	# Returns the `parser` node.
	def self.parse(text, flags: DEFAULT, extensions: nil)
		parser = Parser.new(flags)
		
		extensions&.each do |extension|
			parser.enable(extension)
		end
		
		return parser.parse(text.encode(Encoding::UTF_8))
	end
	
	# Public:  Parses a Markdown string into an HTML string.
	#
	# text - A {String} of text
	# option - Either a {Symbol} or {Array of Symbol}s indicating the render options
	# extensions - An {Array of Symbol}s indicating the extensions to use
	#
	# Returns a {String} of converted HTML.
	def self.render_html(text, flags: DEFAULT, parse_flags: flags, render_flags: flags, extensions: [])
		root = self.parse(text, flags: parse_flags, extensions: extensions)
		
		return root.to_html(flags: render_flags, extensions: extensions)
	end
end

Version data entries

8 entries across 8 versions & 1 rubygems

Version	Path
markly-0.12.1	lib/markly.rb
markly-0.12.0	lib/markly.rb
markly-0.11.0	lib/markly.rb
markly-0.10.0	lib/markly.rb
markly-0.9.1	lib/markly.rb
markly-0.9.0	lib/markly.rb
markly-0.8.1	lib/markly.rb
markly-0.8.0	lib/markly.rb