Module roosterjs-content-model-markdown

Index

Classes

MarkdownPastePlugin

Interfaces

Functions

Functions

convertContentModelToMarkdown

convertContentModelToMarkdown(model: ContentModelDocument, newLine?: MarkdownLineBreaks): string

- Defined in roosterjs-content-model-markdown/lib/modelToMarkdown/convertContentModelToMarkdown.ts:11
Export content model document to markdown

Parameters
- model: ContentModelDocument
- Optional newLine: MarkdownLineBreaks
  
  The new line string to use. Default is '\n\n'
Returns string

The markdown string

convertMarkdownToContentModel

convertMarkdownToContentModel(text: string, splitLinesPattern?: string): ContentModelDocument
convertMarkdownToContentModel(text: string, options?: MarkdownToModelOptions): ContentModelDocument

- Defined in roosterjs-content-model-markdown/lib/markdownToModel/convertMarkdownToContentModel.ts:11
Convert the whole content to ContentModel with the given plain text

Parameters
- text: string
  
  The markdown text
- Optional splitLinesPattern: string
  
  The pattern to split lines. Default is /\r\n|\r|\n|\n/
Returns ContentModelDocument

The ContentModelDocument
- Defined in roosterjs-content-model-markdown/lib/markdownToModel/convertMarkdownToContentModel.ts:22
Convert the whole content to ContentModel with the given plain text

Parameters
- text: string
  
  The markdown text
- Optional options: MarkdownToModelOptions
  
  The markdown options
Returns ContentModelDocument

The ContentModelDocument

isContentMarkdown

isContentMarkdown(text: string): boolean

- Defined in roosterjs-content-model-markdown/lib/publicApi/isContentMarkdown.ts:27
Detect whether the given plain text contains any markdown markup. Recognizes block-level patterns (headings, blockquotes, lists, horizontal rules, tables) and inline patterns (bold, italic, strikethrough, links, images).

Parameters
- text: string
  
  The plain text to check.
Returns boolean

True if the text contains any markdown markup, false otherwise.

isPastedContentMarkdown

isPastedContentMarkdown(editor: IEditor, clipboardData: ClipboardData): boolean

- Defined in roosterjs-content-model-markdown/lib/publicApi/isPastedContentMarkdown.ts:16
Detect whether the given clipboard content can be interpreted as markdown.

Parameters
- editor: IEditor
  
  The editor instance.
- clipboardData: ClipboardData
  
  The clipboard data to check.
Returns boolean

True if the content can be interpreted as markdown, false otherwise.

Generated using TypeDoc