Package-level declarations

Types

Link copied to clipboard

Recognizes an inline fragment of code. The opening and closing runs must have the same length, and neither may be extended by a further backtick, which is what lets a longer run wrap a shorter one.

Link copied to clipboard

Recognizes a single character that the rendering stage must treat specially. It is the last recognizer of every inline lexer.

Link copied to clipboard

Recognizes a delimiter run of asterisks, underscores or tildes. It claims the whole run without deciding anything: pairing needs the rest of the line, so it happens in the inline scanner's second pass, and a run that pairs with nothing ends up as plain text.

Link copied to clipboard

Recognizes a URL or an email address wrapped in angle brackets.

Link copied to clipboard

Recognizes a character entity. The hexadecimal marker accepts either case, and the closing semicolon is optional.

Link copied to clipboard

Recognizes a backslash followed by an ASCII punctuation character.

Link copied to clipboard

Recognizes an image: a !, an optional size in parentheses, a link, and an optional cross-reference identifier.

Link copied to clipboard

Recognizes a comment anywhere in a line. It shares its scanner with the block comment recognizer.

Link copied to clipboard

Recognizes a line break that is not at the end of a paragraph. A break preceded by two or more spaces or by a backslash is hard; any other is soft. A newline followed only by whitespace up to a line end is not a break at all, so the padding newline never is one.

Link copied to clipboard

Recognizes a link with its label in brackets and its destination in parentheses.

Link copied to clipboard

Recognizes a footnote reference, optionally carrying its whole definition.

Link copied to clipboard

Recognizes an image whose destination lives in a link definition.

Link copied to clipboard

Recognizes a link whose destination lives in a link definition. The second bracket pair and the reference inside it are both optional, so the tail always parses and the label therefore ends at its first unescaped closing bracket.

Link copied to clipboard

Recognizes a bare URL or email address. The scheme prefixes are matched case insensitively.

Functions

Link copied to clipboard

The inline recognizers of the base Markdown flavor, highest priority first.