Markdown/com.darkrockstudios.texteditor.markdown/MarkdownExtension

MarkdownExtension

class MarkdownExtension(val editorState: TextEditorState, initialConfiguration: MarkdownConfiguration = MarkdownConfiguration.DEFAULT, var imageProvider: ImageProvider? = null)(source)

Reads and writes the document as markdown: the entry point for using the editor as a markdown editor. The styles the document is rendered and recognised with are the state's richTextStyles; markdownConfiguration holds the syntax choices. The block toggles and queries live on the state (toggleBulletList, headerLevel, setLink and the rest, in com.darkrockstudios.texteditor.state); the members here forward to them for one release.

Constructors

MarkdownExtension

constructor(editorState: TextEditorState, initialConfiguration: MarkdownConfiguration = MarkdownConfiguration.DEFAULT, imageProvider: ImageProvider? = null)

Properties

editorState

val editorState: TextEditorState

imageProvider

var imageProvider: ImageProvider?

markdownConfiguration

var markdownConfiguration: MarkdownConfiguration

The syntax choices export writes in and import reads by default.

markdownStyles

val ~~markdownStyles~~: MarkdownStyles

The styles under their old names; read TextEditorState.richTextStyles.

Functions

codeFenceLanguage

fun ~~codeFenceLanguage~~(line: Int): String?

exportAsMarkdown

fun exportAsMarkdown(): String

Serializes the document to markdown.

headerLevel

fun ~~headerLevel~~(line: Int): Int?

importMarkdown

fun importMarkdown(markdownText: String, paragraphSeparator: ParagraphSeparator = markdownConfiguration.paragraphSeparator)

Replaces the document with markdownText. paragraphSeparator says how the text's blank lines are read (see ParagraphSeparator); it defaults to the configuration's, and a host opening a file written under the other rule passes that rule here.

isBlockquote