• Tagged template based Markdown-to-entities parser function

    Additionally, md function has two static methods:

    • md.escape - escape a string to be safely used in Markdown (should not be needed in most cases, as md function itself handles all strings passed to it automatically as plain text)
    • md.unparse - add Markdown formatting to the text given the plain text and entities contained in it

    Parameters

    Returns TextWithEntities

    const text = md`**${user.displayName}**`
    
  • A variant taking a plain JS string as input and parsing it.

    Useful for cases when you already have a string (e.g. from some server) and want to parse it.

    Parameters

    • string: string

    Returns TextWithEntities

    const string = '**hello**'
    const text = md(string)

Properties

Properties

escape: (str: string) => string

Type declaration

    • (str: string): string
    • Escape a string to be safely used in Markdown.

      Note: this function is in most cases not needed, as md function handles all strings passed to it automatically as plain text.

      Parameters

      • str: string

      Returns string

unparse: (input: InputText) => string

Type declaration

    • (input: InputText): string
    • Add Markdown formatting to the text given the plain text and entities contained in it.

      Parameters

      Returns string