laika-core/laika.markdown/InlineParsers

InlineParsers

object InlineParsers

Provides all inline parsers for Markdown text except for those dealing with verbatim HTML markup which this library treats as an optional feature that has to be explicitly mixed in.

Inline parsers deal with markup within a block of text, such as a link or emphasized text. They are used in the second phase of parsing, after the block parsers have cut the document into a (potentially nested) block structure.

class Object
trait Matchable
class Any

Type members

Types

type RecParser = String => List[Span]

Value members

Concrete methods

def em(char: Char)(implicit recParsers: RecursiveSpanParsers): PrefixedParser[Emphasized]

Parses a span of emphasized text enclosed by one occurrence of the specified character.

Parses a span of emphasized text enclosed by one occurrence of the specified character.

def enclosedByDoubleChar(c: Char)(implicit recParsers: RecursiveSpanParsers): PrefixedParser[List[Span]]

Parses a span enclosed by two consecutive occurrences of the specified character. Recursively parses nested spans, too.

Parses a span enclosed by two consecutive occurrences of the specified character. Recursively parses nested spans, too.

def enclosedBySingleChar(c: Char)(implicit recParsers: RecursiveSpanParsers): PrefixedParser[List[Span]]

Parses a span enclosed by a single occurrence of the specified character. Recursively parses nested spans, too.

Parses a span enclosed by a single occurrence of the specified character. Recursively parses nested spans, too.

def span(start: PrefixedParser[Any], end: PrefixedParser[String])(implicit recParsers: RecursiveSpanParsers): PrefixedParser[List[Span]]

Creates a parser for an inline span based on the specified parsers that represent the start and end condition.

Creates a parser for an inline span based on the specified parsers that represent the start and end condition.

Value parameters:
end

the end delimiter of the span

start

the parser that parses the beginning of the span, result will be discarded

def strong(char: Char)(implicit recParsers: RecursiveSpanParsers): PrefixedParser[Strong]

Parses a span of strong text enclosed by two consecutive occurrences of the specified character.

Parses a span of strong text enclosed by two consecutive occurrences of the specified character.

Concrete fields

val enclosedByAsterisk: SpanParserBuilder

Parses either strong spans enclosed in double asterisks or emphasized spans enclosed in single asterisks.

Parses either strong spans enclosed in double asterisks or emphasized spans enclosed in single asterisks.

val enclosedByUnderscore: SpanParserBuilder

Parses either strong spans enclosed in double underscores or emphasized spans enclosed in single underscores.

Parses either strong spans enclosed in double underscores or emphasized spans enclosed in single underscores.

val escapedChar: Parser[String]

Parses a single escaped character, only recognizing the characters the Markdown syntax document specifies as escapable. The | has been added to that list to support escaping in tables in the GitHub Flavor syntax.

Parses a single escaped character, only recognizing the characters the Markdown syntax document specifies as escapable. The | has been added to that list to support escaping in tables in the GitHub Flavor syntax.

Note: escaping > is not mandated by the official syntax description, but by the official test suite.

val image: SpanParserBuilder

Parses an inline image. Recognizes both, an inline image ![text](url) and an image reference ![text][id].

Parses an inline image. Recognizes both, an inline image ![text](url) and an image reference ![text][id].

val lineBreak: SpanParserBuilder

Parses an explicit hard line break.

Parses an explicit hard line break.

val literalSpan: SpanParserBuilder

Parses a literal span enclosed by one or more backticks. Does neither parse nested spans nor Markdown escapes.

Parses a literal span enclosed by one or more backticks. Does neither parse nested spans nor Markdown escapes.