CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

GFMDataProcessor (markdown-gfm)

@ckeditor/ckeditor5-markdown-gfm/src/gfmdataprocessor

class
See source

This data processor implementation uses GitHub Flavored Markdown as input/output data.

See the Markdown output guide to learn more on how to enable it.

Filtering

Properties

  • _htmlDP : HtmlDataProcessor

    private

    HTML data processor used to process HTML produced by the Markdown-to-HTML converter and the other way.

    See source

Methods

  • constructor( document )

    Creates a new instance of the Markdown data processor class.

    See source

    Parameters

    document : Document

  • toData( viewFragment ) → String

    Converts the provided DocumentFragment to data format — in this case to a Markdown string.

    See source

    Parameters

    viewFragment : DocumentFragment

    Returns

    String

    Markdown string.

  • toView( data ) → DocumentFragment

    Converts the provided Markdown string to view tree.

    See source

    Parameters

    data : String

    A Markdown string.

    Returns

    DocumentFragment

    The converted view element.