markdown/parsek.markdown.ast/Inline

Inline

sealed interface Inline

A node in the inline content of a CommonMark document.

Inline nodes appear inside block-level containers such as Block.Paragraph and Block.Heading. The sealed hierarchy mirrors the inline node types defined in the CommonMark 0.31.2 specification.

Inheritors

Types

Autolink

data class Autolink(val url: String) : Inline

A URI or email address enclosed in angle brackets.

CodeSpan

data class CodeSpan(val literal: String) : Inline

An inline code span delimited by backtick runs.

Emphasis

data class Emphasis(val children: List<Inline>) : Inline

Emphasis (*text* or _text_).

ExtendedAutolink

data class ExtendedAutolink(val url: String) : Inline

A bare URL or email address recognised without angle brackets (GFM extended autolink).

HardBreak

data object HardBreak : Inline

A hard line break (two or more trailing spaces, or a backslash, before a newline inside a paragraph).

HtmlEntity

data class HtmlEntity(val literal: String) : Inline

An HTML character entity reference (e.g. &, *, *).

Image

data class Image(val destination: String, val title: String?, val alt: String, val children: List<Inline> = emptyList()) : Inline

An inline image.

Link

data class Link(val destination: String, val title: String?, val children: List<Inline>) : Inline

An inline link.

RawHtml

data class RawHtml(val literal: String) : Inline

A raw HTML tag or construct appearing inline.

SoftBreak

data object SoftBreak : Inline

A soft line break (a plain newline inside a paragraph).

Strikethrough

data class Strikethrough(val children: List<Inline>) : Inline

Strikethrough text (~~text~~).

StrongEmphasis

data class StrongEmphasis(val children: List<Inline>) : Inline

Strong emphasis (**text** or __text__).

Text

data class Text(val literal: String) : Inline

A run of literal text.