File: commonmarker.rb

package info (click to toggle)
ruby-commonmarker 0.23.10-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,456 kB
  • sloc: ansic: 10,575; ruby: 1,741; sh: 36; makefile: 22
file content (45 lines) | stat: -rwxr-xr-x 1,610 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
#!/usr/bin/env ruby
# frozen_string_literal: true

require "commonmarker/commonmarker"
require "commonmarker/config"
require "commonmarker/node"
require "commonmarker/renderer"
require "commonmarker/renderer/html_renderer"
require "commonmarker/version"

begin
  require "awesome_print"
rescue LoadError; end # rubocop:disable Lint/SuppressedException
module CommonMarker
  class << self
    # 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 render_html(text, options = :DEFAULT, extensions = [])
      raise TypeError, "text must be a String; got a #{text.class}!" unless text.is_a?(String)

      opts = Config.process_options(options, :render)
      Node.markdown_to_html(text.encode("UTF-8"), opts, extensions)
    end

    # 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 `document` node.
    def render_doc(text, options = :DEFAULT, extensions = [])
      raise TypeError, "text must be a String; got a #{text.class}!" unless text.is_a?(String)

      opts = Config.process_options(options, :parse)
      text = text.encode("UTF-8")
      Node.parse_document(text, text.bytesize, opts, extensions)
    end
end
end