mweiss / elm-rte-toolkit / RichText.Definitions

Markdown spec

markdown : RichText.Config.Spec.Spec

A spec which is compatible with the CommonMark flavor of markdown.

Definitions

The definitions used in the markdown specification.

Elements

doc : RichText.Config.ElementDefinition.ElementDefinition

The root element of a document.

blockquote : RichText.Config.ElementDefinition.ElementDefinition

A blockquote element. It can have block children.

codeBlock : RichText.Config.ElementDefinition.ElementDefinition

A code block element.

hardBreak : RichText.Config.ElementDefinition.ElementDefinition

Hard break is an inline leaf which represents a line break in a document.

heading : RichText.Config.ElementDefinition.ElementDefinition

A heading element. It can have inline children. It supports one integer attribute level, which defaults to 1 if not set.

horizontalRule : RichText.Config.ElementDefinition.ElementDefinition

A horizontal rule element. It is a block leaf, e.g. it can have no children.

image : RichText.Config.ElementDefinition.ElementDefinition

An inline image. It can have three different string attributes:

paragraph : RichText.Config.ElementDefinition.ElementDefinition

A paragraph element. It can have inline children.

listItem : RichText.Config.ElementDefinition.ElementDefinition

A list item element definition. It can have block children.

orderedList : RichText.Config.ElementDefinition.ElementDefinition

An ordered list element definition. It can have list item children.

unorderedList : RichText.Config.ElementDefinition.ElementDefinition

An unordered list element definition. It can have list item children.

Marks

bold : RichText.Config.MarkDefinition.MarkDefinition

A bold mark definition.

code : RichText.Config.MarkDefinition.MarkDefinition

A code mark definition.

italic : RichText.Config.MarkDefinition.MarkDefinition

An italic mark definition.

link : RichText.Config.MarkDefinition.MarkDefinition

A link mark definition. It can have two different string attributes: