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

  • private

    _htmlDP : HtmlDataProcessor

    See source

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

Methods

  • constructor( document )

    See source

    Creates a new instance of the Markdown data processor class.

    Parameters

    document : Document

  • keepHtml( element ) → void

    See source

    Keeps the specified element in the output as HTML. This is useful if the editor contains features producing HTML that is not a part of the Markdown standard.

    By default, all HTML tags are removed.

    Parameters

    element : keyof HTMLElementTagNameMap

    The element name to be kept.

    Returns

    void

  • registerRawContentMatcher( pattern ) → void

    See source

    Registers a MatcherPattern for view elements whose content should be treated as raw data and not processed during the conversion from Markdown to view elements.

    The raw data can be later accessed by a custom property of a view element called "$rawContent".

    Parameters

    pattern : MatcherPattern

    The pattern matching all view elements whose content should be treated as raw data.

    Returns

    void

  • toData( viewFragment ) → string

    See source

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

    Parameters

    viewFragment : DocumentFragment

    Returns

    string

    Markdown string.

  • toView( data ) → DocumentFragment

    See source

    Converts the provided Markdown string to a view tree.

    Parameters

    data : string

    A Markdown string.

    Returns

    DocumentFragment

    The converted view element.

  • useFillerType() → void

    See source

    This method does not have any effect on the data processor result. It exists for compatibility with the DataProcessor interface.

    Returns

    void