Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MarkdownPlugin

Markdown plugin handles markdown formatting, such as transforming * characters into bold text.

Hierarchy

  • MarkdownPlugin

Implements

Index

Constructors

Methods

Constructors

constructor

  • Parameters

    • options: MarkdownOptions = ...

      An optional parameter that takes in an object of type MarkdownOptions, which includes the following properties:

      • strikethrough: If true text between ~ will receive strikethrough format. Defaults to false.
      • bold: If true text between * will receive bold format. Defaults to false.
      • italic: If true text between _ will receive italic format. Defaults to false.
      • codeFormat: If provided, text between ` will receive code format. Defaults to undefined.

    Returns MarkdownPlugin

Methods

dispose

  • dispose(): void

  • The last method that editor will call to a plugin before it is disposed. Plugin can take this chance to clear the reference to editor. After this method is called, plugin should not call to any editor method since it will result in error.

    Returns void

getName

  • getName(): string

initialize

  • initialize(editor: IEditor): void

  • The first method that editor will call to a plugin when editor is initializing. It will pass in the editor instance, plugin should take this chance to save the editor reference so that it can call to any editor method or format API later.

    Parameters

    • editor: IEditor

      The editor object

    Returns void

onPluginEvent

Generated using TypeDoc