class

Luce::Document

Inherits Reference < Object

Maintains the context needed to parse a Markdown document

Constructors

new(block_syntaxes : Array(BlockSyntax) | Nil, inline_syntaxes : Array(InlineSyntax) | Nil, extension_set : ExtensionSet | Nil, link_resolver : Resolver | Nil = nil, image_link_resolver : Resolver | Nil = nil, encode_html : Bool = true, with_default_block_syntaxes : Bool = true, with_default_inline_syntaxes : Bool = true)

Instance methods

block_syntaxes
encode_html

DEPRECATED Use #encode_html? instead. Will be removed in version 1.0.

encode_html?
footnote_labels

Footnotes label by appearing order.

They are case-sensitive and added by ref syntax.

footnote_references

Footnote ref count, keys are case-sensitive and added by define syntax.

has_custom_inline_syntaxes

DEPRECATED Use #has_custom_inline_syntaxes? instead. Will be removed in version 1.0

has_custom_inline_syntaxes?
inline_syntaxes
link_references
parse(text : String) : Array(Node)

Parses the given text to a series of AST nodes.

parse_inline(text : String) : Array(Node)

Parses the given inline Markdown text to a series of AST nodes.

parse_line_list(lines : Array(Line)) : Array(Node)

Parses the given lines of Line to a series of AST nodes.

parse_lines(lines : Array(String)) : Array(Node)

Parses the given lines of Markdown to a series of AST nodes.

with_default_block_syntaxes

Whether to use default block syntaxes

with_default_block_syntaxes?

Whether to use default block syntaxes

with_default_inline_syntaxes

Whether to use default inline syntaxes.

Need to set both with_default_block_syntaxes? and encode_html? to false to disable all inline syntaxes including HTML encoding syntaxes.

with_default_inline_syntaxes?

Whether to use default inline syntaxes.

Need to set both #with_default_block_syntaxes? and #encode_html? to false to disable all inline syntaxes including HTML encoding syntaxes.